Skip to content

franzliedke/rubocop-rspec

Repository files navigation

RuboCop RSpec

Gem Version Dependency Status Build Status Coverage Status Code Climate

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'

Usage

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

RuboCop configuration file

Put this into you .rubocop.yml.

require: rubocop-rspec

Now you can run rubocop and it will automaticly 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

The Cops

All cops are located under lib/rubocop/cop/spec, 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

License

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

About

Code style checking for RSpec files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%