Ruby, Rails, Git再入門 コーディングスタイルチェック(RuboCop)を導入する方法

photo credit: cszar via photopin cc

RuboCopとは?

RuboCopはコーディングスタイルのチェックを行ってくれるツール。チェックは数多くのRubyのプロジェクトで採用されているThe Ruby Style Guideと照らし合わせて、それに違反するコードを指摘してくれる。チェック項目は多岐に渡り、かなり網羅的なものだ。

RuboCop

インストールは以下のコマンドを実行するだけで良い。

$ gem install rubocop

またはGemfileに下記を記載する。

gem 'rubocop', require: false

使い方は以下のコマンドを実行するだけで良い。

$ rubocop

実行すると、チェック後、チェック結果を標準出力してくれるので、それを確認すれば良い。ちなみにRuby on Rails チュートリアル:実例を使って Rails を学ぼうのソースを対象に実行したところ、400個オーバーの指摘をされた…。

チェック分類

チェック分類は以下の通り。

  • レイアウト
  • 構文
  • 命名規則
  • コメント
  • 注釈
  • クラス
  • 例外
  • Collections
  • 文字列
  • 正規表現
  • パーセントリテラル
  • メタプログラミング

参考資料