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おすすめプラグイン
- Gemfile 定義後に
bundle install .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を導入する
zenn.dev

rubocop-rails-omakaseから始めるrubocop
zenn.dev

Rubocopという便利な監視人
zenn.dev

たまってしまった .rubocop_todo.yml をGitHub Actionsで継続的かつ自動的に倒す方法 - STORES Product Blog
こんにちは。heyのCTOをやっている藤村です。 実はCTOになる前はSTORESのRailsのコードを改善する仕事をしていました。その頃に、たまってしまっている.rubocop_todo.ymlをなんとか手間をかけずに消化していきたいな〜と思い、少しづつ自動的に消化する仕組みを作りました。この記事ではその仕組みをご紹介します。 rubocop_todo.yml とは 既存のコードベースに対してRuboCopを適用すると大量の違反箇所が出てしまい使い物にならないという問題があります。それの解決策として、既存のコードで違反しているファイルを無視する設定を .rubocop_todo.yml とい…
product.st.inc