use_packwerk 0.64.0 → 0.65.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6ef7e8cd0b3253daba5690f8c80ad930f5b5fd609bb18bd8760275d64717745
-  data.tar.gz: 946a5ac17ac9316d6ce4fff47c77e53f228bc94ce95b251813fb00a859e1522e
+  metadata.gz: '09fba875e35dbc9bec54523ce0d6b778624029daa850c4daf2320dc753064205'
+  data.tar.gz: f56b46f76d3111e04f1a09f642843fd48be5a656c336366ecfe2db796f26f0ff
 SHA512:
-  metadata.gz: 25b021c870b03ab4ac3086d7620aa773490d1332c49a76e76ccea8f9605c9fc62687b86819bdd7175527dca69bb865374ed7149e3d1af2db3ca89dd434d75e6f
-  data.tar.gz: c28a6bf619db1a741716de8cfe93e0d634a8c8017e2ea74af3c2e4698b1a6b58de57e6a4b6c378c2dd1e16075e30b28d9dc9ec4b92e575faa8a5bba70cd2bb43
+  metadata.gz: e39623119c6f9f1507ebb1a1f7ef7a5eb979ce10af57ee86ac517d74a46f0f96560b333688948a88cac0ac0fcedd43711fdd07f23490de20ea324da924b3a786
+  data.tar.gz: aa492df65946f5d872a28c2328d609a4873c0c6c0183dd0d730de657ca42215d1a7be78e298ac8ca040bbef5432e8d5ce16dc8631364df153dbf8006178dc569

data/README.md

@@ -4,26 +4,26 @@ UsePackwerk is a gem that helps in creating and maintaining packs. It exists to
 
 ## Usage
 ### General Help
-`bin/use_packwerk --help`
+`bin/packs --help` or just `bin/packs` to enter interactive mode.
 
 ### Pack Creation
-`bin/use_packwerk create packs/your_pack_name_here`
+`bin/packs create packs/your_pack_name_here`
 
 ### Moving files to packs
-`bin/use_packwerk move packs/your_pack_name_here path/to/file.rb path/to/directory`
+`bin/packs move packs/your_pack_name_here path/to/file.rb path/to/directory`
 This is used for moving files into a pack (the pack must already exist).
 Note this works for moving files to packs from the monolith or from other packs
 
 Make sure there are no spaces between the comma-separated list of paths of directories.
 
 ### Moving a file to public API
-`bin/use_packwerk make_public path/to/file.rb,path/to/directory`
+`bin/packs make_public path/to/file.rb,path/to/directory`
 This moves a file or directory to public API (that is -- the `app/public` folder).
 
 Make sure there are no spaces between the comma-separated list of paths of directories.
 
 ### Listing top privacy violations
-`bin/use_packwerk list_top_privacy_violations packs/my_pack`
+`bin/packs list_top_privacy_violations packs/my_pack`
 Want to create interfaces? Not sure how your pack's code is being used?
 
 You can use this command to list the top privacy violations.
@@ -31,7 +31,7 @@ You can use this command to list the top privacy violations.
 If no pack name is passed in, this will list out violations across all packs.
 
 ### Listing top dependency violations
-`bin/use_packwerk list_top_dependency_violations packs/my_pack`
+`bin/packs list_top_dependency_violations packs/my_pack`
 Want to see who is depending on you? Not sure how your pack's code is being used in an unstated way
 
 You can use this command to list the top dependency violations.
@@ -39,7 +39,7 @@ You can use this command to list the top dependency violations.
 If no pack name is passed in, this will list out violations across all packs.
 
 ### Adding a dependency
-`bin/use_packwerk add_dependency packs/my_pack packs/dependency_pack_name`
+`bin/packs add_dependency packs/my_pack packs/dependency_pack_name`
 
 This can be used to quickly modify a `package.yml` file and add a dependency. It also cleans up the list of dependencies to sort the list and remove redundant entries.
 

data/bin/packs

@@ -2,4 +2,9 @@
 # typed: strict
 
 require_relative '../lib/use_packwerk'
-UsePackwerk.start_interactive_mode!
+
+if ARGV.empty?
+  UsePackwerk.start_interactive_mode!
+else
+  UsePackwerk::CLI.start(ARGV)
+end

data/lib/use_packwerk/cli.rb

@@ -16,7 +16,7 @@ module UsePackwerk
     long_desc <<~LONG_DESC
       Use this to add a dependency between packs.
 
-      When you use bin/use_packwerk add_dependency packs/from_pack packs/to_pack, this command will
+      When you use bin/packs add_dependency packs/from_pack packs/to_pack, this command will
       modify packs/from_pack/package.yml's list of dependencies and add packs/to_pack.
 
       This command will also sort the list and make it unique.

data/lib/use_packwerk/private/interactive_cli.rb

@@ -25,9 +25,9 @@ module UsePackwerk
     module InteractiveCli
       extend T::Sig
 
-      sig { void }
-      def self.start!
-        prompt = TTY::Prompt.new(interrupt: lambda {
+      sig { params(prompt: T.nilable(TTY::Prompt)).void }
+      def self.start!(prompt: nil)
+        prompt ||= TTY::Prompt.new(interrupt: lambda {
                                               puts "\n\nGoodbye! I hope you have a good day."
                                               exit 1 })
         help_text = '(Press ↑/↓ arrow to move, Enter to select and letters to filter)'

data/lib/use_packwerk/user_event_logger.rb

@@ -19,13 +19,13 @@ module UsePackwerk
       <<~MSG
         Your next steps might be:
 
-        1) Move files into your pack with `bin/use_packwerk move #{pack_name} path/to/file.rb`
+        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.
 
         3) Update TODO lists for rubocop implemented protections. See #{documentation_link} for more info
 
-        4) Expose public API in #{pack_name}/app/public. Try `bin/use_packwerk make_public #{pack_name}/path/to/file.rb`
+        4) Expose public API in #{pack_name}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
 
         5) Update your readme at #{pack_name}/README.md
       MSG
@@ -49,7 +49,7 @@ module UsePackwerk
 
         3) Touch base with each team who owns files involved in this move
 
-        4) Expose public API in #{pack_name}/app/public. Try `bin/use_packwerk make_public #{pack_name}/path/to/file.rb`
+        4) Expose public API in #{pack_name}/app/public. Try `bin/packs make_public #{pack_name}/path/to/file.rb`
 
         5) Update your readme at #{pack_name}/README.md
       MSG
@@ -125,10 +125,10 @@ module UsePackwerk
         You can prevent other packs from using private API by using packwerk.
 
         Want to find how your private API is being used today?
-        Try running: `bin/use_packwerk list_top_privacy_violations #{pack_name}`
+        Try running: `bin/packs list_top_privacy_violations #{pack_name}`
 
         Want to move something into this folder?
-        Try running: `bin/use_packwerk make_public #{pack_name}/path/to/file.rb`
+        Try running: `bin/packs make_public #{pack_name}/path/to/file.rb`
 
         One more thing -- feel free to delete this file and replace it with a README.md describing your package in the main package directory.
 
@@ -170,7 +170,7 @@ module UsePackwerk
       else
         pack_specific_content = <<~PACK_CONTENT
           You are listing top #{limit} dependency violations for #{pack_name}. See #{documentation_link} for other utilities!
-          Pass in a limit to display more or less, e.g. `bin/use_packwerk list_top_dependency_violations #{pack_name} -l 1000`
+          Pass in a limit to display more or less, e.g. `bin/packs list_top_dependency_violations #{pack_name} -l 1000`
 
           This script is intended to help you find which of YOUR pack's private classes, constants, or modules other packs are using the most.
           Anything not in #{pack_name}/app/public is considered private API.
@@ -211,7 +211,7 @@ module UsePackwerk
       if pack_name.nil?
         pack_specific_content = <<~PACK_CONTENT
           You are listing top #{limit} privacy violations for all packs. See #{documentation_link} for other utilities!
-          Pass in a limit to display more or less, e.g. `bin/use_packwerk list_top_privacy_violations #{pack_name} -l 1000`
+          Pass in a limit to display more or less, e.g. `bin/packs list_top_privacy_violations #{pack_name} -l 1000`
 
           This script is intended to help you find which of YOUR pack's private classes, constants, or modules other packs are using the most.
           Anything not in pack_name/app/public is considered private API.
@@ -219,7 +219,7 @@ module UsePackwerk
       else
         pack_specific_content = <<~PACK_CONTENT
           You are listing top #{limit} privacy violations for #{pack_name}. See #{documentation_link} for other utilities!
-          Pass in a limit to display more or less, e.g. `bin/use_packwerk list_top_privacy_violations #{pack_name} -l 1000`
+          Pass in a limit to display more or less, e.g. `bin/packs list_top_privacy_violations #{pack_name} -l 1000`
 
           This script is intended to help you find which of YOUR pack's private classes, constants, or modules other packs are using the most.
           Anything not in #{pack_name}/app/public is considered private API.
@@ -253,7 +253,7 @@ module UsePackwerk
             - packs/other_pack_a: 1
             - packs/other_pack_b: 1
 
-        Lastly, remember you can use `bin/use_packwerk make_public #{pack_name}/path/to/file.rb` to make your class, constant, or module public API.
+        Lastly, remember you can use `bin/packs make_public #{pack_name}/path/to/file.rb` to make your class, constant, or module public API.
       MSG
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: use_packwerk
 version: !ruby/object:Gem::Version
-  version: 0.64.0
+  version: 0.65.0
 platform: ruby
 authors:
 - Gusto Engineers
@@ -281,7 +281,6 @@ description: UsePackwerk is a gem that helps in creating and maintaining packwer
 email:
 - dev@gusto.com
 executables:
-- use_packwerk
 - packs
 extensions: []
 extra_rdoc_files: []
@@ -290,7 +289,6 @@ files:
 - bin/packs
 - bin/rubocop
 - bin/tapioca
-- bin/use_packwerk
 - lib/use_packwerk.rb
 - lib/use_packwerk/cli.rb
 - lib/use_packwerk/code_ownership_post_processor.rb

data/bin/use_packwerk

@@ -1,5 +0,0 @@
-#!/usr/bin/env ruby
-# typed: strict
-
-require_relative '../lib/use_packwerk'
-UsePackwerk::CLI.start(ARGV)