https://github.com/rubocop/rubocop-rspec_rails
Code style checking for Rails-related RSpec files.
https://github.com/rubocop/rubocop-rspec_rails
lint rails rspec rspec-rails rubocop ruby static-analysis testing
Last synced: 7 months ago
JSON representation
Code style checking for Rails-related RSpec files.
- Host: GitHub
- URL: https://github.com/rubocop/rubocop-rspec_rails
- Owner: rubocop
- License: mit
- Created: 2024-03-05T13:40:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-10T08:56:33.000Z (8 months ago)
- Last Synced: 2025-03-28T09:07:16.244Z (7 months ago)
- Topics: lint, rails, rspec, rspec-rails, rubocop, ruby, static-analysis, testing
- Language: Ruby
- Homepage: https://docs.rubocop.org/rubocop-rspec_rails
- Size: 1.14 MB
- Stars: 23
- Watchers: 2
- Forks: 8
- Open Issues: 11
-
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 RSpec Rails
[](https://gitter.im/rubocop-rspec/Lobby)
[](https://rubygems.org/gems/rubocop-rspec_rails)
[RSpec Rails](https://rspec.info/)-specific analysis for your projects, as an extension to
[RuboCop](https://github.com/rubocop/rubocop).
## Installation
**This gem implicitly depends on the `rubocop-rspec` gem, so you should install it first.**
Just install the `rubocop-rspec` and `rubocop-rspec_rails` gem
```bash
gem install rubocop-rspec rubocop-rspec_rails
```
or if you use bundler put this in your `Gemfile`
```ruby
gem 'rubocop-rspec', require: false
gem 'rubocop-rspec_rails', require: false
```
## Usage
You need to tell RuboCop to load the RSpec Rails extension. There are three
ways to do this:
### RuboCop configuration file
Put this into your `.rubocop.yml`.
```yaml
plugins: rubocop-rspec_rails
```
Alternatively, use the following array notation when specifying multiple extensions.
```yaml
plugins:
- rubocop-rspec
- rubocop-rspec_rails
```
Now you can run `rubocop` and it will automatically load the RuboCop RSpec Rails
cops together with the standard cops.
> [!NOTE]
> The plugin system is supported in RuboCop 1.72+. In earlier versions, use `require` instead of `plugins`.
### Command line
```bash
rubocop --plugin rubocop-rspec_rails
```
### Rake task
```ruby
RuboCop::RakeTask.new do |task|
task.plugins << 'rubocop-rspec_rails'
end
```
## Documentation
You can read more about RuboCop RSpec Rails in its [official manual](https://docs.rubocop.org/rubocop-rspec_rails).
## The Cops
All cops are located under
[`lib/rubocop/cop/rspec_rails`](lib/rubocop/cop/rspec_rails), and contain
examples/documentation.
In your `.rubocop.yml`, you may treat the RSpec Rails cops just like any other
cop. For example:
```yaml
RSpecRails/AvoidSetupHook:
Exclude:
- spec/my_poorly_named_spec_file.rb
```
## Contributing
Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
## License
`rubocop-rspec_rails` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
the full text.