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 linter rspec rubocop ruby

Last synced: 30 days 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 (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T18:16:45.000Z (11 months ago)
• Last Synced: 2024-12-18T17:13:09.595Z (about 2 months ago)
• Topics: formatter, linter, rspec, rubocop, ruby
• Language: Ruby
• Homepage:
• Size: 61.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• 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

![GitHub top language](https://img.shields.io/github/languages/top/ydah/rubocop-rspec-extra) ![GitHub](https://img.shields.io/github/license/ydah/rubocop-rspec-extra) [![Gem Version](https://badge.fury.io/rb/rubocop-rspec-extra.svg)](https://badge.fury.io/rb/rubocop-rspec-extra) ![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg) [![CI](https://github.com/ydah/rubocop-rspec-extra/actions/workflows/ci.yml/badge.svg)](https://github.com/ydah/rubocop-rspec-extra/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/6b1f27edd867a4b64661/maintainability)](https://codeclimate.com/github/ydah/rubocop-rspec-extra/maintainability)

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

require: rubocop-rspec-extra

```

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

```yaml

require:

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

### Command line

```bash

rubocop --require rubocop-rspec-extra

```

### Rake task

```ruby

RuboCop::RakeTask.new do |task|

  task.requires << '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.