こんにちは、Nanayakuです。
今回は、rubocopと言うGemを使用してコードをキレイに整える方法を紹介します。
「【Rails】Rubocopを使ってコーディング規約に準拠させる方法 | vdeep」を参考にしました。
インストール
developmentに「rubocop」を追記し、bundle installします。
1 2 3 4 5 |
group :development do gem 'rubocop', require: false end |
設定
インストールすれば、そのまま実行することができます。
しかし、デフォルトの状態だと、自分が書いていないコードにも警告を出してしまいます。
そのため、コーディング規約や範囲を定めたファイルをプロジェクト直下に「.rubocop.yml」ファイルを作成します。
「【Rails】Rubocopを使ってコーディング規約に準拠させる方法 | vdeep」を参考に、自分は以下のように設定しました。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 |
Rails: Enabled: true AllCops: TargetRubyVersion: 2.6.3 Exclude: - vendor/bundle/**/* - bin/* - db/**/* - config/**/* - Gemfile - lib/**/* - log/* - jobs/* - channels/**/* Style/FrozenStringLiteralComment: Enabled: false Style/Documentation: Enabled: false Metrics/LineLength: Enabled: false Style/ClassAndModuleChildren: Enabled: false |
実行
下記のコマンドで、コーディング規約に合わない箇所を教えてくれます。
1 |
$ rubocop |
通常なら問題の場所を1つ1つ手作業で直していきますが、「-a」とオプションをつけるとrubocopが自動で直してくれます。
1 |
$ rubocop -a |
実行すると画像のように直してくれます。
参考サイト
【Rails】Rubocopを使ってコーディング規約に準拠させる方法 | vdeep
最後に
備忘録がわりに作ったので、間違っている所とかあったら、コメントくれると嬉しいです。