Sort package.yml keys when writing (#27)

Author: Alex Evanczuk

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    parse_packwerk (0.19.2)
+    parse_packwerk (0.19.3)
       sorbet-runtime
 
 GEM

lib/parse_packwerk.rb

@@ -72,17 +72,6 @@ def self.write_package_yml!(package)
         merged_config.merge!('enforce_privacy' => package.enforce_privacy)
       end
 
-      # We want checkers of the form `enforce_xyz` to be at the top
-      merged_config_arr = merged_config.sort_by do |k, v|
-        if k.include?('enforce')
-          0
-        else
-          1
-        end
-      end
-
-      merged_config = merged_config_arr.to_h
-
       unless package.public_path == DEFAULT_PUBLIC_PATH
         merged_config.merge!('public_path' => package.public_path)
       end
@@ -96,6 +85,10 @@ def self.write_package_yml!(package)
       if package.metadata.any?
         merged_config.merge!('metadata' => package.metadata)
       end
+
+      sorted_keys = key_sort_order
+      merged_config = merged_config.to_a.sort_by{|key, value| T.unsafe(sorted_keys).index(key) || 1000 }.to_h
+
       raw_yaml = YAML.dump(merged_config)
       # Add indentation for dependencies
       raw_yaml.gsub!(/^- /,"  - ")
@@ -104,6 +97,23 @@ def self.write_package_yml!(package)
     end
   end
 
+  sig { returns(T::Array[String]) }
+  def self.key_sort_order
+    %w(
+      enforce_dependencies
+      enforce_privacy
+      enforce_visibility
+      enforce_architecture
+      public_path
+      owner
+      layer
+      dependencies
+      ignored_dependencies
+      visible_to
+      metadata
+    )
+  end
+
   # We memoize packages_by_name for fast lookup.
   # Since Graph is an immutable value object, we can create indexes and general caching mechanisms safely.
   sig { returns(T::Hash[String, Package]) }

parse_packwerk.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "parse_packwerk"
-  spec.version       = '0.19.2'
+  spec.version       = '0.19.3'
   spec.authors       = ['Gusto Engineers']
   spec.email         = ['dev@gusto.com']
   spec.summary       = 'A low-dependency gem for parsing and writing packwerk YML files'