Rubocopとはなんぞや。
まあ、端的に言えば「汚いコードを指摘してくれる」gem。ruby限定ですけど。
ポートフォリオを作っている時、ふわふわと「最後の仕上げに入れればいっか」なんてふざけたことを考えていました。完成した今だから言う。
バカかお前は!!!!!
普段わたしはコーディングする際、めちゃくちゃ綺麗に書くことを意識して書いています。もうほぼ完成って段になってRubocopを通すとあら不思議!クソコードが大量に発見されました!ボコボコにされて泣きながら書き直しましたよ、ええ。
とにかくRubocopは、コードを書いた都度調整するのに最適だと思っています。
やり方は以下。
gem 'rubocop', require: false
bundle installでインストールして完了。
$rubocop
これでrubyの規定に沿わないものが出てきます。
しかしこれだけではrailsアプリ内のファイル全てが対象になります。泣きます。
なので対象を絞ります。
アプリ直下(Gemfileなどと同じ場所)に
「.rubocop.yml」
このファイルを作ります。
ここでは対象から除外するファイル・ディレクトリの指定だったり、無視するエラーの指定だったりのカスタマイズをします。
AllCops:
TargetRubyVersion: 2.5
Exclude: #対象除外するファイル
- bin/*
- config/*
- db/**/*
- lib/*
- public/*
- strange/*
- test/**/*
- tmp/*
- vender/*
- spec/**/*
#無視するエラー
Style/Documentation:
Enabled: false
Style/FrozenStringLiteralComment:
Enabled: false
エラーの種類に関しては数が多いので都度ググってほしい。
まあ、「動けばいい」って点で言えばここで怒られようが気にしなくていいんですけどね。
ちなみに
$rubocop -a
これでチェックしながらある程度のコードを勝手に綺麗にしてくれます。あら素敵。
誰にも文句言われないようなコード書きたいなら使う価値あり。