Ensure yamlfmt respects trunk-managed configs

Author: kevcube

linters/yamlfmt/plugin.yaml

@@ -24,13 +24,16 @@ lint:
       commands:
         - name: format
           output: rewrite
-          run: yamlfmt ${target}
-          run_from: ${parent}
+          run: python3 ${plugin}/linters/yamlfmt/run_yamlfmt.py --workspace ${workspace} ${target}
+          run_from: workspace
           success_codes: [0, 1]
           cache_results: true
           formatter: true
           in_place: true
           batch: true
+      environment:
+        - name: PATH
+          list: ["${linter}", "${env.PATH:-}"]
       tools: [yamlfmt]
       direct_configs:
         - .yamlfmt

linters/yamlfmt/run_yamlfmt.py

@@ -0,0 +1,52 @@
+#!/usr/bin/env python3
+"""Helper to run yamlfmt with trunk-managed configs."""
+
+from __future__ import annotations
+
+import argparse
+import os
+import subprocess
+import sys
+from typing import List
+
+CONFIG_BASENAMES: List[str] = [
+    ".yamlfmt",
+    ".yamlfmt.yaml",
+    ".yamlfmt.yml",
+    "yamlfmt.yaml",
+    "yamlfmt.yml",
+]
+
+
+def find_config(workspace: str) -> str | None:
+    search_roots = [workspace, os.path.join(workspace, ".trunk", "configs")]
+    for root in search_roots:
+        for basename in CONFIG_BASENAMES:
+            candidate = os.path.join(root, basename)
+            if os.path.isfile(candidate):
+                return candidate
+    return None
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--workspace", required=True, help="Absolute path to the repo root"
+    )
+    parser.add_argument("paths", nargs="+", help="Targets to pass to yamlfmt")
+    args = parser.parse_args()
+
+    workspace = os.path.abspath(args.workspace)
+    config_path = find_config(workspace)
+
+    cmd = ["yamlfmt"]
+    if config_path:
+        cmd.extend(["-conf", config_path])
+    cmd.extend(args.paths)
+
+    result = subprocess.run(cmd)
+    sys.exit(result.returncode)
+
+
+if __name__ == "__main__":
+    main()

linters/yamlfmt/test_data/config.in.yaml

@@ -0,0 +1,3 @@
+description: >-
+  Builds and pushes a Docker image to a container registry.
+  Requires authentication to be handled by the calling workflow.

linters/yamlfmt/test_data/yamlfmt_v0.20.0_config.fmt.shot

@@ -0,0 +1,8 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing formatter yamlfmt test config 1`] = `
+"description: >-
+  Builds and pushes a Docker image to a container registry.
+  Requires authentication to be handled by the calling workflow.
+"
+`;

linters/yamlfmt/yamlfmt.test.ts

@@ -1,9 +1,25 @@
 import { linterCheckTest, linterFmtTest } from "tests";
+import { TrunkLintDriver } from "tests/driver";
 import { osTimeoutMultiplier } from "tests/utils";
 
 // This install is quite slow on some Linux machines.
 jest.setTimeout(600000 * osTimeoutMultiplier);
 
+const writeTrunkConfig = (driver: TrunkLintDriver) => {
+  const config = `formatter:
+  type: basic
+  scan_folded_as_literal: true
+  retain_line_breaks: true
+`;
+  driver.writeFile(".trunk/configs/.yamlfmt.yml", config);
+};
+
 linterCheckTest({ linterName: "yamlfmt", namedTestPrefixes: ["empty"] });
 
 linterFmtTest({ linterName: "yamlfmt", namedTestPrefixes: ["basic"] });
+
+linterFmtTest({
+  linterName: "yamlfmt",
+  namedTestPrefixes: ["config"],
+  preCheck: writeTrunkConfig,
+});