Rubocopまとめ

Rubocopとは

Rubyのコーディングチェックツールです。
Rubocopを使うことで、誰でも一定の品質のコードを書くことができます。
一部のルールについては、自動修正にも対応しているため自分で修正する手間も省くことができます。
またRubocopではCopという単位でルールを管理しています。

導入方法

rubocopはgemのため、インストールします。

group :development do
  gem 'rubocop', require: false
  gem 'rubocop-rails', require: false
end

ここでrubocopはアプリ側で呼び出す必要がないため、require: falseをつけています。

ファイル

.rubocop.yml

Rubocopの設定ファイルです。
ここで、修正するcopを設定することができます。

.rubocop_todo.yml

ここに今すぐ修正できないcopを退避させて置くことで、警告が出ないようになります。
(以下のコマンドのおかげ)

.rubocop.yml

inherit_from: .rubocop_todo.yml

--auto-gen-configをつけることでcopを退避させることができます。
修正できたら消していって、徐々に解消できるようにしましょう。

使い方

カレントディレクトリの全てのRubyファイルをチェックする場合

$ rubocop

特定のファイルをチェックする場合

$ rubocop hoge.rb

自動修正して欲しい時

$ rubocop -a

参考

Rubocop公式(https://docs.rubocop.org/rubocop/1.23/index.html)