rubocop-packs 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be0363ed2023527b2c25a80a934abac48fd8e75c5c9b8f3882e0391305f2544c
-  data.tar.gz: 3a082b0eb17b5bf25a2cbba0fbe01322b7d56598512102551c87635bbaea2df9
+  metadata.gz: 36726c94e4904ac2823f941a57fb7f5f725b28bb73fc2e837c7d75d41d55dfbe
+  data.tar.gz: cc6d345f6e81eb66edfaefece8a2c9727d471bbd3b86164ded3baf20d3989378
 SHA512:
-  metadata.gz: 06a8046673579208dbe40a4f46b9cb11ff7360af8712736b794b0e66cfc9ec0411f9cdf837bf2acfd03c2f11cbeb82b6ff9291ca768824ffe2fc19f0d15d7e17
-  data.tar.gz: 9debb88541b7c1e9506078c4de88ca6507d6f2b3fab95226269c70265a438c15533f1fae6dfc7a13b0707a93ec269093ec3fe0561a06047c83d05ed7e635fa18
+  metadata.gz: 80d9e6eb7777118a44a813c88cdca22eb67281723e1dad9d995db9f7d557fde5cf48da9a4dd6596803a667c6622c714c93137e1bc7e2deae5d4d46c3a1f81849
+  data.tar.gz: 31e23a78b39d7e776c398cfe55f89e78d3d58bc761a69d3d1abc1298120b109c939eef96ce0653ec0337a1f4d05dc40b40b636dde0bb25ce0916b036ada526c1

data/README.md

@@ -23,59 +23,68 @@ You need to tell RuboCop to load the Packs extension. There are three ways to do
 
 Put this into your `.rubocop.yml`:
 
-```yaml
-require: rubocop-packs
-```
-
-Alternatively, use the following array notation when specifying multiple extensions:
-
 ```yaml
 require:
-  - rubocop-other-extension
   - rubocop-packs
 ```
 
 Now you can run `rubocop` and it will automatically load the RuboCop Packs cops together with the standard cops.
 
-### Command line
-
-```sh
-rubocop --require rubocop-packs
-```
-
-### Rake task
-
-```ruby
-RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-packs'
-end
-```
-
 ## The Cops
 All cops are located under [`lib/rubocop/cop/packs`](lib/rubocop/cop/packs), and contain examples/documentation.
 
 In your `.rubocop.yml`, you may treat the Packs cops just like any other cop. For example:
 
 ```yaml
-Packs/NamespacedUnderPackageName:
+Packs/NamespaceConvention:
   Exclude:
     - lib/example.rb
 ```
 
-## Other Utilities
+## Pack-Level `.rubocop.yml` and `.rubocop_todo.yml` files
 `rubocop-packs` also has some API that help you use rubocop in a pack-based context.
 
-### `RuboCop::Packs.auto_generate_rubocop_todo(packs: ParsePackwerk.all)`
-This API will auto-generate a `packs/some_pack/.rubocop_todo.yml`. This allows a pack to own its own exception list. Note that you need to configure `rubocop-packs` with an allow list of cops that can live in per-pack `.rubocop_todo.yml` files:
+### Per-pack `.rubocop.yml`
+While `rubocop-packs` can be used like any other `rubocop` by configuring in your top-level `.rubocop.yml` file, we also have a number of tools to support per-pack configuration.
+
+To add a per-pack `.rubocop.yml`, you just need to create a `packs/your_pack/.rubocop.yml` and then include:
+```yml
+inherit_from: '../../.rubocop.yml'
+```
+
+Note though that inherited paths are relative to your pack-level `.rubocop.yml`. To avoid that, you can rename your `.rubocop.yml` to `.inherited_rubocop.yml`, set `.rubocop.yml` to:
+```
+inherit_from: '.inherited_rubocop.yml'
+```
+And then similarly change the `inherit_from` in `packs/your_pack/.rubocop.yml`.
+
+### Per-pack `.rubocop_todo.yml`
+To create a per-pack `.rubocop_todo.yml`, you can use the following API from `rubocop-packs`:
+```ruby
+RuboCop::Packs.auto_generate_rubocop_todo(packs: ParsePackwerk.all)
 ```
-# `config/rubocop_packs.rb`
+This API will auto-generate a `packs/some_pack/.rubocop_todo.yml`. This allows a pack to own its own exception list.
+
+### Configuration and Validation
+To use per-pack `.rubocop.yml` and `.rubocop_todo.yml` files, you need to configure `rubocop-packs`:
+```ruby
+# config/rubocop_packs.rb
 RuboCop::Packs.configure do |config|
-  # For example:
   config.permitted_pack_level_cops = ['Packs/NamespaceConvention']
+  config.required_pack_level_cops = ['Packs/NamespaceConvention']
+end
+```
+
+The above two settings have associated validations that run with `RuboCop::Packs.validate`, which returns an array of errors. We recommend validating this in your test suite, for example:
+```ruby
+RSpec.describe 'rubocop-packs validations' do
+  it { expect(RuboCop::Packs.validate).to be_empty }
 end
 ```
 
-There is a supporting validation to ensure these `packs/*/.rubocop_todo.yml` files only add exceptions to the allow listed set of rules. Run this validation with `RuboCop::packs.validate`, which returns an array of errors.
+Validations include:
+- Ensuring that `packs/*/.rubocop_todo.yml` files only contain exceptions for the allow-list of `permitted_pack_level_cops`
+- Ensuring that `packs/*/.rubocop.yml` files contain all of the cops listed in `required_pack_level_cops` and no other cops. This is to ensure that these files are only used to turn on and off an allow-list of cops, as most users would not want packs to configure most `rubocop` rules in a way that is different from the rest of the application.
 
 ## Contributing
 

data/lib/rubocop/packs/private.rb

@@ -20,7 +20,7 @@ module RuboCop
         return if @loaded_client_configuration
 
         @loaded_client_configuration = true
-        client_configuration = Pathname.pwd.join('config/rubocop_packs.rb')
+        client_configuration = Bundler.root.join('config/rubocop_packs.rb')
         require client_configuration.to_s if client_configuration.exist?
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - Gusto Engineers