Skip to content

84codes/rubocop-eighty-four-codes

Repository files navigation

Rubocop::EightyFourCodes

This is a collection of cops developed and used by 84codes AB

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add rubocop-eightyfourcodes --require=false

If bundler is not being used to manage dependencies, install the gem by executing:

gem install rubocop-eightyfourcodes

Usage

You need to tell RuboCop to load the eightyfourcodes extension. There are three ways to do this:

RuboCop configuration file

Put this into your .rubocop.yml.

require: rubocop-eightyfourcodes

Now you can run rubocop and it will automatically load the RuboCop eightyfourcodes cops together with the standard cops.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Use bundle exec rake 'new_cop[EightyFourCodes/CommandLiteralInjection]' to generate a new cop.

The NodePattern Debugger is a very helpful resource when creating new AST matchers.

Releasing

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in version.rb, in a commit or pull request.

Create and push a new git tag:

git tag -m "Version <VERSION>" v<VERSION>
git push --tags

This will trigger GitHub Actions to build and push the gem to RubyGems.org.

If the release workflow fails, you can re-run it by deleting the tag and pushing it again.

git push --delete origin v<VERSION>

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/84codes/rubocop-eightyfourcodes.

License

The gem is available as open source under the terms of the MIT License.