rubocop-packs 0.0.34 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa1524fd9d2f94de215b45b9b2a26bd0984286d21e59c787caf70717d1ebb3ae
-  data.tar.gz: b749545874b549013197564cccce90f58cdafb838b38e9045e1cbcd53f325d97
+  metadata.gz: 0d8ba7aa60a4c1be7d8958da1e4653ec7fc1c6435885ed66bbc5e7c47850043e
+  data.tar.gz: b7b3a20d9ddfeefc92464b8695d834b4a9fa740ff7683faab48fbe2ff2e437b3
 SHA512:
-  metadata.gz: 054c01a73226e1cae5bbc96f17f3757156aeeb4980745d46cac49a9661b67e29b4fd802e4b83668ad5468122fe6c351e81b06db90b44ac98c3e3705efe1d7dbb
-  data.tar.gz: df0a6e1355e1d455c03c5fd3b067ca7bb97d14f86bf94829d1909aa6e4d03812ddd743291cd93b35261147f0adc29ebffafa6efc10d4380df8f7301a8fc0aad3
+  metadata.gz: 53cc68843262c7688c051446ad996d4962e6e1ca0215b9d600d6633e2c8043f2daf6fe24b4315ce7979f01a824332fe25076d862818af5ea01853ed989ee7e45
+  data.tar.gz: '09a74c8fd5f4e14aa53a8376af093f9ce414b1689e6ac21a22dd3c894a967fbc5a5c8368a50e4e6ced576e8c014f8394e31365f039abc6df8e1ea676573d0e6d'

data/README.md

@@ -41,7 +41,7 @@ Packs/RootNamespaceIsPackName:
     - lib/example.rb
 ```
 
-## Pack-Level `package_rubocop.yml` and `package_rubocop_todo.yml` files
+## Pack-Level `.rubocop.yml` and `.rubocop_todo.yml` files
 See [ADVANCED_USAGE.md](ADVANCED_USAGE.md)
 
 ## Contributing

data/config/default.yml

@@ -27,6 +27,3 @@ PackwerkLite/Privacy:
 PackwerkLite/Dependency:
   # It is recommended to use packwerk
   Enabled: false
-
-# We do this inherit *after* setting the defaults so that pack-specific rubocops can override the defaults
-inherit_from: ./pack_config.yml

data/lib/rubocop/packs/private.rb

@@ -87,6 +87,8 @@ module RuboCop
         end
 
         loaded_rubocop_yml.each_key do |key|
+          next if key == 'inherit_from'
+
           if !Packs.config.permitted_pack_level_cops.include?(key)
             errors << <<~ERROR_MESSAGE
               #{rubocop_yml} contains invalid configuration for #{key}.

data/lib/rubocop/packs.rb

@@ -7,17 +7,11 @@ module RuboCop
   module Packs
     extend T::Sig
 
-    # 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'
+    PACK_LEVEL_RUBOCOP_YML = '.rubocop.yml'
+    PACK_LEVEL_RUBOCOP_TODO_YML = '.rubocop_todo.yml'
 
     PROJECT_ROOT   = T.let(Pathname.new(__dir__).parent.parent.expand_path.freeze, Pathname)
     CONFIG_DEFAULT = T.let(PROJECT_ROOT.join('config', 'default.yml').freeze, Pathname)
-    CONFIG         = T.let(YAML.safe_load(CONFIG_DEFAULT.read).freeze, T.untyped)
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
 
@@ -59,7 +53,7 @@ module RuboCop
         offenses_for_pack.group_by(&:filepath).each do |filepath, offenses_by_filepath|
           offenses_by_filepath.map(&:cop_name).uniq.each do |cop_name|
             rubocop_todo[cop_name] ||= { 'Exclude' => [] }
-            rubocop_todo[cop_name]['Exclude'] << filepath
+            rubocop_todo[cop_name]['Exclude'] << Pathname.new(filepath).relative_path_from(pack.relative_path).to_s
           end
         end
 
@@ -93,46 +87,6 @@ module RuboCop
       end
     end
 
-    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_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
-        ::Packs.all.each do |package|
-          rubocop_todo = package.relative_path.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.relative_path.join(PACK_LEVEL_RUBOCOP_YML)
-          next unless pack_rubocop.exist?
-
-          loaded_pack_rubocop = YAML.load_file(pack_rubocop)
-          loaded_pack_rubocop.each do |cop_name, key_config|
-            rubocop_config[cop_name] ||= {}
-
-            if key_config['Enabled']
-              rubocop_config[cop_name]['Include'] ||= []
-              rubocop_config[cop_name]['Include'] << package.relative_path.join('**/*').to_s
-            else
-              rubocop_config[cop_name]['Exclude'] ||= []
-              rubocop_config[cop_name]['Exclude'] << package.relative_path.join('**/*').to_s
-            end
-          end
-        end
-      end
-
-      YAML.dump(rubocop_config)
-    end
-
     sig { void }
     def self.bust_cache!
       config.bust_cache!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packs
 version: !ruby/object:Gem::Version
-  version: 0.0.34
+  version: 0.0.36
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-11 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -201,7 +201,6 @@ extra_rdoc_files: []
 files:
 - README.md
 - config/default.yml
-- config/pack_config.yml
 - lib/rubocop-packs.rb
 - lib/rubocop/cop/packs/class_methods_as_public_apis.rb
 - lib/rubocop/cop/packs/documented_public_apis.rb

data/config/pack_config.yml

@@ -1,6 +0,0 @@
-# Relevant documentation:
-#  - Inheriting config from a gem:
-#    - 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_config %>