use_packs 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88815e86f43379f87b2d925c883562f0ad12211e519a9af6249dd77f3627ed1a
-  data.tar.gz: 50eb6e85903b56a79adc16e89af0a9610e79159e2be63ed7f21985cc23970023
+  metadata.gz: b82690582fa896caf051420855c7dca09ca6f15501052b78d8bf28824157ee31
+  data.tar.gz: 88bb257e4f595628636c0c3b5eb13e74bc1c1295c8912144ceb45ac5e1de30fe
 SHA512:
-  metadata.gz: 1e72a14e415236769db14069f22c6b54c1f89f0ef3a6299265cd9836d93c978ecb2aaa8316714364b4e9532df8c0c49693fce7c42bb5c20b7b4c058cf9488488
-  data.tar.gz: 446ff0e9ff57eac52c954a7a4c393ab4d42c1a13891d16909e51f76aa21b0de4a4d361d6791eb751e67d0698dacb31df60497ecdd2087313ced045b4d882c5ac
+  metadata.gz: 3578e87c844f368342d6a8e1297e5755df972c1be88f506e24f296e7651ba5b44d0bbc43e37d7c8c1f3ed960020892b5d99539e5f9d787fc20c4a8a0bc3f4473
+  data.tar.gz: 12ffaf13df281d43a7dbedf1caa691258ac0040541ad6e30b3db23a3e92afc28852a2d1682f9615785bf930de5f30f74ac5533a1f23420af4ee02c9d4879a2cd

data/lib/use_packs/cli.rb

@@ -78,10 +78,10 @@ module UsePacks
       )
     end
 
-    desc 'lint_deprecated_references_yml_files', 'Ensures `deprecated_references.yml` files are up to date'
+    desc 'lint_package_todo_yml_files', 'Ensures `package_todo.yml` files are up to date'
     sig { void }
-    def lint_deprecated_references_yml_files
-      UsePacks.lint_deprecated_references_yml_files!
+    def lint_package_todo_yml_files
+      UsePacks.lint_package_todo_yml_files!
     end
 
     desc 'lint_package_yml_files [ packs/my_pack packs/my_other_pack ]', 'Lint `package.yml` files'
@@ -102,10 +102,10 @@ module UsePacks
       system("bin/packwerk check #{paths.join(' ')}")
     end
 
-    desc 'update [ packs/my_pack ]', 'Run bin/packwerk update-deprecations'
+    desc 'update [ packs/my_pack ]', 'Run bin/packwerk update-todo'
     sig { params(paths: String).void }
     def update(*paths)
-      system("bin/packwerk update-deprecations #{paths.join(' ')}")
+      system("bin/packwerk update-todo #{paths.join(' ')}")
     end
 
     desc 'regenerate_rubocop_todo [ packs/my_pack packs/my_other_pack ]', "Regenerate packs/*/#{RuboCop::Packs::PACK_LEVEL_RUBOCOP_TODO_YML} for one or more packs"

data/lib/use_packs/configuration.rb

@@ -13,18 +13,18 @@ module UsePacks
     sig { returns(UserEventLogger) }
     attr_accessor :user_event_logger
 
-    OnDeprecatedReferencesLintFailure = T.type_alias do
+    OnPackageTodoLintFailure = T.type_alias do
       T.proc.params(output: String).void
     end
 
-    sig { returns(OnDeprecatedReferencesLintFailure) }
-    attr_accessor :on_deprecated_references_lint_failure
+    sig { returns(OnPackageTodoLintFailure) }
+    attr_accessor :on_package_todo_lint_failure
 
     sig { void }
     def initialize
       @enforce_dependencies = T.let(default_enforce_dependencies, T::Boolean)
       @user_event_logger = T.let(DefaultUserEventLogger.new, UserEventLogger)
-      @on_deprecated_references_lint_failure = T.let(->(output) {}, OnDeprecatedReferencesLintFailure)
+      @on_package_todo_lint_failure = T.let(->(output) {}, OnPackageTodoLintFailure)
     end
 
     sig { returns(T::Boolean) }

data/lib/use_packs/private/interactive_cli/use_cases/get_info.rb

@@ -30,8 +30,7 @@ module UsePacks
             inbound_violations = {}
             outbound_violations = {}
             ParsePackwerk.all.each do |p|
-              violations_for_pack = ParsePackwerk::DeprecatedReferences.for(p).violations
-              violations_for_pack.each do |violation|
+              p.violations.each do |violation|
                 outbound_violations[p.name] ||= []
                 outbound_violations[p.name] << violation
                 inbound_violations[violation.to_package_name] ||= []

data/lib/use_packs/private/interactive_cli/use_cases/rename.rb

@@ -22,7 +22,7 @@ module UsePacks
               Follow these steps:
               1. Rename the `packs/your_pack` directory to the name of the new pack, `packs/new_pack_name
               2. Replace references to `- packs/your_pack` in `package.yml` files with `- packs/new_pack_name`
-              3. Rerun `bin/packwerk update-deprecations` to update violations
+              3. Rerun `bin/packwerk update-todo` to update violations
               4. Run `bin/codeownership validate` to update ownership information
               5. Please let us know if anything is missing.
             WARNING

data/lib/use_packs/private/interactive_cli/use_cases/{update_deprecations.rb → update_todo.rb}

@@ -4,19 +4,19 @@ module UsePacks
   module Private
     module InteractiveCli
       module UseCases
-        class UpdateDeprecations
+        class UpdateTodo
           extend T::Sig
           extend T::Helpers
           include Interface
 
           sig { override.returns(String) }
           def user_facing_name
-            'Run bin/packwerk update-deprecations'
+            'Run bin/packwerk update-todo'
           end
 
           sig { override.params(prompt: TTY::Prompt).void }
           def perform!(prompt)
-            system('bin/packwerk update-deprecations')
+            system('bin/packwerk update-todo')
           end
         end
       end

data/lib/use_packs/private/interactive_cli.rb

@@ -16,7 +16,7 @@ require 'use_packs/private/interactive_cli/use_cases/make_public'
 require 'use_packs/private/interactive_cli/use_cases/nest'
 require 'use_packs/private/interactive_cli/use_cases/rename'
 require 'use_packs/private/interactive_cli/use_cases/check'
-require 'use_packs/private/interactive_cli/use_cases/update_deprecations'
+require 'use_packs/private/interactive_cli/use_cases/update_todo'
 require 'use_packs/private/interactive_cli/use_cases/validate'
 require 'use_packs/private/interactive_cli/use_cases/regenerate_rubocop_todo'
 require 'use_packs/private/interactive_cli/use_cases/lint_package_yml'

data/lib/use_packs/private/packwerk_wrapper/offenses_aggregator_formatter.rb

@@ -24,10 +24,22 @@ module UsePacks
           ''
         end
 
-        sig { override.params(offense_collection: Packwerk::OffenseCollection, for_files: T::Set[String]).returns(String) }
+        # T.untyped should be Packwerk::OffenseCollection, but is currently private until
+        # https://github.com/Shopify/packwerk/pull/289 merges
+        sig { override.params(offense_collection: T.untyped, for_files: T::Set[String]).returns(String) }
         def show_stale_violations(offense_collection, for_files)
           ''
         end
+
+        sig { override.params(strict_mode_violations: T::Array[::Packwerk::ReferenceOffense]).returns(::String) }
+        def show_strict_mode_violations(strict_mode_violations)
+          ''
+        end
+
+        sig { override.returns(::String) }
+        def identifier
+          'offenses_aggregator'
+        end
       end
     end
   end

data/lib/use_packs/private.rb

@@ -109,7 +109,7 @@ module UsePacks
             if origin_pathname.directory?
               origin_pathname.glob('**/*.*').reject do |origin_path|
                 origin_path.to_s.include?(ParsePackwerk::PACKAGE_YML_NAME) ||
-                  origin_path.to_s.include?(ParsePackwerk::DEPRECATED_REFERENCES_YML_NAME)
+                  origin_path.to_s.include?(ParsePackwerk::PACKAGE_TODO_YML_NAME)
               end
             else
               origin_pathname
@@ -182,10 +182,10 @@ module UsePacks
         per_file_processors: per_file_processors
       )
 
-      # Then delete the old package.yml and deprecated_references.yml files
+      # Then delete the old package.yml and package_todo.yml files
       package.yml.delete
-      deprecated_references_file = ParsePackwerk::DeprecatedReferences.for(package).pathname
-      deprecated_references_file.delete if deprecated_references_file.exist?
+      package_todo_file = ParsePackwerk::PackageTodo.for(package).pathname
+      package_todo_file.delete if package_todo_file.exist?
 
       ParsePackwerk.bust_cache!
 
@@ -403,29 +403,29 @@ module UsePacks
     end
 
     sig { returns(T::Hash[String, String]) }
-    def self.get_deprecated_references_contents
-      deprecated_references = {}
+    def self.get_package_todo_contents
+      package_todo = {}
       ParsePackwerk.all.each do |package|
-        deprecated_references_yml = ParsePackwerk::DeprecatedReferences.for(package).pathname
-        if deprecated_references_yml.exist?
-          deprecated_references[deprecated_references_yml.to_s] = deprecated_references_yml.read
+        package_todo_yml = ParsePackwerk::PackageTodo.for(package).pathname
+        if package_todo_yml.exist?
+          package_todo[package_todo_yml.to_s] = package_todo_yml.read
         end
       end
 
-      deprecated_references
+      package_todo
     end
 
-    DeprecatedReferencesFiles = T.type_alias do
+    PackageTodoFiles = T.type_alias do
       T::Hash[String, T.nilable(String)]
     end
 
-    sig { params(before: DeprecatedReferencesFiles, after: DeprecatedReferencesFiles).returns(String) }
-    def self.diff_deprecated_references_yml(before, after)
+    sig { params(before: PackageTodoFiles, after: PackageTodoFiles).returns(String) }
+    def self.diff_package_todo_yml(before, after)
       dir_containing_contents_before = Dir.mktmpdir
       dir_containing_contents_after = Dir.mktmpdir
       begin
-        write_deprecated_references_to_tmp_folder(before, dir_containing_contents_before)
-        write_deprecated_references_to_tmp_folder(after, dir_containing_contents_after)
+        write_package_todo_to_tmp_folder(before, dir_containing_contents_before)
+        write_package_todo_to_tmp_folder(after, dir_containing_contents_after)
 
         diff = `diff -r #{dir_containing_contents_before}/ #{dir_containing_contents_after}/`
         # For ease of reading, sub out the tmp directory from the diff
@@ -436,15 +436,15 @@ module UsePacks
       end
     end
 
-    sig { params(deprecated_references_files: DeprecatedReferencesFiles, tmp_folder: String).void }
-    def self.write_deprecated_references_to_tmp_folder(deprecated_references_files, tmp_folder)
-      deprecated_references_files.each do |filename, contents|
+    sig { params(package_todo_files: PackageTodoFiles, tmp_folder: String).void }
+    def self.write_package_todo_to_tmp_folder(package_todo_files, tmp_folder)
+      package_todo_files.each do |filename, contents|
         next if contents.nil?
 
         tmp_folder_pathname = Pathname.new(tmp_folder)
-        temp_deprecated_references_yml = tmp_folder_pathname.join(filename)
-        FileUtils.mkdir_p(temp_deprecated_references_yml.dirname)
-        temp_deprecated_references_yml.write(contents)
+        temp_package_todo_yml = tmp_folder_pathname.join(filename)
+        FileUtils.mkdir_p(temp_package_todo_yml.dirname)
+        temp_package_todo_yml.write(contents)
       end
     end
   end

data/lib/use_packs/user_event_logger.rb

@@ -21,7 +21,7 @@ module UsePacks
 
         1) Move files into your pack with `bin/packs move #{pack_name} path/to/file.rb`
 
-        2) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
+        2) Run `bin/packwerk update-todo` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
 
         3) Expose public API in #{pack_name}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
 
@@ -41,7 +41,7 @@ module UsePacks
       <<~MSG
         Your next steps might be:
 
-        1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
+        1) Run `bin/packwerk update-todo` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
 
         2) Touch base with each team who owns files involved in this move
 
@@ -63,7 +63,7 @@ module UsePacks
       <<~MSG
         Your next steps might be:
 
-        1) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
+        1) Run `bin/packwerk update-todo` to update the violations. Make sure to run `spring stop` if you've added new load paths (new top-level directories) in your pack.
 
         2) Work to migrate clients of private API to your new public API
 
@@ -85,7 +85,7 @@ module UsePacks
 
         1) Run `bin/packwerk validate` to ensure you haven't introduced a cyclic dependency
 
-        2) Run `bin/packwerk update-deprecations` to update the violations.
+        2) Run `bin/packwerk update-todo` to update the violations.
       MSG
     end
 
@@ -103,7 +103,7 @@ module UsePacks
 
         1) Delete the old pack when things look good: `rm -rf #{pack_name}`
 
-        2) Run `bin/packwerk update-deprecations` to update the violations. Make sure to run `spring stop` first.
+        2) Run `bin/packwerk update-todo` to update the violations. Make sure to run `spring stop` first.
       MSG
     end
 

data/lib/use_packs.rb

@@ -247,28 +247,28 @@ module UsePacks
   end
 
   sig { void }
-  def self.lint_deprecated_references_yml_files!
-    contents_before = Private.get_deprecated_references_contents
-    UsePacks.execute(['update-deprecations'])
-    contents_after = Private.get_deprecated_references_contents
-    diff = Private.diff_deprecated_references_yml(contents_before, contents_after)
+  def self.lint_package_todo_yml_files!
+    contents_before = Private.get_package_todo_contents
+    UsePacks.execute(['update-todo'])
+    contents_after = Private.get_package_todo_contents
+    diff = Private.diff_package_todo_yml(contents_before, contents_after)
 
     if diff == ''
-      # No diff generated by `update-deprecations`
+      # No diff generated by `update-todo`
       exit 0
     else
       output = <<~OUTPUT
-        All `deprecated_references.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-deprecations`.
+        All `package_todo.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-todo`.
         This helps ensure a high quality signal in other engineers' PRs when inspecting new violations by ensuring there are no unrelated changes.
 
         There are three main reasons there may be a diff:
         1) Most likely, you may have stale violations, meaning there are old violations that no longer apply.
         2) You may have some sort of auto-formatter set up somewhere (e.g. something that reformats YML files) that is, for example, changing double quotes to single quotes. Ensure this is turned off for these auto-generated files.
-        3) You may have edited these files manually. It's recommended to use the `bin/packwerk update-deprecations` command to make changes to `deprecated_references.yml` files.
+        3) You may have edited these files manually. It's recommended to use the `bin/packwerk update-todo` command to make changes to `package_todo.yml` files.
 
-        In all cases, you can run `bin/packwerk update-deprecations` to update these files.
+        In all cases, you can run `bin/packwerk update-todo` to update these files.
 
-        Here is the diff generated after running `update-deprecations`:
+        Here is the diff generated after running `update-todo`:
         ```
         #{diff}
         ```
@@ -276,7 +276,7 @@ module UsePacks
       OUTPUT
 
       puts output
-      UsePacks.config.on_deprecated_references_lint_failure.call(output)
+      UsePacks.config.on_package_todo_lint_failure.call(output)
 
       exit 1
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packs
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-13 00:00:00.000000000 Z
+date: 2022-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.2.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parse_packwerk
   requirement: !ruby/object:Gem::Requirement
@@ -313,7 +313,7 @@ files:
 - lib/use_packs/private/interactive_cli/use_cases/query.rb
 - lib/use_packs/private/interactive_cli/use_cases/regenerate_rubocop_todo.rb
 - lib/use_packs/private/interactive_cli/use_cases/rename.rb
-- lib/use_packs/private/interactive_cli/use_cases/update_deprecations.rb
+- lib/use_packs/private/interactive_cli/use_cases/update_todo.rb
 - lib/use_packs/private/interactive_cli/use_cases/validate.rb
 - lib/use_packs/private/interactive_cli/use_cases/visualize.rb
 - lib/use_packs/private/pack_relationship_analyzer.rb