Skip to content

jessieay/rubocop-rspec

This branch is 412 commits behind rubocop/rubocop-rspec:refs/heads/master.

Folders and files

NameName
Last commit message
Last commit date
Jan 3, 2024
Jan 4, 2024
Jan 4, 2024
Jan 4, 2024
Jan 4, 2024
May 6, 2023
Aug 26, 2022
Oct 24, 2022
Jan 13, 2017
Dec 29, 2022
Jul 10, 2022
Dec 12, 2023
Oct 23, 2022
Jul 20, 2023
Nov 9, 2020
Nov 24, 2021
Jan 4, 2024
Oct 21, 2022
Jul 7, 2023
Jul 7, 2023
Oct 21, 2022
May 7, 2023
Dec 23, 2022
Jan 3, 2024

Repository files navigation

RuboCop RSpec

Join the chat at https://gitter.im/rubocop-rspec/Lobby Gem Version CI

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

Installation

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

Upgrading to RuboCop RSpec v2.x

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

Usage

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

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/FilePath:
  Exclude:
    - spec/my_poorly_named_spec_file.rb

Contributing

Checkout the contribution guidelines.

License

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

About

Code style checking for RSpec files

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%