Set up Rubocop

Created: June 01, 2019 11:30 | Updated: June 10, 2019 15:00
Tags: Rails 5, Ruby

Rubocop is great! Checks your Ruby code for style issues and will even format your code. This is my quick setup on a new project.

Install Rubocop

gem install rubocop rubocop-performance rubocop-rails

# you can add rubocop-rspec to this list as well if applicable

Create your config file in the root of your project directory

touch .rubocop.yml

And enter some sane Rails-friendly settings to override the defaults :)

require:
  - rubocop-performance
  - rubocop-rails
AllCops:
  Exclude:
    - 'db/**/*'
    - 'config/**/*'
    - 'script/**/*'
    - 'bin/{rails,rake}'
Style/FrozenStringLiteralComment: { Enabled: false }
Style/MutableConstant: { Enabled: false }

# ------------I use this only for personal projects------------------
Metrics/LineLength: {AutoCorrect: true, Max: 80}

# ------And this only when playing in other kid's sand pits----------
Metrics/LineLength: {AutoCorrect: false, Max: 120}
Style/SymbolArray: { Enabled: false }
Style/WordArray: { Enabled: false }
Style/RescueStandardError: { Enabled: false }
Style/IfUnlessModifier: { Enabled: false }
Style/BracesAroundHashParameters: { Enabled: false }
Style/ParenthesesAroundCondition: { Enabled: false }
Style/RedundantParentheses: { Enabled: false }
Style/TernaryParentheses: { Enabled: false }

You can now install your editors extensions or format ALL the things with rubocop -a

Written by Alan Vardy. Let me know how I can make this better!