Skip to content

Update readme CLI examples #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
bpatram wants to merge 1 commit into from
Closed

Update readme CLI examples #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,39 @@ 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.

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.

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.

Expand Down