From 891402bbf90491ec5fa3055f8d64997d743c075d Mon Sep 17 00:00:00 2001 From: Brandon Patram Date: Tue, 19 Jul 2022 17:27:45 -0400 Subject: [PATCH] Update readme CLI examples ## Changes - Corrects CLI examples in readme to use `use_packwerk` commands --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5d6cde6..f3599af 100644 --- a/README.md +++ b/README.md @@ -7,23 +7,23 @@ UsePackwerk is a gem that helps in creating and maintaining packs. It exists to `bin/use_packwerk --help` ### Pack Creation -`bin/create_pack -n packs/your_pack_name_here` +`bin/use_packwerk create packs/your_pack_name_here` ### Moving files to packs -`bin/move_to_pack -n packs/your_pack_name_here -f path/to/file.rb,path/to/directory` +`bin/use_packwerk 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/make_public -f path/to/file.rb,path/to/directory` +`bin/use_packwerk 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/list_top_privacy_violations -n packs/my_pack` +`bin/use_packwerk 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/list_top_dependency_violations -n packs/my_pack` +`bin/use_packwerk 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/add_pack_dependency -n packs/my_pack -d packs/dependency_pack_name` +`bin/use_packwerk add_pack_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.