feat: add YAML plugin to dprint formatter

mikkeldamsgaard · claude · mikkeldamsgaard · commit 58037e384010 · 2026-03-14T11:26:38.000+01:00
Add pretty_yaml plugin covering both .yaml and .yml files. Exclude
Helm templates directory (Go template syntax is not valid YAML).

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - `urlencode` template filter for percent-encoding strings in URLs. Useful for embedding passwords or other values containing URL-reserved characters (`@`, `%`, `:`, `/`, etc.) in connection strings.
-- `dprint` formatter for Markdown, JSON, TOML, and Dockerfile with CI check (`dprint/check@v2.2`) and definition-of-done gate.
+- `dprint` formatter for Markdown, JSON, TOML, YAML, and Dockerfile with CI check (`dprint/check@v2.2`) and definition-of-done gate.
 
 ### Changed
 
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -121,7 +121,7 @@ Definition of done
 - Code compiles without warnings.
 - Code is linted.
 - Code is formatted.
-- `dprint check` passes with no issues (Markdown, JSON, TOML, Dockerfile).
+- `dprint check` passes with no issues (Markdown, JSON, TOML, YAML, Dockerfile).
 - Tests pass.
 - Docs updated.
 - CHANGELOG updated.
diff --git a/FAQ.md b/FAQ.md
@@ -237,7 +237,7 @@ No. Initium is designed for the most restrictive Kubernetes security posture:
 ```yaml
 securityContext:
   runAsNonRoot: true
-  runAsUser: 65534        # nobody
+  runAsUser: 65534 # nobody
   runAsGroup: 65534
   readOnlyRootFilesystem: true
   allowPrivilegeEscalation: false
@@ -275,7 +275,12 @@ To prevent man-in-the-middle attacks. If you connect to `https://vault:8200`, In
 If you need to connect to a service with a self-signed certificate (common in dev/staging), explicitly opt in:
 
 ```yaml
-args: ["wait-for", "--target", "https://vault:8200/v1/sys/health", "--insecure-tls"]
+args: [
+  "wait-for",
+  "--target",
+  "https://vault:8200/v1/sys/health",
+  "--insecure-tls",
+]
 ```
 
 The `--insecure-tls` flag is intentionally verbose — it should stand out in code review.
@@ -361,7 +366,15 @@ spec:
   initContainers:
     - name: render-config
       image: ghcr.io/kitstream/initium:latest
-      args: ["render", "--template", "/templates/app.conf.tmpl", "--output", "app.conf", "--workdir", "/work"]
+      args: [
+        "render",
+        "--template",
+        "/templates/app.conf.tmpl",
+        "--output",
+        "app.conf",
+        "--workdir",
+        "/work",
+      ]
       volumeMounts:
         - name: workdir
           mountPath: /work
diff --git a/README.md b/README.md
@@ -214,7 +214,15 @@ Use the `render` subcommand with environment variable substitution:
 initContainers:
   - name: render-config
     image: ghcr.io/kitstream/initium:latest
-    args: ["render", "--template", "/templates/app.conf.tmpl", "--output", "app.conf", "--workdir", "/work"]
+    args: [
+      "render",
+      "--template",
+      "/templates/app.conf.tmpl",
+      "--output",
+      "app.conf",
+      "--workdir",
+      "/work",
+    ]
     env:
       - name: DB_HOST
         value: postgres
@@ -249,7 +257,12 @@ Output: `{"time":"2025-01-15T10:30:00Z","level":"INFO","msg":"target is reachabl
 Use `--insecure-tls` (must be explicitly opted in):
 
 ```yaml
-args: ["wait-for", "--target", "https://vault:8200/v1/sys/health", "--insecure-tls"]
+args: [
+  "wait-for",
+  "--target",
+  "https://vault:8200/v1/sys/health",
+  "--insecure-tls",
+]
 ```
 
 ### Can I use Initium outside Kubernetes?
diff --git a/charts/initium/Chart.yaml b/charts/initium/Chart.yaml
@@ -16,4 +16,3 @@ keywords:
   - wait
   - migration
   - kubernetes
-
diff --git a/charts/initium/values.yaml b/charts/initium/values.yaml
@@ -37,49 +37,48 @@ sampleDeployment:
 #
 # Example: wait for Postgres, render config, then run migration
 initContainers:
-  # - name: wait-for-postgres
-  #   command: ["wait-for"]
-  #   args:
-  #     - --target
-  #     - tcp://postgres:5432
-  #     - --timeout
-  #     - "120s"
-  #     - --max-attempts
-  #     - "30"
+# - name: wait-for-postgres
+#   command: ["wait-for"]
+#   args:
+#     - --target
+#     - tcp://postgres:5432
+#     - --timeout
+#     - "120s"
+#     - --max-attempts
+#     - "30"
 
-  # - name: render-config
-  #   command: ["render"]
-  #   args:
-  #     - --template
-  #     - /templates/app.conf.tmpl
-  #     - --output
-  #     - config/app.conf
-  #     - --workdir
-  #     - /work
-  #   env:
-  #     - name: DB_HOST
-  #       value: postgres
-  #     - name: DB_PORT
-  #       value: "5432"
+# - name: render-config
+#   command: ["render"]
+#   args:
+#     - --template
+#     - /templates/app.conf.tmpl
+#     - --output
+#     - config/app.conf
+#     - --workdir
+#     - /work
+#   env:
+#     - name: DB_HOST
+#       value: postgres
+#     - name: DB_PORT
+#       value: "5432"
 
-  # - name: run-migration
-  #   command: ["migrate"]
-  #   args:
-  #     - --
-  #     - /usr/bin/flyway
-  #     - migrate
-  #   env:
-  #     - name: FLYWAY_URL
-  #       value: jdbc:postgresql://postgres:5432/mydb
+# - name: run-migration
+#   command: ["migrate"]
+#   args:
+#     - --
+#     - /usr/bin/flyway
+#     - migrate
+#   env:
+#     - name: FLYWAY_URL
+#       value: jdbc:postgresql://postgres:5432/mydb
 
 # Additional volumes to mount into initContainers
 extraVolumes: []
-  # - name: templates
-  #   configMap:
-  #     name: app-templates
+# - name: templates
+#   configMap:
+#     name: app-templates
 
 extraVolumeMounts: []
-  # - name: templates
-  #   mountPath: /templates
-  #   readOnly: true
-
+# - name: templates
+#   mountPath: /templates
+#   readOnly: true
diff --git a/docs/seeding.md b/docs/seeding.md
@@ -31,35 +31,37 @@ The seed spec file defines the complete seeding plan. Both YAML and JSON formats
 
 ```yaml
 database:
-  driver: postgres                 # Required. One of: postgres, mysql, sqlite
-  url: "postgres://..."            # Direct database URL
-  url_env: DATABASE_URL            # Or: name of env var containing the URL
-  tracking_table: initium_seed     # Default: "initium_seed"
+  driver: postgres # Required. One of: postgres, mysql, sqlite
+  url: "postgres://..." # Direct database URL
+  url_env: DATABASE_URL # Or: name of env var containing the URL
+  tracking_table: initium_seed # Default: "initium_seed"
 
 phases:
-  - name: setup                    # Required. Phase name.
-    order: 1                       # Optional. Execution order (default: 0).
-    database: reporting            # Optional. Database to target/create.
-    schema: analytics              # Optional. Schema to target/create.
-    create_if_missing: true        # Optional. Create database/schema if missing.
-    timeout: 30s                    # Optional. Default wait timeout (e.g. 30s, 1m; default: 30s).
-    wait_for:                      # Optional. Objects to wait for before seeding.
-      - type: table                # One of: table, view, schema, database.
+  - name: setup # Required. Phase name.
+    order: 1 # Optional. Execution order (default: 0).
+    database: reporting # Optional. Database to target/create.
+    schema: analytics # Optional. Schema to target/create.
+    create_if_missing: true # Optional. Create database/schema if missing.
+    timeout: 30s # Optional. Default wait timeout (e.g. 30s, 1m; default: 30s).
+    wait_for: # Optional. Objects to wait for before seeding.
+      - type: table # One of: table, view, schema, database.
         name: users
-        timeout: 60s               # Optional. Per-object timeout override.
-    seed_sets:                     # Optional. Seed sets to apply in this phase.
+        timeout: 60s # Optional. Per-object timeout override.
+    seed_sets: # Optional. Seed sets to apply in this phase.
       - name: initial_data
-        order: 1                   # Optional. Controls execution order across seed sets.
-        mode: once                 # Optional. "once" (default) or "reconcile".
+        order: 1 # Optional. Controls execution order across seed sets.
+        mode: once # Optional. "once" (default) or "reconcile".
         tables:
           - table: config
-            order: 1               # Optional. Controls execution order within a seed set.
-            unique_key: [email]    # Optional. Columns used for duplicate detection.
-            auto_id:               # Optional. Auto-generated ID configuration.
-              column: id           # Column name for the auto-generated ID.
-              id_type: integer     # ID type (default: integer).
+            order: 1 # Optional. Controls execution order within a seed set.
+            unique_key: [
+              email,
+            ] # Optional. Columns used for duplicate detection.
+            auto_id: # Optional. Auto-generated ID configuration.
+              column: id # Column name for the auto-generated ID.
+              id_type: integer # ID type (default: integer).
             rows:
-              - _ref: row_alias    # Optional. Internal reference name for this row.
+              - _ref: row_alias # Optional. Internal reference name for this row.
                 key: app_name
                 value: "{{ env.APP_NAME }}"
 ```
@@ -176,7 +178,7 @@ tables:
     unique_key: [email]
     rows:
       - name: Alice
-        email: alice@example.com    # Skipped if email already exists
+        email: alice@example.com # Skipped if email already exists
 ```
 
 ### Auto-Generated IDs and Cross-Table References
@@ -194,15 +196,15 @@ phases:
             auto_id:
               column: id
             rows:
-              - _ref: dept_eng            # Name this row for later reference
+              - _ref: dept_eng # Name this row for later reference
                 name: Engineering
 
           - table: employees
             order: 2
             rows:
               - name: Alice
                 email: alice@example.com
-                department_id: "@ref:dept_eng.id"   # Resolves to the generated ID
+                department_id: "@ref:dept_eng.id" # Resolves to the generated ID
 ```
 
 ### Environment Variable Substitution
@@ -226,10 +228,10 @@ Enable reconcile mode per seed set:
 ```yaml
 seed_sets:
   - name: departments
-    mode: reconcile        # "once" (default) or "reconcile"
+    mode: reconcile # "once" (default) or "reconcile"
     tables:
       - table: departments
-        unique_key: [name]  # Required for reconcile mode
+        unique_key: [name] # Required for reconcile mode
         rows:
           - name: Engineering
           - name: Sales
diff --git a/docs/usage.md b/docs/usage.md
@@ -338,7 +338,17 @@ initContainers:
   - name: generate-key
     image: my-registry/initium-openssl:latest
     command: ["initium"]
-    args: ["exec", "--workdir", "/certs", "--", "openssl", "genrsa", "-out", "key.pem", "4096"]
+    args: [
+      "exec",
+      "--workdir",
+      "/certs",
+      "--",
+      "openssl",
+      "genrsa",
+      "-out",
+      "key.pem",
+      "4096",
+    ]
     volumeMounts:
       - name: certs
         mountPath: /certs
@@ -359,7 +369,13 @@ initContainers:
   - name: transform-config
     image: ghcr.io/kitstream/initium-jyq:latest
     command: ["initium"]
-    args: ["exec", "--", "jq", ".database.host = \"db.prod\"", "/config/app.json"]
+    args: [
+      "exec",
+      "--",
+      "jq",
+      ".database.host = \"db.prod\"",
+      "/config/app.json",
+    ]
 ```
 
 ## Global Flags
diff --git a/dprint.json b/dprint.json
@@ -1,13 +1,14 @@
 {
-  "includes": ["**/*.md", "**/*.json", "**/*.toml", "**/Dockerfile", "**/Dockerfile.*"],
-  "excludes": ["target/", "node_modules/"],
+  "includes": ["**/*.md", "**/*.json", "**/*.toml", "**/*.yaml", "**/*.yml", "**/Dockerfile", "**/Dockerfile.*"],
+  "excludes": ["target/", "node_modules/", "charts/**/templates/"],
   "dockerfile": {
     "associations": ["**/Dockerfile", "**/Dockerfile.*"]
   },
   "plugins": [
     "https://plugins.dprint.dev/markdown-0.17.8.wasm",
     "https://plugins.dprint.dev/json-0.21.1.wasm",
     "https://plugins.dprint.dev/toml-0.7.0.wasm",
-    "https://plugins.dprint.dev/dockerfile-0.3.3.wasm"
+    "https://plugins.dprint.dev/dockerfile-0.3.3.wasm",
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.6.0.wasm"
   ]
 }
diff --git a/examples/config-render/deployment.yaml b/examples/config-render/deployment.yaml
@@ -85,4 +85,3 @@ spec:
         - name: templates
           configMap:
             name: app-template
-
diff --git a/examples/nginx-waitfor/deployment.yaml b/examples/nginx-waitfor/deployment.yaml
@@ -45,4 +45,3 @@ spec:
           image: nginx:1.27-alpine
           ports:
             - containerPort: 80
-
diff --git a/examples/postgres-migrate-seed/deployment.yaml b/examples/postgres-migrate-seed/deployment.yaml
@@ -107,4 +107,3 @@ spec:
       volumes:
         - name: workdir
           emptyDir: {}
-
diff --git a/examples/seed/phased-seed.yaml b/examples/seed/phased-seed.yaml
@@ -12,7 +12,6 @@
 #   export APP_SCHEMA=app_data
 #   initium seed --spec examples/seed/phased-seed.yaml
 
-
 database:
   driver: postgres
   url_env: DATABASE_URL
@@ -21,7 +20,7 @@ phases:
   # Phase 1: Create the schema if it doesn't exist
   - name: create_schema
     order: 1
-    schema: {{ env.APP_SCHEMA | default("app_data") }}
+    schema: { { env.APP_SCHEMA | default("app_data") } }
     create_if_missing: true
 
   # Phase 2: Wait for tables to be created by migrations, then seed
diff --git a/tests/docker-compose.yml b/tests/docker-compose.yml
@@ -23,7 +23,16 @@ services:
     ports:
       - "13306:3306"
     healthcheck:
-      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-prootpass"]
+      test: [
+        "CMD",
+        "mysqladmin",
+        "ping",
+        "-h",
+        "localhost",
+        "-u",
+        "root",
+        "-prootpass",
+      ]
       interval: 2s
       timeout: 5s
       retries: 15

Original file line number	Diff line number	Diff line change
`@@ -1,13 +1,14 @@`
`1`	`1`	`{`
`2`		`- "includes": ["*/.md", "*/.json", "*/.toml", "/Dockerfile", "/Dockerfile.*"],`
`3`		`- "excludes": ["target/", "node_modules/"],`
	`2`	`+ "includes": ["*/.md", "*/.json", "*/.toml", "*/.yaml", "*/.yml", "/Dockerfile", "/Dockerfile.*"],`
	`3`	`+ "excludes": ["target/", "node_modules/", "charts/**/templates/"],`
`4`	`4`	`"dockerfile": {`
`5`	`5`	`"associations": ["/Dockerfile", "/Dockerfile.*"]`
`6`	`6`	`},`
`7`	`7`	`"plugins": [`
`8`	`8`	`"https://plugins.dprint.dev/markdown-0.17.8.wasm",`
`9`	`9`	`"https://plugins.dprint.dev/json-0.21.1.wasm",`
`10`	`10`	`"https://plugins.dprint.dev/toml-0.7.0.wasm",`
`11`		`- "https://plugins.dprint.dev/dockerfile-0.3.3.wasm"`
	`11`	`+ "https://plugins.dprint.dev/dockerfile-0.3.3.wasm",`
	`12`	`+ "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.6.0.wasm"`
`12`	`13`	`]`
`13`	`14`	`}`