feat: support yaml extension

docs/3-create-a-zarf-package/4-zarf-schema.md

@@ -441,26 +441,6 @@ Must be one of:
 | **Type**                  | `object`                                                                                                                          |
 | **Additional properties** | [![Any type: allowed](https://img.shields.io/badge/Any%20type-allowed-green)](# "Additional Properties of any type are allowed.") |
 
-<details>
-<summary>
-<strong> <a name="build_registryOverrides_pattern1"></a>Pattern Property .*</strong>
-</summary>
-&nbsp;
-<blockquote>
-
-:::note
-All properties whose name matches the regular expression
-```.*``` ([Test](https://regex101.com/?regex=.%2A))
-must respect the following conditions
-:::
-
-|          |          |
-| -------- | -------- |
-| **Type** | `string` |
-
-</blockquote>
-</details>
-
 </blockquote>
 </details>
 

hack/.templates/jsonschemaforhumans/section_properties_details.md

@@ -1,5 +1,5 @@
 {% for sub_property in schema.iterate_properties %}
-  {%- if sub_property.is_additional_properties and not sub_property.is_additional_properties_schema -%}
+  {%- if sub_property.is_additional_properties and not sub_property.is_additional_properties_schema or sub_property.is_pattern_property -%}
     {% continue %}
   {% endif %}
 
@@ -19,7 +19,7 @@
 <summary>
     {% filter md_heading(1, html_id, True) -%}
       {%- filter replace('\n', '') -%}
-        {%- if sub_property.is_pattern_property %} Pattern Property{% endif %} {% with schema=sub_property %}{%- include "breadcrumbs.md" %} {% endwith %}
+        {% with schema=sub_property %}{%- include "breadcrumbs.md" %} {% endwith %}
         {%- if not skip_required and sub_property.property_name -%}
             {{ "*" if sub_property.is_required_property else "" -}}
         {%- endif -%}
@@ -40,13 +40,6 @@
   {% endif %}
 
   {% with schema=sub_property, skip_headers=False %}
-    {% if sub_property.is_pattern_property %}
-:::note
-All properties whose name matches the regular expression
-```{{ sub_property.property_name }}``` ([Test](https://regex101.com/?regex={{ sub_property.property_name | urlencode }}))
-must respect the following conditions
-:::
-    {% endif %}
     {%- if not skip_required and sub_property.property_name -%}
         {{ md_badge("Required", "red", show_text=False) if sub_property.is_required_property else "" -}}
     {%- endif -%}

hack/.templates/jsonschemaforhumans/tabbed_section.md

@@ -6,7 +6,7 @@
 <blockquote>
 
     {% filter md_heading(2, node.html_id) -%}
-        {% if node.is_pattern_property %}Pattern{% endif %} Property `{% with schema=node %}{%- include "breadcrumbs.md" %}{% endwith %}`
+        Property `{% with schema=node %}{%- include "breadcrumbs.md" %}{% endwith %}`
     {%- endfilter %}
 
     {% with schema=node, skip_headers=False %}

hack/create-zarf-schema.sh

@@ -3,5 +3,9 @@
 # Create the json schema for the zarf.yaml
 go run main.go internal gen-config-schema > zarf.schema.json
 
+# Adds pattern properties to all definitions to allow for yaml extensions
+jq '.definitions |= map_values(. + {"patternProperties": {"^x-": {}}})' zarf.schema.json > temp_zarf.schema.json
+mv temp_zarf.schema.json zarf.schema.json
+
 # Create docs from the zarf.yaml JSON schema
 docker run -v $(pwd):/app -w /app --rm python:3.8-alpine /bin/sh -c "pip install json-schema-for-humans && generate-schema-doc --config-file hack/.templates/jsfh-config.json zarf.schema.json docs/3-create-a-zarf-package/4-zarf-schema.md"

src/pkg/packager/lint/lint.go

@@ -267,7 +267,35 @@ func makeFieldPathYqCompat(field string) string {
 	return fmt.Sprintf(".%s", wrappedField)
 }
 
+// removeYamlExtensionFields removes any field in a yaml object that starts with x-
+// This is consistent with how docker compose ignores yaml extension fields
+// https://docs.docker.com/compose/compose-file/11-extension/
+func removeYamlExtensionFields(yamlObj map[string]interface{}) {
+	for key, value := range yamlObj {
+		if strings.HasPrefix(key, "x-") {
+			delete(yamlObj, key)
+			continue
+		}
+
+		if nestedMap, ok := value.(map[string]interface{}); ok {
+			removeYamlExtensionFields(nestedMap)
+		}
+
+		if slice, ok := value.([]interface{}); ok {
+			for _, item := range slice {
+				if nestedMap, ok := item.(map[string]interface{}); ok {
+					removeYamlExtensionFields(nestedMap)
+				}
+			}
+		}
+	}
+}
+
 func validateSchema(validator *Validator) error {
+	if zarfPackageMap, ok := validator.untypedZarfPackage.(map[string]interface{}); ok {
+		removeYamlExtensionFields(zarfPackageMap)
+	}
+
 	schemaLoader := gojsonschema.NewBytesLoader(validator.jsonSchema)
 	documentLoader := gojsonschema.NewGoLoader(validator.untypedZarfPackage)
 

src/pkg/packager/lint/lint_test.go

@@ -34,13 +34,18 @@ components:
 `
 
 const goodZarfPackage = `
+x-name: &name good-zarf-package
+
 kind: ZarfPackageConfig
 metadata:
-  name: good-zarf-package
+  name: *name
+  x-description: Testing good yaml with yaml extension
 
 components:
   - name: baseline
     required: true
+    x-foo: bar
+
 `
 
 func readAndUnmarshalYaml[T interface{}](t *testing.T, yamlString string) T {