rubocop-packs 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f2f8bb6cbf9a0c8e6a903a9e94ecbc6b31b25f38caadee98b9d433ce0ea9d83
-  data.tar.gz: '0843185e5171470039bf39ff147fcf8f5fc93269b11c955c1358891c6df6e95f'
+  metadata.gz: 49afe61bb4672111e0ba64bc690715756d3d2f7130c96d71f0036add413d18ac
+  data.tar.gz: 615a905e64ea7647eb922d25c87b9cbbd76c3826da207dccf3ce2b511d281ccb
 SHA512:
-  metadata.gz: ea2a62a6152a629acef1a17cf95b7833573aad7e838adbd969820490683f8ad710ce06544e54e913b231f2426ee75a2f4fe331fac37f246ebb20fb21ae5263d9
-  data.tar.gz: 5ee607be5da8cbe0d0d416c46f0ffe983d14dbdc8effc4e1551b0aa33a6d0a323f9a5e8fefb59a12ebc1acaab31d37f98e4e59141b06a85bf486f82c0f8d2fb3
+  metadata.gz: e15fc57d0f220c6b26015f0e93473e268cd01efba23c8e46d6aa9a3bb0fe4fb136aed35f69173b039e233a47e32ebd80465d81f8ff0a5a9a0a45b96ad42720c6
+  data.tar.gz: 20acb3ad05d415715751c228e01c21aa5e975da81d088394c1627d86b927303bf278348bbb2ba938a60463a830d6001d147265edf449ff441c7a84c59d7230de

data/README.md

@@ -41,50 +41,8 @@ Packs/RootNamespaceIsPackName:
     - lib/example.rb
 ```
 
-## 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.
-
-### 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 `.base_rubocop.yml`, set `.rubocop.yml` to:
-```
-inherit_from: '.base_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)
-```
-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|
-  config.permitted_pack_level_cops = ['Packs/RootNamespaceIsPackName']
-  config.required_pack_level_cops = ['Packs/RootNamespaceIsPackName']
-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
-```
-
-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.
+## Pack-Level `package_rubocop.yml` and `package_rubocop_todo.yml` files
+See [ADVANCED_USAGE.md](ADVANCED_USAGE.md)
 
 ## Contributing
 

data/config/pack_config.yml

@@ -3,4 +3,4 @@
 #    - https://docs.rubocop.org/rubocop/configuration.html#inheriting-configuration-from-a-dependency-gem
 #  - ERB in a .rubocop.yml file
 #    - https://docs.rubocop.org/rubocop/configuration.html#pre-processing
-<%= RuboCop::Packs.pack_based_rubocop_todos %>
+<%= RuboCop::Packs.pack_based_rubocop_config %>

data/lib/rubocop/packs/private.rb

@@ -28,7 +28,7 @@ module RuboCop
       def self.rubocop_todo_ymls
         @rubocop_todo_ymls = T.let(@rubocop_todo_ymls, T.nilable(T::Array[T::Hash[T.untyped, T.untyped]]))
         @rubocop_todo_ymls ||= begin
-          todo_files = Pathname.glob('**/.rubocop_todo.yml')
+          todo_files = Pathname.glob("**/#{PACK_LEVEL_RUBOCOP_TODO_YML}")
           todo_files.map do |todo_file|
             YAML.load_file(todo_file)
           end
@@ -38,7 +38,7 @@ module RuboCop
       sig { params(package: ParsePackwerk::Package).returns(T::Array[String]) }
       def self.validate_rubocop_todo_yml(package)
         errors = []
-        rubocop_todo = package.directory.join('.rubocop_todo.yml')
+        rubocop_todo = package.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
         return errors unless rubocop_todo.exist?
 
         loaded_rubocop_todo = YAML.load_file(rubocop_todo)
@@ -47,7 +47,7 @@ module RuboCop
             errors << <<~ERROR_MESSAGE
               #{rubocop_todo} contains invalid configuration for #{key}.
               Please only configure the following cops on a per-pack basis: #{Packs.config.permitted_pack_level_cops.inspect}"
-              For ignoring other cops, please instead modify the top-level .rubocop_todo.yml file.
+              For ignoring other cops, please instead modify the top-level #{PACK_LEVEL_RUBOCOP_TODO_YML} file.
             ERROR_MESSAGE
           elsif loaded_rubocop_todo[key].keys != ['Exclude']
             errors << <<~ERROR_MESSAGE
@@ -73,7 +73,7 @@ module RuboCop
       sig { params(package: ParsePackwerk::Package).returns(T::Array[String]) }
       def self.validate_rubocop_yml(package)
         errors = []
-        rubocop_yml = package.directory.join('.rubocop.yml')
+        rubocop_yml = package.directory.join(PACK_LEVEL_RUBOCOP_YML)
         return errors unless rubocop_yml.exist?
 
         loaded_rubocop_yml = YAML.load_file(rubocop_yml)
@@ -85,8 +85,6 @@ module RuboCop
         end
 
         loaded_rubocop_yml.each_key do |key|
-          next if key.to_s == 'inherit_from'
-
           if !Packs.config.permitted_pack_level_cops.include?(key)
             errors << <<~ERROR_MESSAGE
               #{rubocop_yml} contains invalid configuration for #{key}.
@@ -130,7 +128,7 @@ module RuboCop
         Packs.config.permitted_pack_level_cops.each do |cop|
           excludes = exclude_for_rule(cop)
 
-          rubocop_yml = package.directory.join('.rubocop.yml')
+          rubocop_yml = package.directory.join(PACK_LEVEL_RUBOCOP_YML)
 
           next unless rubocop_yml.exist?
 
@@ -143,7 +141,7 @@ module RuboCop
           next if excludes_for_package.empty?
 
           formatted_excludes = excludes_for_package.map { |ex| "`#{ex}`" }.join(', ')
-          errors << "#{package.name} has set `#{cop}` to `FailureMode: strict` in `packs/some_pack/.rubocop.yml`, forbidding new exceptions. Please either remove #{formatted_excludes} from the top-level and pack-specific `.rubocop_todo.yml` files or remove `FailureMode: strict`."
+          errors << "#{package.name} has set `#{cop}` to `FailureMode: strict` in `packs/some_pack/#{PACK_LEVEL_RUBOCOP_YML}`, forbidding new exceptions. Please either remove #{formatted_excludes} from the top-level and pack-specific `#{PACK_LEVEL_RUBOCOP_TODO_YML}` files or remove `FailureMode: strict`."
         end
 
         errors

data/lib/rubocop/packs.rb

@@ -5,6 +5,14 @@ require 'rubocop/packs/private'
 
 module RuboCop
   module Packs
+    # Pack-level rubocop and rubocop_todo YML files are named differently because they are not integrated
+    # into rubocop in the standard way. For example, we could call these the standard `.rubocop.yml` and
+    # `.rubocop_todo.yml`. However, this introduces a number of path relativity issues (https://docs.rubocop.org/rubocop/configuration.html#path-relativity)
+    # that make this approach not possible. Therefore, for pack level rubocops, we name them in a way that mirrors packwerk `package_todo.yml` files
+    # for consistency and to ensure that thes are not read by rubocop except via the ERB templating mechanism.
+    PACK_LEVEL_RUBOCOP_YML = 'package_rubocop.yml'
+    PACK_LEVEL_RUBOCOP_TODO_YML = 'package_rubocop_todo.yml'
+
     class Error < StandardError; end
     extend T::Sig
 
@@ -45,7 +53,7 @@ module RuboCop
 
       new_rubocop_todo_exclusions.each do |pack_name, file_hash|
         pack = T.must(ParsePackwerk.find(pack_name))
-        rubocop_todo_yml = pack.directory.join('.rubocop_todo.yml')
+        rubocop_todo_yml = pack.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
         if rubocop_todo_yml.exist?
           rubocop_todo = YAML.load_file(rubocop_todo_yml)
         else
@@ -72,18 +80,17 @@ module RuboCop
     sig { params(packs: T::Array[ParsePackwerk::Package]).void }
     def self.set_default_rubocop_yml(packs:)
       packs.each do |pack|
-        rubocop_yml = Pathname.new(pack.directory.join('.rubocop.yml'))
+        rubocop_yml = Pathname.new(pack.directory.join(PACK_LEVEL_RUBOCOP_YML))
         rubocop_yml_hash = {}
-        rubocop_yml_hash['inherit_from'] = '../../.base_rubocop.yml'
         config.required_pack_level_cops.each do |cop|
           rubocop_yml_hash[cop] = { 'Enabled' => true }
         end
 
         formatted_yml = YAML.dump(rubocop_yml_hash).
-          # Remove the `---` header at the top of the file
-          gsub("---\n", '').
           # Find lines of the form \nCopDepartment/CopName: and add a new line before it.
-          gsub(%r{^(\w+/\w+:)}, "\n\\1")
+          gsub(%r{^(\w+/\w+:)}, "\n\\1").
+          # Remove the `---` header at the top of the file
+          gsub("---\n\n", '')
 
         rubocop_yml.write(formatted_yml)
       end
@@ -92,26 +99,39 @@ module RuboCop
     sig { params(root_pathname: String).returns(String) }
     # It would be great if rubocop (upstream) could take in a glob for `inherit_from`, which
     # would allow us to delete this method and this additional complexity.
-    def self.pack_based_rubocop_todos(root_pathname: Bundler.root)
-      rubocop_todos = {}
+    def self.pack_based_rubocop_config(root_pathname: Bundler.root)
+      rubocop_config = {}
       # We do this because when the ERB is evaluated Dir.pwd is at the directory containing the YML.
       # Ideally rubocop wouldn't change the PWD before invoking this method.
       Dir.chdir(root_pathname) do
         ParsePackwerk.all.each do |package|
           next if package.name == ParsePackwerk::ROOT_PACKAGE_NAME
 
-          rubocop_todo = package.directory.join('.rubocop_todo.yml')
-          next unless rubocop_todo.exist?
+          rubocop_todo = package.directory.join(PACK_LEVEL_RUBOCOP_TODO_YML)
+          if rubocop_todo.exist?
+            loaded_rubocop_todo = YAML.load_file(rubocop_todo)
+            loaded_rubocop_todo.each do |cop_name, key_config|
+              rubocop_config[cop_name] ||= {}
+              rubocop_config[cop_name]['Exclude'] ||= []
+              rubocop_config[cop_name]['Exclude'] += key_config['Exclude']
+            end
+          end
+
+          pack_rubocop = package.directory.join('.pack_rubocop.yml')
+          next unless pack_rubocop.exist?
+
+          loaded_pack_rubocop = YAML.load_file(pack_rubocop)
+          loaded_pack_rubocop.each do |cop_name, key_config|
+            next unless key_config['Enabled']
 
-          loaded_rubocop_todo = YAML.load_file(rubocop_todo)
-          loaded_rubocop_todo.each do |protection_key, key_config|
-            rubocop_todos[protection_key] ||= { 'Exclude' => [] }
-            rubocop_todos[protection_key]['Exclude'] += key_config['Exclude']
+            rubocop_config[cop_name] ||= {}
+            rubocop_config[cop_name]['Include'] ||= []
+            rubocop_config[cop_name]['Include'] << package.directory.join('**/*').to_s
           end
         end
       end
 
-      YAML.dump(rubocop_todos)
+      YAML.dump(rubocop_config)
     end
 
     sig { void }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport