rubocop

RuboCopは、あなたのプロジェクトのrubyコードが「コーディング規約どおりに書かれているか」をチェックする静的コード解析ツールです。

設定ファイル(.rubocop.yml)を編集することにより、自分自身でコーディング規約を追加したり削除することができます。

rubocopのインストール

gemfileに下記を追加して、$ bundle installする。

group :development do
  …
  gem 'rubocop', require: false
  gem 'rubocop-rails'
end

インストール後は、下記コマンドで実行する。

$ bundle exec rubocop

$ touch .rubocop.yml

.rubocop.ymlという設定ファイル作成すると、 RuboCopはこれを自動的に読み取ります。以下、.rubocop.yml内における、代表的な書き方を説明します。

RuboCopの対象から除外したい場合は、Exclude:を利用します。

今回はrailsが自動的に生成するファイル(db/schema.rb)や、vendor/bundle以下に配置されるgemなどをRuboCopの対象から除外することにしました。

db/schema.rbの様に記載すると、デフォルトで設定されているExcludeが無効化されてしまう為、'db/**/*'の様に記載しています。

AllCops:
  Exclude:
    - 'db/**/*'
    - 'vendor/**/*'
    - 'bin/**/*'
    - 'spec/**/*'
    - 'node_modules/**/*'