RuboCop Stamped

RuboCop configuration for use on Stamped open source and internal Ruby projects.

Installation

Gemfile

group :development, :test do
  gem "rubocop-stamped", require: false
  gem "rubocop-rails", require: false # Optional
end

.rubocop.yml

inherit_gem:
  rubocop-stamped:
    - config/default.yml
    - config/rails.yml # Optional

Usage

Generate a RuboCop configuration:

rubocop --auto-gen-config

See:

• https://rubocop.readthedocs.io/en/latest/configuration/#automatically-generated-configuration

Automatically correct offenses:

rubocop --auto-correct
rubocop --safe-auto-correct

See:

• https://rubocop.readthedocs.io/en/latest/auto_correct/

Style

We mostly rely on standard for default styles, but we're also taking inspiration from these styleguides:

• @bbatsov
• GitHub
• Thoughtbot
• Shopify
• Flexport
• @bbatsov Rails
• GitHub Rails

All the choices below are specific to Stamped:

Layout

• Limit lines to 120 characters (Shopify)
• Use spaces around operators, after commas, colons and semicolons, around { and before } (Shopify)

Style

• Usage of trailing comma in multi-line collection literals is encouraged. It makes diffs smaller and more meaningful. (Shopify)

# not encouraged
{
  foo: :bar,
  baz: :toto
}

# encouraged
{
  foo: :bar,
  baz: :toto,
}

What's included

Default

inherit_gem:
  rubocop-stamped:
    - config/default.yml

Includes cops for:

• Style
• Performance
• RSpec
• Markdown

Rails

inherit_gem:
  rubocop-stamped:
    - config/rails.yml

Includes cops for:

• Rails

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/stampedai/rubocop-stamped. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

MIT