Rubocop Rspec

Upgrading to RuboCop RSpec v3.x

Read all the details in our Upgrade to Version 3.x document.

Upgrading to RuboCop RSpec v2.x

Read all the details in our Upgrade to Version 2.x document.

RuboCop configuration file

Put this into your .rubocop.yml.

require: rubocop-rspec

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

require:
  - rubocop-other-extension
  - rubocop-rspec

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

Command line

rubocop --require rubocop-rspec

Rake task

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

Code Climate

rubocop-rspec is available on Code Climate as part of the rubocop engine. Learn More.

Documentation

You can read more about RuboCop RSpec in its official manual.

The Cops

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

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

RSpec/SpecFilePathFormat:
  Exclude:
    - spec/my_poorly_named_spec_file.rb