Railsプロジェクトに途中からRuboCopを導入し始める
🛕

Railsプロジェクトに途中からRuboCopを導入し始める

Created
Apr 28, 2022 04:15 PM
Tags
Ruby on Rails

概要

掲題の通り。RuboCop が入っていない Rails プロジェクトに RubCop を入れてリファクタリングしていく時のTIPS。

config

基本的に自分達でコーディングルールを作ろうとしない。まずは↓あたりを使う。

Metrics

Metrics の設定を入れ、これに違反しているメソッドを優先的に直していくと良い。
  • Metrics/AbcSize: 35 くらいがちょうどいい
  • Metrics/CyclomaticComplexity: 9 くらいがちょうどいい

指摘の直し方

rubocop -A を使って自動で直す。
自動で修正できない場合は、rubocop:disable コメントで指摘を無効化していく。不用意に .rubocop.yml で無効化しない。コメントで指摘を無効化した箇所を後で直していく。

CIで継続的にチェック

rubocop:disable などで全コードから指摘がなくなったら、CI で rubocop を実行し、指摘があれば落とすようにする。