A RuboCop plugin that ports Reek's code smell detectors as RuboCop cops.

Reek has a number of long-standing limitations around configuration, file processing, and tooling integration. This gem addresses them by leveraging RuboCop's mature infrastructure — battle-tested configuration, todo generation, node pattern matching, and IDE/editor support — rather than maintaining duplicate tooling. See troessner/reek#1512 for the original discussion.

Add to your application's Gemfile:

gem "rubocop-reek", require: false

Or install directly:

gem install rubocop-reek

Because this gem registers itself as a RuboCop plugin via lint_roller, RuboCop will auto-load it when it is present in your bundle. No explicit require or plugins: entry in .rubocop.yml is needed.

Once installed, the Reek/ department of cops is available. Cops can be configured in .rubocop.yml like any other RuboCop cop:

Reek/SomeCopName:
  Enabled: true

After checking out the repo, run bin/setup to install dependencies.

Run the full test suite and linter:

bundle exec rake

Run only the tests:

bundle exec rake spec

In addition to hand-written specs, spec/reek_specs_spec.rb runs Reek's original smell detector specs against all implemented cops. These are fetched from GitHub on first run and cached in tmp/reek_specs/ (gitignored). Delete that directory to force a refresh.

Generate a new cop scaffold:

bundle exec rake new_cop[Reek/CopName]

This writes the cop source file, spec, registers it in lib/rubocop/cop/reek_cops.rb, and adds an entry to config/default.yml.

You can also run bin/console for an interactive prompt to experiment with the gem.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in lib/rubocop/reek/version.rb, then run bundle exec rake release.

Bug reports and pull requests are welcome on GitHub at https://github.com/andyw8/rubocop-reek.

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