RuboCop
先日、前から気になっていた、RuboCopを導入してみました！
RuboCopはどんなものか、どんなメリットがあるのか、基本的な使い方についてよく分かっていなかったのでまとめてみました！
RuboCopとは
RuboCopとは、Ruby向けの静的解析ツールです。
コードがコーディング規約通りに書かれているか調べてくれます。
Ruby style guideに基づいて解析してくれます。
.rubocop.ymlファイルを編集して、コーディング規約をカスタマイズすることもできます。
RuboCopを使用するメリット
プロジェクトのコーディング規約を明文化し、共有することができます。
また、レビューする人にとっても、レビューされる人にとっても、細かい指摘が減ることによって余計なストレスを減らすことができます。
基本的な使い方
gem 'rubocop' とgemファイルに記載し、bundle install します。
development だけにインストールすることが多いようです。
インストール後は、以下のコマンドでRuboCopを実行します。
rubocop [options] [file1, file2, ...]
すると、結果がターミナルに出力されます。
Convention・Warning・Error・Fatail の四段階で注意がなされます。
オプションやファイル名を指定しない場合は、全てのファイルをRuby style guideに基づいてチェックしてくれます。
結果は以下の画像のように出力されます。
オプション
- l オプション
間違いである可能性が高い部分についてのみ指摘してくれるオプションです。
- R オプション
Railsの規約に即して指摘してくれるオプションです。
