Rubocopによるコードレビュー

概要

Rubocopを使用してコードのスタイリングをチェックします。

作業

導入

Gemfile

group :development do
  gem 'web-console', '>= 3.3.0'
  gem 'listen', '~> 3.0.5'
  gem 'spring'
  gem 'spring-watcher-listen', '~> 2.0.0'
  gem 'rubocop', require: false #ここを追加
end

ターミナル

$ bundle

設定

.rubocop.ymlを作成

AllCops:
  Exclude:
    - bin/*
    - db/schema.rb
    - node_modules/**/*
    - db/migrate/*
    - vendor/**/*
  Rails:
    enabled: true

Style/Documentation:
  Enabled: false

Style/StringLiterals:
  Enabled: false

Metrics/LineLength:
  Enabled: false

Style/FrozenStringLiteralComment:
  Enabled: false

実行

ターミナル

$ bundle exec robocop
$ bundle exec rubocop --auto-gen-config

修正

ターミナル

$ bundle exec rubocop -a # Cop supports --auto-correct.があれば実行可能

具体的な修正内容は以下を参照 github.com

所感

コードレビューツールを使うことによって、コーディングのクセのようなものを修正、コードを統一することで読みやすくすることができると思います。また、逆に可読性を下げるようなものもあったため、自動修正後には変更点を確認した方が良いと思いました。次回、設定するときには、可読性を下げるような項目の除外を検討すると良いかもしれないと思いました。