1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
# RuboCop RSpec
[](https://gitter.im/rubocop-rspec/Lobby)
[](https://rubygems.org/gems/rubocop-rspec)
RSpec-specific analysis for your projects, as an extension to
[RuboCop](https://github.com/rubocop/rubocop).
## Installation
Just install the `rubocop-rspec` gem
```bash
gem install rubocop-rspec
```
or if you use bundler put this in your `Gemfile`
```
gem 'rubocop-rspec', require: false
```
### Upgrading to RuboCop RSpec v2.x
Read all the details in our [Upgrade to Version 2.x](https://docs.rubocop.org/rubocop-rspec/2.0/upgrade_to_version_2.html) document.
## Usage
You need to tell RuboCop to load the RSpec extension. There are three
ways to do this:
### RuboCop configuration file
Put this into your `.rubocop.yml`.
```yaml
require: rubocop-rspec
```
Alternatively, use the following array notation when specifying multiple extensions.
```yaml
require:
- rubocop-other-extension
- rubocop-rspec
```
Now you can run `rubocop` and it will automatically load the RuboCop RSpec
cops together with the standard cops.
### Command line
```bash
rubocop --require rubocop-rspec
```
### Rake task
```ruby
RuboCop::RakeTask.new do |task|
task.requires << 'rubocop-rspec'
end
```
### Code Climate
rubocop-rspec is available on Code Climate as part of the rubocop engine. [Learn More](https://marketing.codeclimate.com/changelog/55a433bbe30ba00852000fac/).
## Documentation
You can read more about RuboCop RSpec in its [official manual](https://docs.rubocop.org/rubocop-rspec).
## The Cops
All cops are located under
[`lib/rubocop/cop/rspec`](lib/rubocop/cop/rspec), and contain
examples/documentation.
In your `.rubocop.yml`, you may treat the RSpec cops just like any other
cop. For example:
```yaml
RSpec/FilePath:
Exclude:
- spec/my_poorly_named_spec_file.rb
```
## Contributing
Checkout the [contribution guidelines](.github/CONTRIBUTING.md).
## License
`rubocop-rspec` is MIT licensed. [See the accompanying file](MIT-LICENSE.md) for
the full text.
|
