rubocop-github 0.17.0 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 0fd87ba9b81dbf0489ef9f8bdddfdc7ad832c7735e4376851165a03369a4493d
4
- data.tar.gz: 294732c21b2ac89bde8bc654854d659293b7347ca478013e2eeeda8be3b92c4d
3
+ metadata.gz: 7e2de9cd12a2e6dc23c4ab4af442fa0989b99c0b2f775300ea9137aa1d569591
4
+ data.tar.gz: eede5dc50f6f7fdf7fd4d05cede6b70a989e97c2c2df18420b97fefd8997782e
5
5
  SHA512:
6
- metadata.gz: 75eca6f6d9a4c688a24f57f6b282d8a7515e7408db7c403ae0c3acdcd677d9cbb6acaa0713c55f8544baed002a077a1bcb3f2a4efd24d9118b720b7175d84a2c
7
- data.tar.gz: 4770a141ce649d7bb034a9071db481a52858461672804e63ba62ea928072e0094177630d747a40b50ec017dafb323b5e6f4d4249d2e4ab543a20ebd5c53cfb14
6
+ metadata.gz: a8fc315cb6296196a0c3358990e2d5338217afcfbad7fc78a3dd636a52c32d3da2e2566906788fc8cf9818d3543d9939a59e431c3d7dc48eb105d58a8cb63f1e
7
+ data.tar.gz: da8ea70e7537cf46b80ccd81804bdbc407c45822a727c0715e571dc19f2706416ddefd6d1504da0f1a67254c4ef99bfdecc5054732eabbf1571a07a39d9c87e9
data/README.md CHANGED
@@ -4,50 +4,49 @@ This repository provides recommended RuboCop configuration and additional Cops f
4
4
 
5
5
  ## Usage
6
6
 
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.
7
+ Add `rubocop-github` to your Gemfile, along with its dependencies:
8
8
 
9
- ### Legacy usage
10
-
11
- **Gemfile**
9
+ ```ruby
10
+ gem "rubocop-github", require: false
11
+ gem "rubocop-performance", require: false
12
+ gem "rubocop-rails", require: false
13
+ ```
12
14
 
13
- ``` ruby
14
- gem "rubocop", "< 0.68"
15
- gem "rubocop-github"
16
- ```
15
+ Inherit all of the stylistic rules and cops through an inheritance declaration in your `.rubocop.yml`:
17
16
 
18
- **.rubocop.yml**
17
+ ```yaml
18
+ # .rubocop.yml
19
+ inherit_from:
20
+ rubocop-github:
21
+ - config/default.yml # generic Ruby rules and cops
22
+ - config/rails.yml # Rails-specific rules and cops
23
+ ```
19
24
 
20
- ``` yaml
21
- inherit_gem:
22
- rubocop-github:
23
- - config/default.yml
24
- - config/rails.yml
25
- ```
25
+ Alternatively, only require the additional custom cops in your `.rubocop.yml` without inheriting/enabling the other stylistic rules:
26
26
 
27
- ### Edge usage
27
+ ```yaml
28
+ # .rubocop.yml
29
+ require:
30
+ - rubocop-github # generic Ruby cops only
31
+ - rubocop-github-rails # Rails-specific cops only
32
+ ```
28
33
 
29
- **Gemfile**
34
+ 💭 Looking for `config/accessibility.yml` and the `GitHub/Accessibility` configs? They have been moved to [a new gem](https://github.com/github/rubocop-rails-accessibility).
30
35
 
31
- ``` ruby
32
- gem "rubocop-github"
33
- gem "rubocop-performance", require: false
34
- gem "rubocop-rails", require: false
35
- ```
36
+ For more granular control over which of RuboCop's rules are enabled for your project, both from this gem and your own configs, consider using the `DisabledByDefault: true` option under `AllCops` in your project's `.rubocop.yml` file. This will disable all cops by default, and you can then explicitly enable the ones you want by setting `Enabled: true`. See [the RuboCop docs](https://docs.rubocop.org/rubocop/configuration.html#enabled) for more information.
36
37
 
37
- **.rubocop.yml**
38
+ ### Legacy usage
38
39
 
39
- ``` yaml
40
- inherit_gem:
41
- rubocop-github:
42
- - config/default_edge.yml
43
- - config/rails_edge.yml
44
- ```
40
+ If you are using a rubocop version < 1.0.0, you can use rubocop-github version
41
+ 0.16.2 (see the README from that version for more details).
45
42
 
46
43
  ## Testing
47
44
 
48
- `bundle install`
49
- `bundle exec rake test`
45
+ ``` bash
46
+ bundle install
47
+ bundle exec rake test
48
+ ```
50
49
 
51
50
  ## The Cops
52
51
 
53
- All cops are located under [`lib/rubocop/cop/github`](lib/rubocop/cop/github), and contain examples/documentation.
52
+ All cops are located under [`lib/rubocop/cop/github`](lib/rubocop/cop/github).