Repository files navigation

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

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

Just install therubocop-rspec gem

gem install rubocop-rspec

or if you use bundler put this in yourGemfile

gem'rubocop-rspec',require:false

Read all the details in ourUpgrade to Version 3.x document.

Read all the details in ourUpgrade to Version 2.x document.

You need to tell RuboCop to load the RSpec extension. There are threeways 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 runrubocop and it will automatically load the RuboCop RSpeccops together with the standard cops.

rubocop --plugin rubocop-rspec

RuboCop::RakeTask.newdo |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 itsofficial manual.

All cops are located underlib/rubocop/cop/rspec, and containexamples/documentation.

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

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

Checkout thecontribution guidelines.

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