Skip to content

Commit 7c67cb5

Browse files
Merge pull request #101 from github/remove-legacy-config
Delete legacy config
2 parents a791e78 + 695169d commit 7c67cb5

File tree

11 files changed

+469
-505
lines changed

11 files changed

+469
-505
lines changed

Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ PATH
22
remote: .
33
specs:
44
rubocop-github (0.17.0)
5-
rubocop
5+
rubocop (>= 1.0.0)
66
rubocop-performance
77
rubocop-rails
88

@@ -48,7 +48,7 @@ GEM
4848
rake (13.0.6)
4949
regexp_parser (2.2.0)
5050
rexml (3.2.5)
51-
rubocop (1.25.0)
51+
rubocop (1.25.1)
5252
parallel (~> 1.10)
5353
parser (>= 3.1.0.0)
5454
rainbow (>= 2.2.2, < 4.0)

README.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,6 @@ This repository provides recommended RuboCop configuration and additional Cops f
44

55
## Usage
66

7-
Rubocop 0.68 removed performance cops and 0.72 removed Rails cops. However, upgrading `rubocop-github` without modification will almost definitely create very many new offenses. The current version of this gem exposes the "legacy" configuration under `config/default.yml` and `config/rails.yml` which should be used *if and only if* the version of rubocop is locked to `< 0.68` in your project (which it should be unless you `bundle update rubocop`). It also exposes an "edge" configuration under `config/default_edge.yml` and `config/rails_edge.yml` so that the changes can be tested without introducing breaking changes.
8-
9-
### Legacy usage
10-
11-
**Gemfile**
12-
13-
``` ruby
14-
gem "rubocop", "< 0.68"
15-
gem "rubocop-github"
16-
```
17-
18-
**.rubocop.yml**
19-
20-
``` yaml
21-
inherit_gem:
22-
rubocop-github:
23-
- config/default.yml
24-
- config/rails.yml
25-
```
26-
27-
### Edge usage
28-
297
**Gemfile**
308

319
``` ruby
@@ -43,6 +21,11 @@ inherit_gem:
4321
- config/rails_edge.yml
4422
```
4523
24+
### Legacy usage
25+
26+
If you are using a rubocop version < 1.0.0, you can use rubocop-github version
27+
0.16.2 (see the README from that version for more details).
28+
4629
## Testing
4730
4831
`bundle install`

config/_default_shared.yml

Lines changed: 0 additions & 333 deletions
This file was deleted.

0 commit comments

Comments
 (0)