RuboCop

規約違反と不具合の兆候をファイル単位で示す

プロジェクトのルートで rubocop を実行すると、対象のRubyファイルを再帰的に検査し、行・列・重要度・規則名と説明を報告します。スタイルの統一に加え、Lint規則で疑わしいコードも探せます。

出典：[1]

設定と修正方法を段階的に選べる

.rubocop.yml で規則を調整でき、安全と判定された修正だけを適用する -a と、安全性を保証しない修正も含む -A を使い分けられます。v1.91.0では変更ファイルだけを調べる --changed と、書き換えずに差分を確認する --diff も追加されました。

組み込みのLSPサーバーを対応エディターから利用すれば、編集時に指摘を確認できます。Rails・RSpec・Performance向けの規則は本体から分離されているため、必要な拡張gemを別に導入します。

出典：[1][2]

既存のRubyプロジェクトへ品質基準を少しずつ導入する

個人の確認からCIの品質判定まで同じ規則を共有したいチームに向きます。違反が多い既存コードでは、変更箇所だけを検査するか、TODO設定を生成して新しい変更から基準を適用すると段階的に導入できます。

出典：[1][2]

Ruby版、設定互換性、自動修正の差分を確認する

v1.91.0の実行環境はMRI 2.7以降またはJRuby 9.4以降で、解析対象はRuby 2.0以降です。規則や設定は小さな版の間で安定させる方針ですが、更新時は設定変更と新しい規則を確認し、Gemfileで版を管理してください。

-A は安全性を保証しない修正も適用します。実行前に版管理へ作業内容を保存し、適用後の差分とテスト結果を確認する必要があります。ソフトウェア本体はMIT Licenseですが、ロゴには別のライセンスが案内されています。

出典：[1][3][4]