@godxjp/ui 23.2.0 → 23.3.0

package/scripts/ui-audit.mjs

@@ -32,29 +32,72 @@ const dirArgs = args.filter((a) => !a.startsWith("--") && a !== "json");
  * local gate or in CI then covers every edit path, including the ones nobody thought of.
  */
 function changedFiles() {
-  const base =
-    spawnSync("git", ["merge-base", "HEAD", "origin/main"], { encoding: "utf8" }).stdout.trim() ||
-    "HEAD";
-  const run = (a) => spawnSync("git", a, { encoding: "utf8" }).stdout ?? "";
+  // A git command that FAILED used to be indistinguishable from one that found nothing: `run`
+  // returned `stdout ?? ""`, so a shallow clone with no `origin/main`, or a directory that is not
+  // a repository at all, produced an empty list and a clean, green, zero-exit run (gh#542).
+  const run = (a) => {
+    const r = spawnSync("git", a, { encoding: "utf8" });
+    return r.status === 0 ? (r.stdout ?? "") : null;
+  };
 
-  return [
-    ...new Set(
-      [
-        run(["diff", "--name-only", "--diff-filter=ACMR", base, "--"]),
-        run(["diff", "--name-only", "--diff-filter=ACMR", "--cached"]),
-        run(["ls-files", "--others", "--exclude-standard"]),
-      ]
-        .join("\n")
-        .split("\n")
-        .map((f) => f.trim())
-        .filter((f) => /\.(tsx|jsx)$/.test(f) && existsSync(join(CWD, f))),
-    ),
+  const mergeBase = run(["merge-base", "HEAD", "origin/main"]);
+  if (mergeBase === null) {
+    return {
+      error:
+        "ui-audit --changed could not resolve `git merge-base HEAD origin/main`. " +
+        "Without a base there is no such thing as \u201cwhat this branch changed\u201d, and reporting a " +
+        "clean audit from that is not a result. Fetch origin/main (a shallow clone may need " +
+        "`git fetch --unshallow`), or pass the directories to scan instead of `--changed`.",
+    };
+  }
+
+  const parts = [
+    run(["diff", "--name-only", "--diff-filter=ACMR", mergeBase.trim(), "--"]),
+    run(["diff", "--name-only", "--diff-filter=ACMR", "--cached"]),
+    run(["ls-files", "--others", "--exclude-standard"]),
   ];
+  if (parts.some((out) => out === null)) {
+    return {
+      error:
+        "ui-audit --changed: a `git diff`/`git ls-files` call failed; refusing to report a clean run.",
+    };
+  }
+
+  return {
+    files: [
+      ...new Set(
+        parts
+          .join("\n")
+          .split("\n")
+          .map((f) => f.trim())
+          // SCANNABLE, not a second hand-written list. Selecting `.jsx` here while `walk()` below
+          // accepted only `.tsx`/`.ts` meant a changed `.jsx` was picked, counted in the summary
+          // line as scanned, and then dropped by the walker without being opened — and if it was
+          // the only change, the run exited 0 saying "no .tsx/.jsx changed" (gh#542).
+          .filter((f) => SCANNABLE.test(f) && existsSync(join(CWD, f))),
+      ),
+    ],
+  };
 }
 
+/**
+ * The ONE extension set. `changedFiles()` selects with it and `walk()` admits with it, so the
+ * selector and the walker cannot drift apart again — that drift was gh#542.
+ */
+const SCANNABLE = /\.(tsx|jsx|ts)$/;
+
 const CHANGED = args.includes("--changed");
+const changed = CHANGED ? changedFiles() : null;
+if (changed?.error) {
+  if (asJson) {
+    process.stdout.write(JSON.stringify({ error: changed.error }, null, 2) + "\n");
+  } else {
+    console.error(changed.error);
+  }
+  process.exit(2);
+}
 const SCAN_DIRS = CHANGED
-  ? changedFiles()
+  ? changed.files
   : dirArgs.length
     ? dirArgs
     : SELF
@@ -728,7 +771,7 @@ function walk(dir, acc = []) {
   // Accept a FILE path directly (the per-file editor hook passes one), not just a directory.
   try {
     if (statSync(dir).isFile()) {
-      if (dir.endsWith(".tsx") || dir.endsWith(".ts")) acc.push(dir);
+      if (SCANNABLE.test(dir)) acc.push(dir);
       return acc;
     }
   } catch {
@@ -747,10 +790,7 @@ function walk(dir, acc = []) {
       // Test/story dirs are not product UI — never hold them to the UI-standardization rules.
       if (name === "__tests__" || name === "node_modules") continue;
       walk(full, acc);
-    } else if (
-      (name.endsWith(".tsx") || name.endsWith(".ts")) &&
-      !/\.(test|spec|stories)\.tsx?$/.test(name)
-    ) {
+    } else if (SCANNABLE.test(name) && !/\.(test|spec|stories)\.[jt]sx?$/.test(name)) {
       acc.push(full);
     }
   }
@@ -851,16 +891,47 @@ function staleOwnedRules() {
   const target = join(CWD, ".ai", "rules", "godxjp-ui.md");
   if (!existsSync(target)) return null;
 
-  const stamped = /<!-- godxjp-ui:version ([^\s]+) -->/.exec(readFileSync(target, "utf8"))?.[1];
+  // FOUR states, not two. `!stamped || !installed || stamped === installed` collapsed three very
+  // different situations into one silence, and only ONE of them is genuinely fine:
+  //
+  //   no rule file, consumer never opted into the agent kit  -> silent, and it MUST stay silent.
+  //     Turning this into a finding would make a UI audit into a tool that nags every consumer to
+  //     install an agent kit they did not ask for. (Handled by the existsSync above.)
+  //   rule file present but carrying NO stamp                -> compatibility UNKNOWN, say so.
+  //   installed version unreadable                           -> compatibility UNKNOWN, say so.
+  //   stamp != installed                                     -> stale, the original finding.
+  const contents = readFileSync(target, "utf8");
+  const stamped = /<!-- godxjp-ui:version ([^\s]+) -->/.exec(contents)?.[1];
+
   let installed;
   try {
     installed = JSON.parse(
       readFileSync(join(CWD, "node_modules", "@godxjp", "ui", "package.json"), "utf8"),
     ).version;
   } catch {
-    return null;
+    installed = undefined;
+  }
+
+  if (!stamped || !installed) {
+    // A file the package OWNS, whose provenance cannot be established. That is not the same as
+    // "up to date", and reporting it as such is the whole class of bug this function exists for.
+    return {
+      file: ".ai/rules/godxjp-ui.md",
+      line: 1,
+      rule: "owned-rules-unknown",
+      severity: "warn",
+      message:
+        `This file is written by @godxjp/ui, but its version cannot be established ` +
+        `(${!stamped ? "the file carries no `<!-- godxjp-ui:version … -->` stamp" : "the installed package version could not be read"}). ` +
+        `An agent may be reading guidance from a different major. Refresh it with ` +
+        `\`npx @godxjp/ui init-agent\`, or delete the file if this project does not use the agent kit.`,
+      replacement: null,
+      standard: null,
+      snippet: (stamped ?? "(no stamp)") + " vs " + (installed ?? "(package version unreadable)"),
+    };
   }
-  if (!stamped || !installed || stamped === installed) return null;
+
+  if (stamped === installed) return null;
 
   return {
     file: ".ai/rules/godxjp-ui.md",
@@ -880,12 +951,15 @@ const findings = [];
 const stale = staleOwnedRules();
 if (stale) findings.push(stale);
 let filesScanned = 0;
+/** What was actually OPENED. The summary used to name the selection instead (gh#542). */
+const scannedFiles = [];
 for (const dir of SCAN_DIRS) {
   for (const file of walk(isAbsolute(dir) ? dir : join(CWD, dir))) {
     const rel = relative(CWD, file);
     // Framework test support is executable fixture markup, not a shipped product screen.
     if (SELF && !args.includes("--consumer") && rel.startsWith("src/test/")) continue;
     filesScanned += 1;
+    scannedFiles.push(rel);
     // A primitive implements native controls; asking Input to render Input recurses.
     // Consumer applications and executable docs still receive these composition checks.
     const fileRules =
@@ -902,7 +976,7 @@ for (const dir of SCAN_DIRS) {
     /** Both opt-outs, by line index: the per-line markers and the reason-carrying block. */
     const suppressed = (ruleId, i) =>
       isSuppressed(ruleId, origLines[i], origLines[i - 1]) || inDisabledBlock(ruleId, i);
-    const isJsx = file.endsWith(".tsx");
+    const isJsx = file.endsWith(".tsx") || file.endsWith(".jsx");
     // This compiler output intentionally resolves CSS variables to email-safe literals.
     // gen-email-tokens.mjs --check verifies it against its canonical token sources.
     const compiledEmailTokens =
@@ -1069,11 +1143,37 @@ const warnings = findings.filter((f) => f.severity === "warn");
 // "✓ No UI-standardization violations found." and exited 0 having read nothing at all.
 // …except under `--changed`, where "this branch touched no .tsx" is a clean run, not a
 // misconfigured path. Failing there would make the gate unusable on every backend-only commit.
-if (filesScanned === 0 && CHANGED) {
-  if (!quiet && !asJson) console.log("✓ ui-audit --changed: no .tsx/.jsx changed on this branch.");
+// "This branch touched no UI file" is a clean run — but ONLY if there is nothing else to say.
+//
+// `staleOwnedRules()` runs before the scan loop and pushes its finding into `findings`, and this
+// branch used to exit 0 regardless: a consumer whose package-owned rules were four majors out of
+// date got "✓ no .tsx/.jsx changed" and a clean exit on any commit that happened not to touch a
+// component. Under `--format json` it was worse — the exit came BEFORE anything was written, so
+// stdout was EMPTY and a CI step reading it could not tell that from a pass.
+//
+// Reproduced: rules stamped 19.6.0 against an installed 23.3.0, one README.md changed →
+// `✓ no .tsx/.jsx changed`, exit 0, empty JSON, while `ui-audit src --format json` on the same
+// tree at the same moment reported `owned-rules-stale`.
+//
+// Same defect as the `.jsx` one this file just fixed, one screen further down: a gate declaring
+// itself clean while holding a finding.
+/** `--changed` legitimately opened no file. NOT the same thing as a misconfigured scan path. */
+const changedNoFiles = CHANGED && filesScanned === 0;
+
+if (changedNoFiles && findings.length === 0) {
+  if (asJson) {
+    // ALWAYS emit a valid document on the JSON path. This branch used to exit before writing
+    // anything, so a CI step parsing stdout got an empty string and a zero exit.
+    process.stdout.write(
+      JSON.stringify({ summary: { errors: 0, warnings: 0 }, findings: [] }, null, 2) + "\n",
+    );
+  } else if (!quiet) {
+    console.log("✓ ui-audit --changed: no .tsx/.jsx changed on this branch.");
+  }
   process.exit(0);
 }
-if (filesScanned === 0) {
+
+if (filesScanned === 0 && !CHANGED) {
   const message =
     `ui-audit scanned 0 files — none of [${SCAN_DIRS.join(", ")}] exists (or all were filtered). ` +
     `Pass the directories to scan, e.g. \`node scripts/ui-audit.mjs src docs\`. ` +
@@ -1088,7 +1188,7 @@ if (filesScanned === 0) {
   process.exitCode = 2;
 }
 
-if (filesScanned === 0) {
+if (filesScanned === 0 && !changedNoFiles) {
   // already reported above
 } else if (asJson) {
   process.stdout.write(
@@ -1118,7 +1218,10 @@ if (filesScanned === 0) {
     console.log(`      ${C.dim}${f.snippet}${C.reset}`);
   }
   console.log(
-    `\ngodxjp-ui audit: ${C.red}${errors.length} error(s)${C.reset}, ${C.yellow}${warnings.length} warning(s)${C.reset} across ${SCAN_DIRS.join(", ")}.`,
+    `\ngodxjp-ui audit: ${C.red}${errors.length} error(s)${C.reset}, ${C.yellow}${warnings.length} warning(s)${C.reset}` +
+      (scannedFiles.length > 0
+        ? ` across ${scannedFiles.join(", ")}.`
+        : " — no UI file changed on this branch, but the findings above are not about a file."),
   );
   if (errors.length === 0 && warnings.length === 0) {
     console.log("✓ No UI-standardization violations found.");
@@ -1126,4 +1229,4 @@ if (filesScanned === 0) {
 }
 
 // See the note above --rules: exitCode, so a large JSON report drains fully.
-if (filesScanned > 0) process.exitCode = errors.length > 0 ? 1 : 0;
+if (filesScanned > 0 || changedNoFiles) process.exitCode = errors.length > 0 ? 1 : 0;