🛗

Rubocop個人的まとめ

公開日約1年前2025-10-21
MarkdownRaw Content

Memo

  • rubocop-rails-omakase はかなりの量の Cop が無効化されている

コマンド

Terminal
bundle exec rubocop

コマンドのオプション

オプション説明
-a, --auto-correct自動修正を実行する
-A, --auto-correct-all危険な修正も含めてすべて自動修正する
-f, --format 出力フォーマッタを指定
--auto-gen-config現在の違反を基に .rubocop_todo.yml を生成する
--only <COP1,COP2,...>指定した Cop のみ実行する
--except <COP1,COP2,...>指定した Cop を除外して実行する
--parallel複数プロセスで並列実行して高速化する
--config 指定した設定ファイルを使用する
--display-cop-names違反メッセージに Cop 名を表示する
--show-cops Cop の詳細を表示する
--require 追加のライブラリ/プラグインを読み込む
--fail-level 指定した重大度以上の違反で終了ステータスを失敗にする

違反を一時的に無効化・除外する .rubocop_todo.yml

.rubocop_todo.yml は、現在のコードベースで検出された RuboCop の違反(Cop)を一時的に無効化・除外するために --auto-gen-config オプションで自動生成される設定ファイル。

Terminal
bundle exec rubocop --auto-gen-config

おすすめプラグイン

  1. Gemfile 定義後に bundle install
  2. .rubocop.yml に設定を追加
Gemfile
group :development do
  # ...
  gem 'rubocop-rails', require: false
  gem 'rubocop-performance', require: false
  gem 'rubocop-rubycw', require: false
  gem 'rubocop-rspec', require: false
  # ...
end
.rubocop.yml
# ...
plugins:
  - rubocop-rails
  - rubocop-performance
  - rubocop-rspec
  - rubocop-rubycw
# ...
AllCops:
  TargetRailsVersion: 8.0

ブックマーク

Railsにrubocopを導入する rubocop-rails-omakaseから始めるrubocop Rubocopという便利な監視人 たまってしまった .rubocop_todo.yml をGitHub Actionsで継続的かつ自動的に倒す方法 - STORES Product Blog