RuboCop RSpec

RSpec-specific analysis for your projects, as an extension to RuboCop.

• Installation
  • Upgrading to RuboCop RSpec v3.x
  • Upgrading to RuboCop RSpec v2.x
• Usage
• Documentation
• The Cops
• Contributing
• License

Just install the rubocop-rspec gem

gem install rubocop-rspec

or if you use bundler put this in your Gemfile

gem 'rubocop-rspec', require: false

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

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

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

Put this into your .rubocop.yml.

plugins: rubocop-rspec

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

plugins:
  - rubocop-other-extension
  - rubocop-rspec

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

rubocop --plugin rubocop-rspec

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

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

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

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

Checkout the contribution guidelines.

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