Skip to content

Commit 3f208c1

Browse files
authored
Add instructions for how to use additional violation types to the README (#58)
1 parent 50a3ca7 commit 3f208c1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,18 @@ packwerk.check(
9191
)
9292
```
9393

94+
### Supporting new violation types
95+
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`:
96+
```ruby
97+
packwerk.check(
98+
violation_types: %w[dependency privacy layer]
99+
)
100+
```
101+
102+
Any violations not included in this list will be ignored.
103+
104+
You will also most likely want to customize the offenses formatter and provide specific feedback for the new violation types.
105+
94106
## package_todo_yml_changes.check
95107
![This is an image displaying an inline comment from the Danger github bot.](docs/update.png)
96108

0 commit comments

Comments
 (0)