From 191b58ed3e9105e74641017dd78ef66d80ac65da Mon Sep 17 00:00:00 2001 From: Tim_Jones Date: Thu, 7 Mar 2024 13:54:32 -0500 Subject: [PATCH] Custom offenses formatter docs fix --- USAGE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/USAGE.md b/USAGE.md index 10f9a95a4..493d6cd2a 100644 --- a/USAGE.md +++ b/USAGE.md @@ -264,7 +264,7 @@ You can also reference the name of a gem. While `packwerk` ships with its own offense formatter, you may specify a custom one in your configuration file via the `offenses_formatter:` key. Your custom formatter will be used when `bin/packwerk check` is run. -Firstly, you'll need to create an `OffensesFormatter` class that includes `Packwerk::OffensesFormatter`. You can use [`Packwerk::Formatters::OffensesFormatter`](lib/packwerk/formatters/offenses_formatter.rb) as a point of reference for this. Then, in the `require` directive described above, you'll want to tell `packwerk` about it: +Firstly, you'll need to create an `OffensesFormatter` class that includes `Packwerk::OffensesFormatter`. You can use [`Packwerk::Formatters::DefaultOffensesFormatter`](lib/packwerk/formatters/default_offenses_formatter.rb) as a point of reference for this. Then, in the `require` directive described above, you'll want to tell `packwerk` about it: ```ruby # ./path/to/file.rb class MyOffensesFormatter