Rubocop::Rspec::Extra

A RuboCop extension focused on enforcing RSpec. A place where no one is officially employed, but where useful cops can gather.

Installation

Just install the rubocop-rspec-extra gem

gem install rubocop-rspec-extra

or if you use bundler put this in your Gemfile

gem 'rubocop-rspec-extra', require: false

Usage

You need to tell RuboCop to load the RSpec Extra extension. There are two ways to do this:

RuboCop configuration file

Put this into your .rubocop.yml.

plugins: rubocop-rspec-extra

Alternatively, use the following array notation when specifying multiple extensions.

plugins:
  - rubocop-rspec
  - rubocop-rspec-extra

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

Note

The plugin system is supported in RuboCop 1.72+. In earlier versions, use require instead of plugins.

Command line

rubocop --plugins rubocop-rspec-extra

Rake task

RuboCop::RakeTask.new do |task|
  task.plugins << 'rubocop-rspec-extra'
end

The Cops

All cops are located under lib/rubocop/cop/rspec/extra, and contain examples/documentation.

In your .rubocop.yml, you may treat the RSpec extra cops just like any other cop. For example:

RSpec/Extra/RestrictBlockTag:
  Exclude:
    - spec/my_poorly_named_spec_file.rb

Contributing

Checkout the contribution guidelines.

License

rubocop-rspec-extra is MIT licensed. See the accompanying file for the full text.