, ,

[Ruby] Rubocop の .rubocop_todo.yml を自動生成してジックリ指摘に対応する方法

公開日: 2016/10/20
更新日: 2018/10/10

指摘が多くて分かりづらいときの対処。

Setup

RubyGem を作る場合のセットアップ作業をメモしておく。
プロジェクトディレクトリの .gemspec ファイルに rubocop を追加する。

foo.gemspec
  spec.add_development_dependency 'rubocop', '~> 0.42.0'

bundle install を実行する。

ファイルの生成

ここが本題。
rubocop --auto-gen-config を実行すると .rubocop_todo.yml が生成される。
これを（ルールファイルである） .rubocop.yml にリネームすると、rubocop 実行時に指摘が表示されなくなる。

% rubocop --auto-gen-config
    :
Created .rubocop_todo.yml.
Run `rubocop --config .rubocop_todo.yml`, or add `inherit_from: .rubocop_todo.yml` in a .rubocop.yml file.
% mv .rubocop_todo.yml .rubocop.yml

後はファイルの内容を確認しながら、修正をしていく。

補遺