https://github.com/ydah/rubocop-rspec-extra
A RuboCop extension focused on enforcing RSpec. A place where no one is officially employed, but where useful cops can gather.
https://github.com/ydah/rubocop-rspec-extra
formatter hacktoberfest linter rspec rubocop ruby
Last synced: 4 months ago
JSON representation
A RuboCop extension focused on enforcing RSpec. A place where no one is officially employed, but where useful cops can gather.
- Host: GitHub
- URL: https://github.com/ydah/rubocop-rspec-extra
- Owner: ydah
- License: mit
- Created: 2023-03-08T13:46:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-11-24T16:01:08.000Z (7 months ago)
- Last Synced: 2025-12-08T01:41:29.858Z (7 months ago)
- Topics: formatter, hacktoberfest, linter, rspec, rubocop, ruby
- Language: Ruby
- Homepage:
- Size: 66.4 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Rubocop::Rspec::Extra [](https://badge.fury.io/rb/rubocop-rspec-extra) [](https://github.com/ydah/rubocop-rspec-extra/actions/workflows/ci.yml)
A [RuboCop](https://github.com/rubocop/rubocop) extension focused on enforcing RSpec. A place where no one is officially employed, but where useful cops can gather.
## Installation
Just install the `rubocop-rspec-extra` gem
```bash
gem install rubocop-rspec-extra
```
or if you use bundler put this in your `Gemfile`
```bash
gem 'rubocop-rspec-extra', require: false
```
## Usage
You need to tell RuboCop to load the RSpec Extra extension. There are two
ways to do this:
### RuboCop configuration file
Put this into your `.rubocop.yml`.
```yaml
plugins: rubocop-rspec-extra
```
Alternatively, use the following array notation when specifying multiple extensions.
```yaml
plugins:
- rubocop-rspec
- rubocop-rspec-extra
```
Now you can run `rubocop` and it will automatically load the RuboCop RSpec Extra
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 --plugins rubocop-rspec-extra
```
### Rake task
```ruby
RuboCop::RakeTask.new do |task|
task.plugins << 'rubocop-rspec-extra'
end
```
## The Cops
All cops are located under
[`lib/rubocop/cop/rspec/extra`](lib/rubocop/cop/rspec/extra), and contain
examples/documentation.
In your `.rubocop.yml`, you may treat the RSpec extra cops just like any other
cop. For example:
```yaml
RSpec/Extra/RestrictBlockTag:
Exclude:
- spec/my_poorly_named_spec_file.rb
```
## Contributing
Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
## License
`rubocop-rspec-extra` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
the full text.