Implement packwerk show-offenses command

Shopify · Mar 30, 2023 · 0962193 · 0962193
1 parent d8ca547
commit 0962193
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/lib/packwerk/cli.rb b/lib/packwerk/cli.rb
@@ -57,6 +57,8 @@ def execute_command(args)
         output_result(parse_run(args).check)
       when "update-todo", "update"
         output_result(parse_run(args).update_todo)
+      when "show-offenses", "show"
+        output_result(parse_run(args).show_offenses)
       when "validate"
         validate(args)
       when "version"
@@ -118,6 +120,7 @@ def usage
         Subcommands:
           init - set up packwerk
           check - run all checks
+          show-offenses - displays all offenses
           update-todo - update package_todo.yml files
           validate - verify integrity of packwerk and package configuration
           version - output packwerk version

diff --git a/lib/packwerk/parse_run.rb b/lib/packwerk/parse_run.rb
@@ -60,6 +60,16 @@ def update_todo
       Cli::Result.new(message: message, status: offense_collection.errors.empty?)
     end
 
+    sig { returns(Cli::Result) }
+    def show_offenses
+      run_context = RunContext.from_configuration(@configuration)
+      all_offenses = find_offenses(run_context)
+
+      message = @offenses_formatter.show_offenses(all_offenses)
+
+      Cli::Result.new(message: message, status: true)
+    end
+
     sig { returns(Cli::Result) }
     def check
       run_context = RunContext.from_configuration(@configuration)