packwerk 2.1.1 → 2.2.1

data/Gemfile.lock

@@ -1,240 +1,267 @@
-GIT
-  remote: https://github.com/rails/rails.git
-  revision: d612542336d9a61381311c95a27d801bb4094779
-  branch: main
+PATH
+  remote: .
+  specs:
+    packwerk (2.2.1)
+      activesupport (>= 5.2)
+      ast
+      better_html
+      bundler
+      constant_resolver (>= 0.2.0)
+      parallel
+      parser
+      sorbet-runtime (>= 0.5.9914)
+
+GEM
+  remote: https://rubygems.org/
   specs:
-    actioncable (7.0.0.alpha)
-      actionpack (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
+    actioncable (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.0.alpha)
-      actionpack (= 7.0.0.alpha)
-      activejob (= 7.0.0.alpha)
-      activerecord (= 7.0.0.alpha)
-      activestorage (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
+    actionmailbox (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       mail (>= 2.7.1)
-    actionmailer (7.0.0.alpha)
-      actionpack (= 7.0.0.alpha)
-      actionview (= 7.0.0.alpha)
-      activejob (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.0.alpha)
-      actionview (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.0.alpha)
-      actionpack (= 7.0.0.alpha)
-      activerecord (= 7.0.0.alpha)
-      activestorage (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
+    actiontext (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
+    actionview (7.0.3.1)
+      activesupport (= 7.0.3.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
+    activejob (7.0.3.1)
+      activesupport (= 7.0.3.1)
       globalid (>= 0.3.6)
-    activemodel (7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
-    activerecord (7.0.0.alpha)
-      activemodel (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
-    activestorage (7.0.0.alpha)
-      actionpack (= 7.0.0.alpha)
-      activejob (= 7.0.0.alpha)
-      activerecord (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
-      marcel (~> 1.0.0)
-      mini_mime (~> 1.0.2)
-    activesupport (7.0.0.alpha)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activestorage (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
-    rails (7.0.0.alpha)
-      actioncable (= 7.0.0.alpha)
-      actionmailbox (= 7.0.0.alpha)
-      actionmailer (= 7.0.0.alpha)
-      actionpack (= 7.0.0.alpha)
-      actiontext (= 7.0.0.alpha)
-      actionview (= 7.0.0.alpha)
-      activejob (= 7.0.0.alpha)
-      activemodel (= 7.0.0.alpha)
-      activerecord (= 7.0.0.alpha)
-      activestorage (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
-      bundler (>= 1.15.0)
-      railties (= 7.0.0.alpha)
-      sprockets-rails (>= 2.0.0)
-    railties (7.0.0.alpha)
-      actionpack (= 7.0.0.alpha)
-      activesupport (= 7.0.0.alpha)
-      method_source
-      rake (>= 0.13)
-      thor (~> 1.0)
-
-PATH
-  remote: .
-  specs:
-    packwerk (2.1.1)
-      activesupport (>= 5.2)
-      ast
-      better_html
-      bundler
-      constant_resolver
-      digest
-      parallel
-      parser
-      sorbet-runtime
-
-GEM
-  remote: https://rubygems.org/
-  specs:
     ast (2.4.2)
-    better_html (1.0.16)
-      actionview (>= 4.0)
-      activesupport (>= 4.0)
+    better_html (2.0.1)
+      actionview (>= 6.0)
+      activesupport (>= 6.0)
       ast (~> 2.0)
       erubi (~> 1.4)
-      html_tokenizer (~> 0.0.6)
       parser (>= 2.4)
       smart_properties
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
-    colorize (0.8.1)
-    commander (4.5.2)
-      highline (~> 2.0.0)
-    concurrent-ruby (1.1.8)
-    constant_resolver (0.1.5)
+    concurrent-ruby (1.1.10)
+    constant_resolver (0.2.0)
     crass (1.0.6)
+    diff-lcs (1.5.0)
     digest (3.1.0)
-    erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    highline (2.0.3)
-    html_tokenizer (0.0.7)
-    i18n (1.8.10)
+    erubi (1.11.0)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.9.0)
+    json (2.6.2)
+    language_server-protocol (3.16.0.3)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    m (1.5.1)
+    m (1.6.0)
       method_source (>= 0.6.7)
       rake (>= 0.9.2.2)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (1.0.0)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mini_mime (1.0.3)
+    mini_mime (1.1.2)
     mini_portile2 (2.8.0)
-    minitest (5.14.4)
-    minitest-focus (1.2.1)
+    minitest (5.16.2)
+    minitest-focus (1.3.1)
       minitest (>= 4, < 6)
-    mocha (1.12.0)
-    nio4r (2.5.7)
-    nokogiri (1.13.3)
+    mocha (1.14.0)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    netrc (0.11.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.8)
       mini_portile2 (~> 2.8.0)
       racc (~> 1.4)
-    nokogiri (1.13.3-x86_64-darwin)
+    nokogiri (1.13.8-x86_64-darwin)
       racc (~> 1.4)
-    parallel (1.20.1)
-    parlour (6.0.0)
-      commander (~> 4.5)
-      parser
-      rainbow (~> 3.0)
-      sorbet-runtime (>= 0.5)
-    parser (3.0.0.0)
+    parallel (1.22.1)
+    parser (3.1.2.1)
       ast (~> 2.4.1)
-    pry (0.14.0)
+    prettier_print (0.1.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    psych (3.3.2)
     racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails (7.0.3.1)
+      actioncable (= 7.0.3.1)
+      actionmailbox (= 7.0.3.1)
+      actionmailer (= 7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actiontext (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      bundler (>= 1.15.0)
+      railties (= 7.0.3.1)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    railties (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbi (0.0.15)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rubocop (1.12.0)
+    rubocop (1.34.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.2.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.20.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.10.2)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.21.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-shopify (2.0.1)
-      rubocop (~> 1.11)
-    rubocop-sorbet (0.6.1)
-      rubocop
+    rubocop-shopify (2.9.0)
+      rubocop (~> 1.33)
+    rubocop-sorbet (0.6.11)
+      rubocop (>= 0.90.0)
+    ruby-lsp (0.2.3)
+      language_server-protocol
+      sorbet-runtime
+      syntax_tree (>= 2.4)
     ruby-progressbar (1.11.0)
     smart_properties (1.17.0)
-    sorbet (0.5.9538)
-      sorbet-static (= 0.5.9538)
-    sorbet-runtime (0.5.9538)
-    sorbet-static (0.5.9538-universal-darwin-14)
-    sorbet-static (0.5.9538-universal-darwin-15)
-    sorbet-static (0.5.9538-universal-darwin-16)
-    sorbet-static (0.5.9538-universal-darwin-17)
-    sorbet-static (0.5.9538-universal-darwin-18)
-    sorbet-static (0.5.9538-universal-darwin-19)
-    sorbet-static (0.5.9538-universal-darwin-20)
-    sorbet-static (0.5.9538-universal-darwin-21)
-    sorbet-static (0.5.9538-x86_64-linux)
-    spoom (1.1.0)
-      colorize
-      sorbet (>= 0.5.6347)
-      sorbet-runtime
+    sorbet (0.5.10313)
+      sorbet-static (= 0.5.10313)
+    sorbet-runtime (0.5.10313)
+    sorbet-static (0.5.10313-universal-darwin-14)
+    sorbet-static (0.5.10313-universal-darwin-15)
+    sorbet-static (0.5.10313-universal-darwin-16)
+    sorbet-static (0.5.10313-universal-darwin-17)
+    sorbet-static (0.5.10313-universal-darwin-18)
+    sorbet-static (0.5.10313-universal-darwin-19)
+    sorbet-static (0.5.10313-universal-darwin-20)
+    sorbet-static (0.5.10313-universal-darwin-21)
+    sorbet-static (0.5.10313-universal-darwin-22)
+    sorbet-static (0.5.10313-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10313)
+      sorbet (= 0.5.10313)
+      sorbet-runtime (= 0.5.10313)
+    spoom (1.1.11)
+      sorbet (>= 0.5.9204)
+      sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
-    spring (2.1.1)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
-      sprockets (>= 3.0.0)
-    tapioca (0.4.19)
+    spring (4.0.0)
+    strscan (3.0.4)
+    syntax_tree (3.3.0)
+      prettier_print
+    tapioca (0.9.2)
       bundler (>= 1.17.3)
-      parlour (>= 2.1.0)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
       pry (>= 0.12.2)
-      sorbet-runtime
-      sorbet-static (>= 0.4.4471)
-      spoom
-      thor (>= 0.19.2)
-    thor (1.1.0)
-    tzinfo (2.0.4)
+      rbi (~> 0.0.0, >= 0.0.14)
+      sorbet-static-and-runtime (>= 0.5.9204)
+      spoom (~> 1.1.0, >= 1.1.11)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    timeout (0.3.0)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.0.0)
-    websocket-driver (0.7.3)
+    unicode-display_width (2.2.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webrick (1.7.0)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.6.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   ruby
@@ -248,16 +275,16 @@ DEPENDENCIES
   minitest-focus
   mocha
   packwerk!
-  psych (~> 3)
-  rails!
+  rails
   rake
   rubocop-performance
   rubocop-shopify
   rubocop-sorbet
-  sorbet
-  sorbet-runtime
+  ruby-lsp (~> 0.2.1)
+  sorbet-static-and-runtime
   spring
   tapioca
+  zeitwerk
 
 BUNDLED WITH
-   2.3.4
+   2.3.5

data/README.md

@@ -1,6 +1,9 @@
 # Packwerk [![Build Status](https://github.com/Shopify/packwerk/workflows/CI/badge.svg)](https://github.com/Shopify/packwerk/actions?query=workflow%3ACI)
 
-## NOTE: Packwerk is considered to be feature-complete for Shopify's uses. We are currently accepting bug fixes only, and it is not being actively developed. Please fork this project if you are interested in adding new features.
+### ⚠️ While Shopify is actively using `packwerk`, we consider it feature complete.
+We are keeping `packwerk` compatible with current versions of Ruby and Rails, but will accept feature requests only in rare cases. Please submit bug fixes though!
+
+---
 
 > "I know who you are and because of that I know what you do."
 > This knowledge is a dependency that raises the cost of change.
@@ -58,10 +61,12 @@ Read [USAGE.md](USAGE.md) for usage once Packwerk is installed on your project.
 
 ## Ecosystem
 
-You can use these third party tools to enhance your packwerk experience:
+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/danger-packwerk integrates packwerk with [danger.systems](https://danger.systems) to provide packwerk feedback as Github inline PR comments
 
 ## Development
 

data/RESOLVING_VIOLATIONS.md

@@ -0,0 +1,81 @@
+# Resolving Violations
+
+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-deprecations`, adding new violations to `deprecated_references.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?
+
+➡️ Simply run `bin/packwerk update-deprecations`, and address the violation when the customer issue is resolved.
+
+### Improving System Design
+❔ Are you improving system boundaries by renaming or moving a file, class, constant,` or module?
+
+➡️ Simply run `bin/packwerk update-deprecations`. We've improved how our system is organized, so the new violations are natural.
+
+### Making Things Explicit
+❔ Are you making something that was implicit (hidden to Packwerk) explicit, such as adding a Sorbet signature, using a class instead of a method call, or something similar?
+
+➡️ Simply run `bin/packwerk update-deprecations`. Making something implicit explicit and capturing that as a new violation is a strict improvement.
+
+### Temporary State
+❔ Is the violation temporary because you will soon delete the code or is it part of a refactor to improve system boundaries and reduce violations overall?
+
+➡️ Simply run `bin/packwerk update-deprecations`. Sometimes things get "worse" before they get better.
+
+### Delivering Features
+❔ Are you in a rush to get a feature out and product, your manager, or an internal sense of urgency has made you feel like you can't resolve system design issues?
+
+➡️ 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
+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.
+
+### Moving Things Around
+❔ Does the code you're writing (or changing) live in the right package? Does the code you're referencing live in the right package?
+
+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.
+
+#### Use Existing Public Interface
+❔ Does the package you're using expose public API in its public folder that supports your use case?
+
+➡️ Use that public API instead!
+
+#### Change The Public Interface
+❔ Can we work with the package's owner to create and use a public API? Or should the thing we're using already be public?
+
+➡️  Work together on a new public API and use that instead! If the thing we're using should be public, move it to the public folder to make it public!
+
+⛈️ If working with the package's owner to improve the API is not possible, run `bin/packwerk update-deprecations`. Add some context to your PR about why it's not possible.
+
+### Dependency Violations
+💡  Packwerk thinks something is a dependency violation if you're referencing a constant, class, module defined ANYWHERE but your package doesn't list it as an explicit dependency in its `package.yml`. We care about these because it allows us to be systematically intentional about what our code needs to run and helps us untangle and remove dependency cycles from our system.
+
+Thoughtful dependency management is another cornerstone of well-modularized code.
+
+#### Adding Explicit Dependencies
+❔ Do we actually want to depend on the other package? Work with your team to help answer this question!
+
+➡️  Add the other package to your package's `package.yml` `dependencies` key.
+
+⁉️ Did you get a cyclic dependency when CI ran `bin/packwerk validate`?
+
+➡️  Work with your team to think through what link in the cycle we don't want. Remove that link and rerun `bin/packwerk validate`.
+
+#### Changing The System Design
+❔ Can we spend some time to think through changes to the system design that don't require the dependency?
+
+➡️  Work with the owners of the relevant packages, as well as your team, to think through a design that doesn't include the unwanted dependency.
+
+⛈️ If this is not possible within the scope of your changes (think hard about this one!), run `bin/packwerk update-deprecations`. Add some context to your PR about why it's not possible, and any additional context you may have, such as a possible solution.

data/Rakefile

@@ -7,7 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
-  t.warning = true
+  t.warning = false
 end
 
 task(default: :test)

data/USAGE.md

@@ -17,6 +17,8 @@
     * [Using public folders](#using-public-folders)
   * [Enforcing dependency boundary](#enforcing-dependency-boundary)
 * [Checking for violations](#checking-for-violations)
+* [Resolving new violations](#resolving-new-violations)
+  * [Understanding how to respond to new violations](#understanding-how-to-respond-to-new-violations)
 * [Recording existing violations](#recording-existing-violations)
   * [Understanding the list of deprecated references](#understanding-the-list-of-deprecated-references)
 
@@ -54,7 +56,7 @@ Here is a list of files generated:
 
 | File                        | Location     | Description |
 |-----------------------------|--------------|------------|
-| Packwerk configuration      | packwerk.yml | See [Setting up the configuration file](#Setting-up-the-configuration-file) |
+| Packwerk configuration      | packwerk.yml | See [Setting up the configuration file](#configuring-packwerk) |
 | Root package                | package.yml  | A package for the root folder |
 
 After that, you may begin creating packages for your application. See [Defining packages](#Defining-packages)
@@ -115,7 +117,7 @@ We recommend setting up the package system validation for your Rails application
 
 Use the following command to validate the application:
 
-    packwerk validate
+    bin/packwerk validate
 
 ![](static/packwerk_validate.gif)
 
@@ -204,17 +206,17 @@ It will be a dependency violation when `components/shop_identity` tries to refer
 
 After enforcing the boundary checks for a package, you may execute:
 
-    packwerk check
+    bin/packwerk check
 
 Packwerk will check the entire codebase for any new or stale violations.
 
 You can also specify folders for a shorter run time. When checking against folders all subfolders will be analyzed, irrespective of nested package boundaries.
 
-    packwerk check components/your_package
+    bin/packwerk check components/your_package
 
 You can also specify packages for a shorter run time. When checking against packages any packages nested underneath the specified packages will not be checked. This can be helpful to test packages like the root package, which can have many nested packages.
 
-    packwerk check --packages=components/your_package,components/your_other_package
+    bin/packwerk check --packages=components/your_package,components/your_other_package
 
 ![](static/packwerk_check.gif)
 
@@ -222,6 +224,13 @@ In order to keep the package system valid at each version of the application, we
 
 See: [TROUBLESHOOT.md - Sample violations](TROUBLESHOOT.md#Sample-violations)
 
+## Resolving new violations
+### Understanding how to respond to new violations
+
+When you have a new dependency or privacy violation, what do you do?
+
+See: [RESOLVING_VIOLATIONS.md](RESOLVING_VIOLATIONS.md)
+
 ## Recording existing violations
 
 For existing codebases, packages are likely to have existing boundary violations.

data/bin/m

@@ -15,7 +15,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/rake

@@ -15,7 +15,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/rubocop

@@ -15,7 +15,7 @@ ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
 bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.