packwerk 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11206a06e6ac99c1fb8ef4cdefbe334133317d0599fce6480d4dfe10f694c747
-  data.tar.gz: 606778530b8a872d331e5f331b9c6e14cb37ff6e0a5e13247bb0aebe1ca9e0cc
+  metadata.gz: d72fbde4259baa5a5e7f8bc2ca4406d9bc6a835051efafefc23ef6ef3ae13f32
+  data.tar.gz: 65bff304e2be348e16800b0d4f65ab33a1b5fb84ab15ba495e03904d099be4a0
 SHA512:
-  metadata.gz: 66166a9c683483fda99341adc79c807c40f8190c349c8650b8646810e06d11f9b4728e2e938ef0abf640967d0764d78b66e956aba3bdaef830c4a15253711542
-  data.tar.gz: c1cce5df16246f1561cd0954abca4685e21adcaf52d3f6d164acd776f9466a0ad276a65b9a2f5cc9e358b058fcdc2cef265c2b3948043f9f3e35b1d4798ec5e9
+  metadata.gz: e25488e4af51932d503d4120e458fe92bc4ae2945ca8009219e01f4f2e7756e0430a0d9a6176f01d864d55644f262a06fb88494234b43aae43ba254437d7fb49
+  data.tar.gz: 2c821f3e11a16c52d84f7f4e68f01e788e95d5723fd77305f69e15aba07f5f1f81ea43e9c60b6c00ca4503df036eb2b3ea0e0ae1378f0c584d7252614064f9d9

data/.github/workflows/ci.yml

@@ -1,6 +1,11 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - main
+      - '*-stable'
+  pull_request:
 
 jobs:
   tests:
@@ -12,10 +17,10 @@ jobs:
           - gemfiles/Gemfile-rails-6-0
           - gemfiles/Gemfile-rails-6-1
         ruby:
-          - 2.7
-          - 3.0
-          - 3.1
-          - 3.2
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
     env:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
     name: "Tests: Ruby ${{ matrix.ruby }} ${{ matrix.gemfile }}"
@@ -27,7 +32,30 @@ jobs:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - name: Run tests
-        run: bin/rake
+        run: bin/rake test
+  loading-tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gemfile:
+          - Gemfile
+        ruby:
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    name: "Loading Tests: Ruby ${{ matrix.ruby }} ${{ matrix.gemfile }}"
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bin/rake test:loading
   lint:
     runs-on: ubuntu-latest
     name: Lint
@@ -36,7 +64,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: "3.1"
           bundler-cache: true
       - name: Run style checks
         run: bin/rubocop
@@ -48,7 +76,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1
+          ruby-version: "3.1"
           # bundler-cache: true
       - name: Run static type checks
         run: |

data/.ruby-version

@@ -1 +1 @@
-3.2.1
+3.2.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    packwerk (3.0.0)
+    packwerk (3.1.0)
       activesupport (>= 6.0)
       ast
       better_html
@@ -60,23 +60,27 @@ GEM
       method_source (>= 0.6.7)
       rake (>= 0.9.2.2)
     method_source (1.0.0)
-    mini_portile2 (2.8.0)
+    mini_portile2 (2.8.4)
     minitest (5.16.2)
     minitest-focus (1.3.1)
       minitest (>= 4, < 6)
     mocha (1.14.0)
     netrc (0.11.0)
-    nokogiri (1.13.8)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.15.3)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.15.3-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.15.3-x86_64-linux)
       racc (~> 1.4)
     parallel (1.22.1)
-    parser (3.1.2.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     prettier_print (0.1.0)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.6.0)
+    racc (1.7.1)
     rack (2.2.4)
     rack-test (2.0.2)
       rack (>= 1.3)
@@ -178,6 +182,7 @@ PLATFORMS
   ruby
   x86_64-darwin
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   byebug
@@ -198,4 +203,4 @@ DEPENDENCIES
   zeitwerk
 
 BUNDLED WITH
-   2.4.7
+   2.4.8

data/README.md

@@ -58,10 +58,12 @@ Read [USAGE.md](USAGE.md) for usage once Packwerk is installed on your project.
 Various third parties have built tooling on top of packwerk. Here's a selection of some that might prove useful:
 
 - https://github.com/bellroy/graphwerk draws a graph of your package dependencies
-- https://github.com/Gusto/packwerk-vscode integrates packwerk into Visual Studio Code so you can see violations right in your editor
-- https://github.com/Gusto/stimpack sets up Rails autoloading, as well as `rspec` and `FactoryBot` integration, for packages arranged in a flat list. Stimpack is quite convenient, but for autoloading we recommend to use `Rails::Engine`s instead.
+- https://github.com/rubyatscale/packwerk-vscode integrates packwerk into Visual Studio Code so you can see violations right in your editor
+- https://github.com/vinted/packwerk-intellij integrates packwerk into RubyMine so you can see violations right in your editor
+- https://github.com/rubyatscale/packs-rails sets up Rails autoloading, as well as `rspec` and `FactoryBot` integration, for packages arranged in a flat list. packs-rails is quite convenient, but for autoloading we recommend to use `Rails::Engine`s instead.
 - https://github.com/rubyatscale/danger-packwerk integrates packwerk with [danger.systems](https://danger.systems) to provide packwerk feedback as Github inline PR comments
 - https://github.com/rubyatscale/packwerk-extensions contains extensions for packwerk, including a checker for packwerk that allows you to enforce public API boundaries. This was originally extracted from `packwerk` itself.
+- https://github.com/alexevanczuk/packs is a Rust implementation of packwerk that has experimental support for non-Rails, non-Zeitwerk applications.
 
 ## Development
 

data/RESOLVING_VIOLATIONS.md

@@ -3,7 +3,7 @@
 Violations can be [recorded as a deprecation](#recording-violations) or (better!) [eliminated](#eliminating-violations).
 
 ## Recording Violations
-💡 New privacy and dependency violations are never hard-blocked. There are many very valid reasons to run `bin/packwerk update-todo`, adding new violations to `package_todo.yml` files. Even if you feel your reason might not be "valid," if your judgement says adding the violation and shipping your change will produce positive impact, trust your gut.
+💡 New dependency violations are never hard-blocked. There are many very valid reasons to run `bin/packwerk update-todo`, adding new violations to `package_todo.yml` files. Even if you feel your reason might not be "valid," if your judgement says adding the violation and shipping your change will produce positive impact, trust your gut.
 
 ### Emergency Fixes
 ❔ Is it a revert or is there a lot of urgency because you are fixing a production bug impacting customers?
@@ -31,7 +31,7 @@ Violations can be [recorded as a deprecation](#recording-violations) or (better!
 ➡️ Stay strong. Eliminate the violation. It is important to build a sustainable business that optimizes for the long-term. Look for advocates such as from mentors or within your team who can help you justify improving system design.
 
 ## Eliminating Violations
-💡 Dependency and privacy violations are Packwerk's signal that what we've stated about the desired system design (what
+💡 Dependency violations are Packwerk's signal that what we've stated about the desired system design (what
 packages exist and what lives in them, the dependencies in a package.yml, and the public interface in the package's public folder) doesn't match the reality of our system.
 If what we've stated about our system design doesn't feel right, then the violations won't make sense either! Make sure to think through system design before addressing a violation.
 
@@ -40,12 +40,7 @@ If what we've stated about our system design doesn't feel right, then the violat
 
 If not, find a better place for it to live.
 
-Otherwise, follow the guide for eliminating [Privacy Violations](#privacy-violations) or [Dependency Violations](#dependency-violations).
-
-### Privacy Violations
-💡  Packwerk thinks something is a privacy violation if you're referencing a constant, class, or module defined in the private implementation (i.e. not the public folder) of another package. We care about these because we want to make sure we only use parts of a package that have been exposed as public API.
-
-An explicit and implementation-hiding public API is a cornerstone of well-modularized code.
+Otherwise, follow the guide for eliminating [Dependency Violations](#dependency-violations).
 
 #### Use Existing Public Interface
 ❔ Does the package you're using expose public API in its public folder that supports your use case?

data/Rakefile

@@ -6,7 +6,16 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList["test/**/*_test.rb"].reject do |file|
+    file.include?("test/loading/")
+  end
+  t.warning = false
+end
+
+Rake::TestTask.new("test:loading") do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/loading/**/*_test.rb"]
   t.warning = false
 end
 

data/TROUBLESHOOT.md

@@ -14,9 +14,8 @@ You can specify folders or packages in Packwerk commands for a shorter run time:
 
      bin/packwerk check components/your_package
 
-     bin/packwerk update-todo components/your_package
-
-_Note: You cannot specify folders or packages for `bin/packwerk validate` because the command runs for the entire application._
+_Note: You cannot specify folders or packages for `bin/packwerk validate` and `bin/packwerk update-todo` because the 
+command runs for the entire application._
 
 ![](static/packwerk_check_violation.gif)
 

data/UPGRADING.md

@@ -1,3 +1,15 @@
+# Upgrading from 2.x to 3.0
+
+In Packwerk 3.0, we've made two notable changes:
+
+## Renaming deprecated_references to package_todo
+
+The `update-deprecations` subcommand has been renamed to `update-todo`. Old `deprecated_references.yml` files will be automatically deleted and replaced with `package_todo.yml` files when you run `update-todo`. This behaviour has been in Packwerk [since 2.3.0](https://github.com/Shopify/packwerk/releases/tag/v2.3.0), and automatic deletion will be removed in the next release.
+
+### Removal of privacy checking
+
+Privacy checking via `enforce_privacy` has been removed. Developers are encouraged to focus on leveraging Packwerk for dependency checking. For those who still need privacy checks, please use [Gusto's extension gem](https://github.com/rubyatscale/packwerk-extensions).
+
 # Upgrading from 1.x to 2.0
 
 With Packwerk 2.0, we made a few changes to simplify the setup. Updating will require removing some previously necessary files and configuration.

data/USAGE.md

@@ -144,7 +144,7 @@ Example:
 
 ## Types of boundary checks
 
-Packwerk ships with dependency boundary checking only. See [`packwerk-extensions`](https://github.com/rubyatscale/packwerk-extensions) to incorporate privacy checks into your use of `packwerk`.
+Packwerk ships with dependency boundary checking only. Other checking support may be added by extension gems.
 
 #### Enforcing dependency boundary
 
@@ -172,6 +172,8 @@ Then, when you run `bin/packwerk check`, new violations will cause the following
 packs/referencing_package cannot have dependency violations on packs/defining_package because strict mode is enabled for dependency violations in packs/referencing_package/package.yml
 ```
 
+Once the `strict` mode is enabled on a package, running `bin/packwerk update-todo` will not add new violations in the package_todo.yml file and the command will return an error.
+
 ## Checking for violations
 
 After enforcing the boundary checks for a package, you may execute:
@@ -188,6 +190,10 @@ You can also specify packages for a shorter run time. When checking against pack
 
     bin/packwerk check --packages=components/your_package,components/your_other_package
 
+Using the following command line option you can also enable or disable parallel processing. It is enabled by default.
+
+    bin/packwerk check --[no-]parallel
+
 ![](static/packwerk_check.gif)
 
 In order to keep the package system valid at each version of the application, we recommend running `bin/packwerk check` in your CI pipeline.
@@ -198,7 +204,7 @@ See: [TROUBLESHOOT.md - Sample violations](TROUBLESHOOT.md#Sample-violations)
 
 ### Understanding how to respond to new violations
 
-When you have a new dependency or privacy violation, what do you do?
+When you have a new dependency violation, what do you do?
 
 See: [RESOLVING_VIOLATIONS.md](RESOLVING_VIOLATIONS.md)
 
@@ -235,10 +241,10 @@ Above is an example of a constant violation entry in `package_todo.yml`.
 
 * `components/merchant` - package where the constant violation is found
 * `::Checkouts::Core::CheckoutId` - violated constant in question
-* `dependency` - type of violation, either dependency or privacy
+* `dependency` - type of violation, typically dependency
 * `components/merchant/app/public/merchant/generate_order.rb` - path to the file containing the violated constant
 
-Violations exist within the package that makes a violating reference. This means privacy violations of your package can be found listed in `package_todo.yml` files in the packages with the reference to a private constant.
+Violations exist within the package that makes a violating reference.
 
 # Loading Extensions
 
@@ -284,7 +290,7 @@ bin/packwerk check --offenses-formatter=my_offenses_formatter
 
 ### Custom Checkers
 
-Packwerk ships with a way to analyze dependencies and also supports custom checkers, such as the privacy checker listed below.
+Packwerk ships with a way to analyze dependencies and also supports custom checkers from extension gems.
 
 Custom checkers will allow references to constants to be analyzed in new ways, and for those invalid references to show up as violations in `package_todo.yml`.
 
@@ -327,14 +333,6 @@ require:
   - ./path/to/file.rb
 ```
 
-#### Privacy Checker
-
-[`packwerk-extensions`](https://github.com/rubyatscale/packwerk-extensions) (originally extracted from `packwerk`) can be used to help define and enforce public API boundaries of a package. See the README.md for more details. To use this, add it to your `Gemfile` and then require it via `packwerk.yml`:
-```yml
-require:
-  - packwerk-extensions
-```
-
 ### Custom Validators
 
 Similar to checkers, you can define your own validator to be executed when `bin/packwerk validate` is invoked. This can be used to support your custom checker (by specifying permitted keys) or to provide any other validations you want to impose on packages.

data/dev.yml

@@ -3,7 +3,7 @@ name: packwerk
 type: ruby
 
 up:
-  - ruby: 3.2.1
+  - ruby: 3.2.2
   - bundler
 
 commands:

data/exe/packwerk

@@ -1,7 +1,10 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "packwerk/disable_sorbet"
+unless defined?(Spring)
+  require "packwerk/disable_sorbet"
+end
+
 require "packwerk"
 
 # Needs to be run in test environment in order to have test helper paths available in the autoload paths

data/lib/packwerk/application_validator.rb

@@ -11,6 +11,9 @@ module Packwerk
   class ApplicationValidator
     include Validator
     extend T::Sig
+    extend ActiveSupport::Autoload
+
+    autoload :Helpers
 
     sig { params(package_set: PackageSet, configuration: Configuration).returns(Validator::Result) }
     def check_all(package_set, configuration)

data/lib/packwerk/checker.rb

@@ -13,14 +13,13 @@ module Packwerk
 
       sig { params(base: Class).void }
       def included(base)
-        @checkers ||= T.let(@checkers, T.nilable(T::Array[Class]))
-        @checkers ||= []
-        @checkers << base
+        checkers << base
       end
 
       sig { returns(T::Array[Checker]) }
       def all
-        T.unsafe(@checkers).map(&:new)
+        load_defaults
+        T.cast(checkers.map(&:new), T::Array[Checker])
       end
 
       sig { params(violation_type: String).returns(Checker) }
@@ -30,6 +29,16 @@ module Packwerk
 
       private
 
+      sig { void }
+      def load_defaults
+        require("packwerk/reference_checking/checkers/dependency_checker")
+      end
+
+      sig { returns(T::Array[Class]) }
+      def checkers
+        @checkers ||= T.let([], T.nilable(T::Array[Class]))
+      end
+
       sig { params(name: String).returns(Checker) }
       def checker_by_violation_type(name)
         @checker_by_violation_type ||= T.let(Checker.all.to_h do |checker|

data/lib/packwerk/cli.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "optparse"
-
 module Packwerk
   # A command-line interface to Packwerk.
   class Cli
@@ -46,184 +44,23 @@ module Packwerk
 
     sig { params(args: T::Array[String]).returns(T::Boolean) }
     def execute_command(args)
-      subcommand = args.shift
-      case subcommand
-      when "init"
-        init
-      when "check"
-        output_result(parse_run(args).check)
-      when "update-todo", "update"
-        output_result(parse_run(args).update_todo)
-      when "validate"
-        validate(args)
-      when "version"
-        @out.puts(Packwerk::VERSION)
-        true
-      when nil, "help"
-        usage
-      else
-        @err_out.puts(
-          "'#{subcommand}' is not a packwerk command. See `packwerk help`."
-        )
-        false
-      end
-    end
-
-    private
-
-    sig { returns(T::Boolean) }
-    def init
-      @out.puts("📦 Initializing Packwerk...")
-
-      generate_configs
-    end
-
-    sig { returns(T::Boolean) }
-    def generate_configs
-      configuration_file = Generators::ConfigurationFile.generate(
-        root: @configuration.root_path,
-        out: @out
-      )
-
-      root_package = Generators::RootPackage.generate(root: @configuration.root_path, out: @out)
-
-      success = configuration_file && root_package
-
-      result = if success
-        <<~EOS
-
-          🎉 Packwerk is ready to be used. You can start defining packages and run `bin/packwerk check`.
-          For more information on how to use Packwerk, see: https://github.com/Shopify/packwerk/blob/main/USAGE.md
-        EOS
-      else
-        <<~EOS
-
-          ⚠️  Packwerk is not ready to be used.
-          Please check output and refer to https://github.com/Shopify/packwerk/blob/main/USAGE.md for more information.
-        EOS
-      end
-
-      @out.puts(result)
-      success
-    end
-
-    sig { returns(T::Boolean) }
-    def usage
-      @err_out.puts(<<~USAGE)
-        Usage: #{$PROGRAM_NAME} <subcommand>
-
-        Subcommands:
-          init - set up packwerk
-          check - run all checks
-          update-todo - update package_todo.yml files
-          validate - verify integrity of packwerk and package configuration
-          version - output packwerk version
-          help  - display help information about packwerk
-      USAGE
-      true
-    end
-
-    sig { params(result: Result).returns(T::Boolean) }
-    def output_result(result)
-      @out.puts
-      @out.puts(result.message)
-      result.status
-    end
-
-    sig do
-      params(
-        relative_file_paths: T::Array[String],
-        ignore_nested_packages: T::Boolean
-      ).returns(FilesForProcessing)
-    end
-    def fetch_files_to_process(relative_file_paths, ignore_nested_packages)
-      files_for_processing = FilesForProcessing.fetch(
-        relative_file_paths: relative_file_paths,
-        ignore_nested_packages: ignore_nested_packages,
-        configuration: @configuration
-      )
-      @out.puts(<<~MSG.squish) if files_for_processing.files.empty?
-        No files found or given.
-        Specify files or check the include and exclude glob in the config file.
-      MSG
-
-      files_for_processing
-    end
-
-    sig { params(_paths: T::Array[String]).returns(T::Boolean) }
-    def validate(_paths)
-      result = T.let(nil, T.nilable(Validator::Result))
-
-      @progress_formatter.started_validation do
-        result = validator.check_all(package_set, @configuration)
-
-        list_validation_errors(result)
-      end
-
-      T.must(result).ok?
-    end
-
-    sig { returns(ApplicationValidator) }
-    def validator
-      ApplicationValidator.new
-    end
-
-    sig { returns(PackageSet) }
-    def package_set
-      PackageSet.load_all_from(
-        @configuration.root_path,
-        package_pathspec: @configuration.package_paths
-      )
-    end
-
-    sig { params(result: Validator::Result).void }
-    def list_validation_errors(result)
-      @out.puts
-      if result.ok?
-        @out.puts("Validation successful 🎉")
+      command = args.shift || "help"
+      command_class = Commands.for(command)
+
+      if command_class
+        command_class.new(
+          args,
+          configuration: @configuration,
+          out: @out,
+          err_out: @err_out,
+          progress_formatter: @progress_formatter,
+          offenses_formatter: @offenses_formatter,
+        ).run
       else
-        @out.puts("Validation failed ❗")
-        @out.puts
-        @out.puts(result.error_value)
-      end
-    end
-
-    sig { params(args: T::Array[String]).returns(ParseRun) }
-    def parse_run(args)
-      relative_file_paths = T.let([], T::Array[String])
-      ignore_nested_packages = nil
-      formatter = @offenses_formatter
+        @err_out.puts("'#{command}' is not a packwerk command. See `packwerk help`.",)
 
-      if args.any? { |arg| arg.include?("--packages") }
-        OptionParser.new do |parser|
-          parser.on("--packages=PACKAGESLIST", Array, "package names, comma separated") do |p|
-            relative_file_paths = p
-          end
-        end.parse!(args)
-        ignore_nested_packages = true
-      else
-        relative_file_paths = args
-        ignore_nested_packages = false
-      end
-
-      if args.any? { |arg| arg.include?("--offenses-formatter") }
-        OptionParser.new do |parser|
-          parser.on("--offenses-formatter=FORMATTER", String,
-            "identifier of offenses formatter to use") do |formatter_identifier|
-            formatter = OffensesFormatter.find(formatter_identifier)
-          end
-        end.parse!(args)
+        false
       end
-
-      files_for_processing = fetch_files_to_process(relative_file_paths, ignore_nested_packages)
-
-      ParseRun.new(
-        relative_file_set: files_for_processing.files,
-        file_set_specified: files_for_processing.files_specified?,
-        configuration: @configuration,
-        progress_formatter: @progress_formatter,
-        offenses_formatter: formatter
-      )
     end
   end
 end

data/lib/packwerk/commands/base_command.rb

@@ -0,0 +1,69 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Packwerk
+  module Commands
+    class BaseCommand
+      extend T::Sig
+      extend T::Helpers
+      abstract!
+
+      @description = T.let("", String)
+
+      class << self
+        extend T::Sig
+
+        sig { params(description: T.nilable(String)).returns(String) }
+        def description(description = nil)
+          if description
+            @description = description
+          else
+            @description
+          end
+        end
+      end
+
+      sig do
+        params(
+          args: T::Array[String],
+          configuration: Configuration,
+          out: T.any(StringIO, IO),
+          err_out: T.any(StringIO, IO),
+          progress_formatter: Formatters::ProgressFormatter,
+          offenses_formatter: OffensesFormatter,
+        ).void
+      end
+      def initialize(args, configuration:, out:, err_out:, progress_formatter:, offenses_formatter:)
+        @args = args
+        @configuration = configuration
+        @out = out
+        @err_out = err_out
+        @progress_formatter = progress_formatter
+        @offenses_formatter = offenses_formatter
+      end
+
+      sig { abstract.returns(T::Boolean) }
+      def run; end
+
+      private
+
+      sig { returns(T::Array[String]) }
+      attr_reader :args
+
+      sig { returns(Configuration) }
+      attr_reader :configuration
+
+      sig { returns(T.any(StringIO, IO)) }
+      attr_reader :out
+
+      sig { returns(T.any(StringIO, IO)) }
+      attr_reader :err_out
+
+      sig { returns(Formatters::ProgressFormatter) }
+      attr_reader :progress_formatter
+
+      sig { returns(OffensesFormatter) }
+      attr_reader :offenses_formatter
+    end
+  end
+end