【Rails】Rubocopの導入

目的

Railsで作成したアプリにRubocopを導入する。

開発環境

macOS: Big Sur
Rubyバージョン: 2.6.5
Railsバージョン: 6.0.0

前提

• アプリが作成されている。
  【Rails】簡単な投稿アプリの作成

手順

1. はじめに
2. Rubocopの導入
3. Rubocop設定ファイルの作成
4. Rubocopの設定
5. Rubocopの実行

はじめに

今回はRubocopの導入を行っていきます。
RubocopとはRubyの静的コード解析ツールのことです。
「インデントが揃っていない」「余分な改行・スペースがある」などの指摘を行ってくれるため、コードの品質を保つことができます。

Rubocopの導入

それでは早速始めていきます!

まずGemをインストールします。

Gemfile

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

ターミナル

% bundle install

これでインストールできました!

Rubocop設定ファイルの作成

次にRubocopの設定を記述するファイルを作成します。

ターミナル

% touch .rubocop.yml

Rubocopの設定

続いてRubocopの設定を行っていきます。

.rubocop.yml

AllCops:
# 除外するディレクトリ（自動生成されたファイル）
# デフォルト設定にある"vendor/**/*"が無効化されないように記述
 Exclude:
   - "vendor/**/*" # rubocop config/default.yml
   - "db/**/*"
   - "config/**/*"
   - "bin/*"
   - "node_modules/**/*"
   - "Gemfile"


# 1行あたりの文字数をチェックする
Layout/LineLength:
 Max: 130
# 下記ファイルはチェックの対象から外す
 Exclude:
   - "Rakefile"
   - "spec/rails_helper.rb"
   - "spec/spec_helper.rb"

# RSpecは1つのブロックあたりの行数が多くなるため、チェックの除外から外す
# ブロック内の行数をチェックする
Metrics/BlockLength:
 Exclude:
   - "spec/**/*"

# Assignment: 変数への代入
# Branch: メソッド呼び出し
# Condition: 条件文
# 上記項目をRubocopが計算して基準値を超えると警告を出す（上記頭文字をとって'Abc'）
Metrics/AbcSize:
 Max: 50

# メソッドの中身が複雑になっていないか、Rubocopが計算して基準値を超えると警告を出す
Metrics/PerceivedComplexity:
 Max: 8

# 循環的複雑度が高すぎないかをチェック（ifやforなどを1メソッド内で使いすぎている）
Metrics/CyclomaticComplexity:
 Max: 10

# メソッドの行数が多すぎないかをチェック
Metrics/MethodLength:
 Max: 30

# ネストが深すぎないかをチェック（if文のネストもチェック）
Metrics/BlockNesting:
 Max: 5

# クラスの行数をチェック（無効）
Metrics/ClassLength:
 Enabled: false

# 空メソッドの場合に、1行のスタイルにしない　NG例：def style1; end
Style/EmptyMethod:
 EnforcedStyle: expanded

# クラス内にクラスが定義されていないかチェック（無効）
Style/ClassAndModuleChildren:
 Enabled: false

# 日本語でのコメントを許可
Style/AsciiComments:
 Enabled: false

# クラスやモジュール定義前に、それらの説明書きがあるかをチェック（無効）
Style/Documentation:
 Enabled: false

# ％i（）構文を使用していないシンボルで構成される配列リテラルをチェック（無効）
Style/SymbolArray:
 Enabled: false

# 文字列に値が代入されて変わっていないかチェック（無効）
Style/FrozenStringLiteralComment:
 Enabled: false

# メソッドパラメータ名の最小文字数を設定
Naming/MethodParameterName:
 MinNameLength: 1

以上で設定が完了しました。

Rubocopの実行

Rubocopを実行するには、下記コマンドを打ちます!

ターミナル

% bundle exec rubocop

また下記コマンドでは、チェック内容を自動で修正させることもできます。

ターミナル

% bundle exec rubocop -a

最後に

以上でRubocopの導入は完了です。
では。