Skip to content

Add instructions for how to use additional violation types #58

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

Merged
hellosweta merged 1 commit into from
Jul 8, 2025
Merged

Add instructions for how to use additional violation types #58

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: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,18 @@ packwerk.check(
)
```

### Supporting new violation types
By default, only `dependency` and `privacy` violation types are supported. If you wish to use other violation types you'll need to provide them when calling `check`:
```ruby
packwerk.check(
violation_types: %w[dependency privacy layer]
)
```

Any violations not included in this list will be ignored.

You will also most likely want to customize the offenses formatter and provide specific feedback for the new violation types.

## package_todo_yml_changes.check
![This is an image displaying an inline comment from the Danger github bot.](docs/update.png)

Expand Down