blacklane/rubocop

This is the generic Ruby style guide that we use in most Ruby projects at Blacklane, both public and internal.

It helps us keep our code style consistent while not being too intrusive.

Usage

The recommended version of Rubocop to use is 0.55 or higher.

Inside your project, add the .rubocop.yml file containing:

inherit_from:
  - https://raw.githubusercontent.com/blacklane/rubocop/master/rubocop.yml

Any project-specific exceptions to the defaults can be appended after this.

When running rubocop, the remote configuration file will be cached locally as .rubocop-https--raw-github.... That's why you should make sure to gitignore the file:

# .gitignore

.rubocop-http*

Cache

If you see style errors in CI that you can't reproduce locally, that's probably because of the cached .rubocop-https--raw-github... file. You'll need to remove it, ideally whenever the rubocop.yml file inside this repository changes.

Versioning

When the time comes, we might want to maintain different versions of this configuration file - most probably with branches or tags. But ideally we should try and keep one version for all our projects.

Contribution

• Keep the rules and their settings sorted alphabetically.
• Make a PR.
• Discuss.
• 

Other

• The list of available cops
• Pronto: A gem for running Rubocop only on the git changes