Tbpgr Blog

元エンジニア 人事 tbpgr(てぃーびー) のブログ

Rubocop | 現在出力されているエラーを課題として保存し、暫定的に設定無効にする方法

概要

現在出力されているエラーを課題として保存し、暫定的に設定無効にする方法

詳細

現在出力されているエラーを課題として保存し、暫定的に設定無効にする方法について。

導入初期など、あまりに多くの警告がでていると即対応するのが難しいものです。
そんな際に、現状出ている警告をtodoファイルとして残しつついま出ている種類の警告が
発生しないように設定をします。

まず、下記コマンドを実行します。

rubocop --auto-gen-config

すると、現在出ている警告がrubocop-todo.ymlファイルに出力されます。

続いて、.rubocop.ymlに傾向内容をinheritします

inherit_from: rubocop-todo.yml

これで警告が発生しなくなりました。
あとは、少しずつrubocop-todo.ymlを解消したらその項目をtodoから削除していきます。
すべての警告への対応が終わったらtodoファイルを削除して.rubocop.ymlのincludeも除去します。