use_packs 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5450c6c78c1c7257449c5b3e9cd7e9301be0642af31a9324051cfd97cea5045f
-  data.tar.gz: 13028e1163d760e183bff5d9840b11e1148ca9718900652fe9a4246ae040ad23
+  metadata.gz: 5086342ae2e0f40560917b22f01788921a3c64827d4019d1d7fa79d03fc9746e
+  data.tar.gz: 219e6c64145ee4f65e8604f80043ce43290c61e80aabcfd934b2bccb34d4febd
 SHA512:
-  metadata.gz: cf4115115841e5242ca58aafbf105e6c0cd35acf1e945a20f67b71e8163866705e03ac58ae9a0dfe412342b95b1e7ffe60e9662e61a1ef0f3aa7e182e0b8bf8a
-  data.tar.gz: 9ae241757c61197ccda052f06263180ece2e907680125e69405a533d0063875eb43217ee078f22654f43e1a98c558db6ed29c0477964197946482b4bc417b16b
+  metadata.gz: 7d5d2757dff4b7e81f9331a2f9dec3dfdd0c76a3d361d632e00ea9aa5525c1b6ae584a89c4f92d06150317edae91282236d823600f5fbdfb86ee8d26dae5b872
+  data.tar.gz: 2c62f8458b6442754b273c241a107494657c7ef807ffa73fc4a42e9e5a4c9aa4cbf68036cf5407eeb1cd4d3223a13f7782fb2999b76fcde7131402adb7f68679

data/README.md

@@ -5,47 +5,88 @@ UsePacks is a gem that helps in creating and maintaining packs. It exists to hel
 ## Usage
 Make sure to run `bundle binstub use_packs` to generate `bin/packs` within your application.
 
-### General Help
-`bin/packs --help` or just `bin/packs` to enter interactive mode.
+## CLI Documentation
+## Describe available commands or one specific command
+`bin/packs help [COMMAND]`
 
-### Pack Creation
-`bin/packs create packs/your_pack_name_here`
+## Create pack with name packs/your_pack
+`bin/packs create packs/your_pack`
 
-### Moving files to packs
-`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
+## Add packs/to_pack to packs/from_pack/package.yml list of dependencies
+`bin/packs add_dependency packs/from_pack packs/to_pack`
 
-Make sure there are no spaces between the comma-separated list of paths of directories.
+Use this to add a dependency between packs.
 
-### Moving a file to public API
-`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).
+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.
 
-Make sure there are no spaces between the comma-separated list of paths of directories.
+This command will also sort the list and make it unique.
+
+## List the top dependency violations of packs/your_pack
+`bin/packs list_top_dependency_violations packs/your_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.
+
+If no pack name is passed in, this will list out violations across all packs.
+
+## List the top privacy violations of packs/your_pack
+`bin/packs list_top_privacy_violations packs/your_pack`
 
-### Listing top privacy violations
-`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.
 
 If no pack name is passed in, this will list out violations across all packs.
 
-### Listing top dependency violations
-`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
+## Make files or directories public API
+`bin/packs make_public path/to/file.rb path/to/directory`
 
-You can use this command to list the top dependency violations.
+This moves a file or directory to public API (that is -- the `app/public` folder).
 
-If no pack name is passed in, this will list out violations across all packs.
+Make sure there are no spaces between the comma-separated list of paths of directories.
+
+## Move files or directories from one pack to another
+`bin/packs move packs/destination_pack 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.
+
+## Lint `package_todo.yml` files to check for formatting issues
+`bin/packs lint_package_todo_yml_files`
+
+## Lint `package.yml` files
+`bin/packs lint_package_yml_files [ packs/my_pack packs/my_other_pack ]`
+
+## Run bin/packwerk validate (detects cycles)
+`bin/packs validate`
+
+## Run bin/packwerk check
+`bin/packs check [ packs/my_pack ]`
+
+## Run bin/packwerk update-todo
+`bin/packs update`
+
+## Regenerate packs/*/package_rubocop_todo.yml for one or more packs
+`bin/packs regenerate_rubocop_todo [ packs/my_pack packs/my_other_pack ]`
+
+## Get info about size and violations for packs
+`bin/packs get_info [ packs/my_pack packs/my_other_pack ]`
+
+## Visualize packs
+`bin/packs visualize [ packs/my_pack packs/my_other_pack ]`
+
+## Rename a pack
+`bin/packs rename`
 
-### Adding a dependency
-`bin/packs add_dependency packs/my_pack packs/dependency_pack_name`
+## Set packs/child_pack as a child of packs/parent_pack
+`bin/packs move_to_parent packs/child_pack packs/parent_pack `
 
-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.
 
-### Releasing
+## Releasing
 Releases happen automatically through github actions once a version update is committed to `main`.
 
 ## Discussions, Issues, Questions, and More

data/lib/use_packs/cli.rb

@@ -30,6 +30,13 @@ module UsePacks
     end
 
     desc 'list_top_dependency_violations packs/your_pack', 'List the top dependency violations of packs/your_pack'
+    long_desc <<~LONG_DESC
+      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.
+
+      If no pack name is passed in, this will list out violations across all packs.
+    LONG_DESC
     option :limit, type: :numeric, default: 10, aliases: :l, banner: 'Specify the limit of constants to analyze'
     sig { params(pack_name: String).void }
     def list_top_dependency_violations(pack_name)
@@ -40,6 +47,13 @@ module UsePacks
     end
 
     desc 'list_top_privacy_violations packs/your_pack', 'List the top privacy violations of packs/your_pack'
+    long_desc <<~LONG_DESC
+      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.
+
+      If no pack name is passed in, this will list out violations across all packs.
+    LONG_DESC
     option :limit, type: :numeric, default: 10, aliases: :l, banner: 'Specify the limit of constants to analyze'
     sig { params(pack_name: String).void }
     def list_top_privacy_violations(pack_name)
@@ -49,7 +63,12 @@ module UsePacks
       )
     end
 
-    desc 'make_public path/to/file.rb path/to/directory', 'Pass in a space-separated list of file or directory paths to make public'
+    desc 'make_public path/to/file.rb path/to/directory', 'Make files or directories public API'
+    long_desc <<~LONG_DESC
+      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.
+    LONG_DESC
     sig { params(paths: String).void }
     def make_public(*paths)
       UsePacks.make_public!(
@@ -58,7 +77,13 @@ module UsePacks
       )
     end
 
-    desc 'move packs/destination_pack path/to/file.rb path/to/directory', 'Pass in a destination pack and a space-separated list of file or directory paths to move to the destination pack'
+    desc 'move packs/destination_pack path/to/file.rb path/to/directory', 'Move files or directories from one pack to another'
+    long_desc <<~LONG_DESC
+      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.
+    LONG_DESC
     sig { params(pack_name: String, paths: String).void }
     def move(pack_name, *paths)
       UsePacks.move_to_pack!(
@@ -68,7 +93,7 @@ module UsePacks
       )
     end
 
-    desc 'lint_package_todo_yml_files', 'Ensures `package_todo.yml` files are up to date'
+    desc 'lint_package_todo_yml_files', 'Lint `package_todo.yml` files to check for formatting issues'
     sig { void }
     def lint_package_todo_yml_files
       UsePacks.lint_package_todo_yml_files!
@@ -122,7 +147,7 @@ module UsePacks
       puts Private.rename_pack
     end
 
-    desc 'move_to_parent packs/child_pack packs/parent_pack ', 'Sets packs/child_pack as a child of packs/parent_pack'
+    desc 'move_to_parent packs/child_pack packs/parent_pack ', 'Set packs/child_pack as a child of packs/parent_pack'
     sig { params(child_pack_name: String, parent_pack_name: String).void }
     def move_to_parent(child_pack_name, parent_pack_name)
       UsePacks.move_to_parent!(

data/lib/use_packs/private.rb

@@ -324,7 +324,9 @@ module UsePacks
       elsif !origin.exist? && destination.exist?
         Logging.print ColorizedString.new("[SKIP] Not moving #{origin}, does not exist, (#{destination} already exists)").red
       else
-        Logging.print ColorizedString.new("[SKIP] Not moving #{origin}, does not exist").red
+        # We could choose to print this in a `--verbose` mode. For now, we find that printing this text in red confuses folks more than it informs them.
+        # This is because it's perfectly common for a spec to not exist for a file, so at best it's a warning.
+        # Logging.print ColorizedString.new("[SKIP] Not moving #{origin}, does not exist").red
       end
     end
 
@@ -529,7 +531,7 @@ module UsePacks
 
       if diff == ''
         # No diff generated by `update-todo`
-        exit 0
+        safe_exit 0
       else
         output = <<~OUTPUT
           All `package_todo.yml` files must be up-to-date and that no diff is generated when running `bin/packwerk update-todo`.
@@ -551,8 +553,7 @@ module UsePacks
 
         puts output
         UsePacks.config.on_package_todo_lint_failure.call(output)
-
-        exit 1
+        safe_exit 1
       end
     end
 
@@ -577,6 +578,12 @@ module UsePacks
         5. Please let us know if anything is missing.
       WARNING
     end
+
+    # This function exists to give us something to stub in test
+    sig { params(code: Integer).void }
+    def self.safe_exit(code)
+      exit code
+    end
   end
 
   private_constant :Private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: use_packs
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.17
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-17 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: code_ownership