まずは auto-gen で既存のコードを正とする
既存プロジェクトに Rubocop を導入する際に考えられるのが、歴史あるコードに対して rubocop を実行すると offenses が大量に出て来るため導入ハードルが高く断念する、というケースです。そんなときは --auto-gen-config
オプションを利用すると作業の取っ掛かりとなります。
rubocop --auto-gen-config
を実行すると、現時点でコーディング規約違反となった "Cops" をすべて許可する.rubocop_todo.yml
が生成されます。
これを .rubocop.yml
から inherit_from
で参照することで反映されます。
以上の操作で「とりあえず現状動いているコードを正とする」ことができたので、あとは着手しやすい項目から .rubocop_todo.yml
をひとつひとつ Enabled: true
に変えていき、コーディング規約に準拠させていくことになります。
以上
Rubocop の紹介は以上です。ここまでの例では毎回 rubocop
コマンドを実行していましたが、お気に入りのエディタと連携する設定を行えば、書いているそばから規約への準拠を促してくれて、とても楽に開発ができます。詳しくは Editor Integration - bbatsov/rubocop を参照してください。