https://github.com/rubocop/rubocop-capybara

Code style checking for Capybara files.
https://github.com/rubocop/rubocop-capybara

capybara lint rubocop ruby static-analysis testing

Last synced: 1 day ago
JSON representation

Code style checking for Capybara files.

• Host: GitHub
• URL: https://github.com/rubocop/rubocop-capybara
• Owner: rubocop
• License: mit
• Created: 2022-12-16T10:15:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T11:28:41.000Z (22 days ago)
• Last Synced: 2024-10-29T12:58:43.044Z (10 days ago)
• Topics: capybara, lint, rubocop, ruby, static-analysis, testing
• Language: Ruby
• Homepage: https://docs.rubocop.org/rubocop-capybara
• Size: 992 KB
• Stars: 42
• Watchers: 5
• Forks: 8
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: MIT-LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# RuboCop Capybara

[![Join the chat at https://gitter.im/rubocop-rspec/Lobby](https://badges.gitter.im/rubocop-rspec/Lobby.svg)](https://gitter.im/rubocop-rspec/Lobby)

[![Gem Version](https://badge.fury.io/rb/rubocop-capybara.svg)](https://rubygems.org/gems/rubocop-capybara)

![CI](https://github.com/rubocop/rubocop-capybara/workflows/CI/badge.svg)

[Capybara](https://teamcapybara.github.io/capybara)-specific analysis for your projects, as an extension to

[RuboCop](https://github.com/rubocop/rubocop).

## Installation

Just install the `rubocop-capybara` gem

```bash

gem install rubocop-capybara

```

or if you use bundler put this in your `Gemfile`

```ruby

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`.

```yaml

require: rubocop-capybara

```

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

```yaml

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

```bash

rubocop --require rubocop-capybara

```

### Rake task

```ruby

RuboCop::RakeTask.new do |task|

  task.requires << 'rubocop-capybara'

end

```

## Documentation

You can read more about RuboCop Capybara in its [official manual](https://docs.rubocop.org/rubocop-capybara).

## The Cops

All cops are located under

[`lib/rubocop/cop/capybara`](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:

```yaml

Capybara/SpecificMatcher:

  Exclude:

    - spec/my_spec.rb

```

## Contributing

Checkout the [contribution guidelines](.github/CONTRIBUTING.md).

## License

`rubocop-capybara` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for

the full text.