Skip to content

Latest commit

 

History

History
42 lines (31 loc) · 1.27 KB

README.md

File metadata and controls

42 lines (31 loc) · 1.27 KB
Raw

dryer-lint

Aptible's baseline Rubocop configuration.

Usage

This is meant to be inherited from via a remote URL, as described here.

For example, if you have a non-Rails app, your Rubocop configuration should look something like this:

inherit_from:
  - https://raw.githubusercontent.com/aptible/dryer-lint/main/.rubocop.base.yml

AllCops:
  TargetRubyVersion: 3.1
  NewCops: enable
  Include:
    - !ruby/regexp /\.rb$/
    - !ruby/regexp /Gemfile$/
    - !ruby/regexp /\.gemspec$/
    - !ruby/regexp /\.rake$/
    - !ruby/regexp /Rakefile$/

If you are using Rails, the only change to the above is that you should also include the Rails configuration in the inherit_from (AllCops stays the same as above):

inherit_from:
  - https://raw.githubusercontent.com/aptible/dryer-lint/main/.rubocop.base.yml
  - https://raw.githubusercontent.com/aptible/dryer-lint/main/.rubocop.rails.yml

Testing

A Docker Compose configuration is included to make testing locally easier. To test, run docker compose build --pull --no-cache && docker compose run rubocop.

The GitHub Action for this repository mimics this behavior.