packwerk-extensions 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 558107be67a748dfb9a175b9d90be2acc373913f36a66c5bccbb3401e80cd85f
-  data.tar.gz: fb98b8c64bb3043d267aab3d966d404934a5a530020dc18e3e599a13153fe121
+  metadata.gz: a4cd61088407945a3e4f58a0a5a3959759683e9186646a4fca4959b79bcbb9b3
+  data.tar.gz: 855d5ce12ce1d3dba10f06e67e8c25e519d46073fc7eaaa1df67a9fc2777fa09
 SHA512:
-  metadata.gz: e6beb350fd3089406f7a0ec0409b79f261136b89ffe0ede267215893ca7abb9f5613a7aaf44248f1c0b53560a0596a78739568f85bd2a081edf4b3d0f69fe0d0
-  data.tar.gz: 706bc3779b3af6ce3d6780ba9106a8bb4fc84cd81ddd93c7809b62f2663de1baf4c906f961abc6a4982c8815142478d839054b27c504639e1eb5dc88e0b267e3
+  metadata.gz: 7efea5e86a203158a431c43acb5bf422257e5d9d1ec4ddddc13000b733ca8f000c713dbe72bf30cf7a735c5292a736de2570909cd7cc96182e61cc4af8c92804
+  data.tar.gz: a265c58f6976133334b818847154d5fe3663144c1e956b607b6ec7d315de7c7d9086968329a438eb0dac9384b380f942b8bac8e36ca41345cbf08cc0f7029245

data/README.md

@@ -1,6 +1,11 @@
 # packwerk-extensions
 
-`packwerk-extensions` is a home for checker extensions for packwerk.
+`packwerk-extensions` is a home for checker extensions for [packwerk](https://github.com/Shopify/packwerk) 3.
+
+Note that packwerk has not yet released packwerk 3. If you'd like to use `packwerk-extensions`, you'll need to point your `Gemfile` at the `packwerk` `main` branch:
+```ruby
+gem 'packwerk', github: 'Shopify/packwerk', branch: 'main'
+```
 
 Currently, it ships the following checkers to help improve the boundaries between packages. These checkers are:
 - A `privacy` checker that ensures other packages are using your package's public API

data/lib/packwerk/architecture/validator.rb

@@ -22,11 +22,12 @@ module Packwerk
           results << result
           next if !result.ok?
 
-          result = check_layer_setting(config, f, config['layer'])
+          package = Package.from(package, layers)
+
+          result = check_layer_setting(package, f)
           results << result
           next if !result.ok?
 
-          package = Package.from(package, layers)
           results += check_dependencies_setting(package_set, package, f)
         end
 
@@ -65,17 +66,16 @@ module Packwerk
       end
 
       sig do
-        params(config: T::Hash[T.untyped, T.untyped], config_file_path: String, layer: T.untyped).returns(Result)
+        params(package: Package, config_file_path: String).returns(Result)
       end
-      def check_layer_setting(config, config_file_path, layer)
-        enforce_architecture = config['enforce_architecture']
-        enforce_architecture_enabled = !(enforce_architecture.nil? || enforce_architecture == false)
+      def check_layer_setting(package, config_file_path)
+        layer = package.layer
         valid_layer = layer.nil? || layers.names.include?(layer)
 
-        if layer.nil? && enforce_architecture_enabled
+        if layer.nil? && package.enforces?
           Result.new(
             ok: false,
-            error_value: "Invalid 'layer' option in #{config_file_path.inspect}: #{layer.inspect}. `layer` must be set if `enforce_architecture` is on."
+            error_value: "Invalid 'layer' option in #{config_file_path.inspect}: #{package.layer.inspect}. `layer` must be set if `enforce_architecture` is on."
           )
         elsif valid_layer
           Result.new(ok: true)
@@ -91,20 +91,21 @@ module Packwerk
         params(config_file_path: String, setting: T.untyped).returns(Result)
       end
       def check_enforce_architecture_setting(config_file_path, setting)
+        activated_value = [true, 'strict'].include?(setting)
         valid_value = [true, nil, false, 'strict'].include?(setting)
         layers_set = layers.names.any?
-        if valid_value && layers_set
-          Result.new(ok: true)
-        elsif valid_value
+        if !valid_value
           Result.new(
             ok: false,
-            error_value: "Cannot set 'enforce_architecture' option in #{config_file_path.inspect} until `architectural_layers` have been specified in `packwerk.yml`"
+            error_value: "Invalid 'enforce_architecture' option in #{config_file_path.inspect}: #{setting.inspect}"
           )
-        else
+        elsif activated_value && !layers_set
           Result.new(
             ok: false,
-            error_value: "Invalid 'enforce_architecture' option in #{config_file_path.inspect}: #{setting.inspect}"
+            error_value: "Cannot set 'enforce_architecture' option in #{config_file_path.inspect} until `architectural_layers` have been specified in `packwerk.yml`"
           )
+        else
+          Result.new(ok: true)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packwerk-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2022-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: packwerk