README.md

RuboCop Capybara

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

Installation

Just install the rubocop-capybara gem

gem install rubocop-capybara

or if you use bundler put this in your Gemfile

gem 'rubocop-capybara', require: false

Usage

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

RuboCop configuration file

Put this into your .rubocop.yml.

require: rubocop-capybara

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

require:
  - rubocop-other-extension
  - rubocop-capybara

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

Command line

rubocop --require rubocop-capybara

Rake task

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

Documentation

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

The Cops

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

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

Capybara/SpecificMatcher:
  Exclude:
    - spec/my_spec.rb

Contributing

Checkout the contribution guidelines.

License

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