@jwilger/pi-development-system 0.8.6 → 0.8.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jwilger/pi-development-system",
-  "version": "0.8.6",
+  "version": "0.8.8",
   "description": "A pi extension package representing a seasoned approach to software development using a full AI SDLC.",
   "keywords": [
     "pi-package"

package/src/core/commit-command.ts

@@ -1,12 +1,17 @@
 import { splitLines } from "./git-intent.ts";
-import { resolveGit } from "./git-invocations.ts";
+import { opaqueMentions, resolveGit } from "./git-invocations.ts";
 import { stripHeredocs } from "./heredoc.ts";
 
 export type CommitExtraction =
   | { readonly kind: "not-commit" }
   | { readonly kind: "message"; readonly message: string }
   | { readonly kind: "file"; readonly path: string }
-  | { readonly kind: "unknown"; readonly trailers: readonly string[] };
+  | {
+      readonly kind: "unknown";
+      readonly trailers: readonly string[];
+      /** A `-m` value is a substitution or variable: the message exists but cannot be read. */
+      readonly opaqueMessage: boolean;
+    };
 
 type Options = {
   messages: string[];
@@ -77,9 +82,10 @@ function readOptions(args: readonly string[]): Options {
   return options;
 }
 
-const unknown = (trailers: readonly string[] = []): CommitExtraction => ({
+const unknown = (trailers: readonly string[] = [], opaqueMessage = false): CommitExtraction => ({
   kind: "unknown",
   trailers,
+  opaqueMessage,
 });
 
 const STDIN_PATHS = new Set(["-", "/dev/stdin", "/proc/self/fd/0"]);
@@ -104,7 +110,7 @@ function extractOne(args: readonly string[], heredoc: string | undefined): Commi
   if (options.file !== undefined) return { kind: "file", path: options.file };
   const parts = [...options.messages];
   if (options.opaque) {
-    if (heredoc === undefined) return unknown(options.trailers);
+    if (heredoc === undefined) return unknown(options.trailers, true);
     parts.push(heredoc);
   }
   if (parts.length === 0) return unknown(options.trailers);
@@ -120,7 +126,7 @@ export function extractCommits(command: string): CommitExtraction[] {
   const found = resolution.invocations.flatMap((g) =>
     g.sub === "commit" ? [extractOne(g.args, heredocFrom(lines, g.line, bodies))] : [],
   );
-  const hidden = resolution.opaque && /\bcommit\b/.test(command);
+  const hidden = opaqueMentions(resolution, "commit");
   return hidden ? [...found, unknown()] : found;
 }
 

package/src/core/git-invocations.ts

@@ -27,12 +27,13 @@ export type GitInvocation = {
 export type GitResolution = {
   readonly invocations: readonly GitInvocation[];
   /** True when git may run through something the parser cannot see into (xargs, `$CMD`, …). */
-  readonly opaque: boolean;
+  /** Words of segments that may run git in a way that cannot be read (`$GIT push`, `xargs git …`). */
+  readonly opaque: readonly string[];
 };
 
 type Collector = {
   invocations: GitInvocation[];
-  opaque: boolean;
+  opaque: string[];
   dir: string | undefined;
   line: number;
 };
@@ -58,7 +59,7 @@ function visitGit(rest: readonly string[], into: Collector): void {
   }
   const sub = rest[j];
   if (sub === undefined) return;
-  if (sub.startsWith("$")) into.opaque = true;
+  if (sub.startsWith("$")) into.opaque.push(...rest);
   else {
     const args = rest.slice(j + 1);
     const line = into.line;
@@ -89,11 +90,12 @@ function visitSegment(tokens: readonly string[], into: Collector): void {
   if (head === undefined) return;
   const rest = tokens.slice(firstCommand(tokens) + 1);
   const base = basename(head);
-  if (head.startsWith("$")) into.opaque = true;
+  if (head.startsWith("$")) into.opaque.push(...tokens);
   else if (base === "cd") visitCd(rest, into);
   else if (SHELLS.has(base) || base === "eval") visitScript(base, rest, into);
-  else if (OPAQUE.has(base)) into.opaque = into.opaque || gitIndex(rest) >= 0;
-  else if (base === "git") visitGit(rest, into);
+  else if (OPAQUE.has(base)) {
+    if (gitIndex(rest) >= 0) into.opaque.push(...rest);
+  } else if (base === "git") visitGit(rest, into);
   else visitWrapped(base, rest, into);
 }
 
@@ -105,7 +107,7 @@ function visitWrapped(base: string, rest: readonly string[], into: Collector): v
 
 function merge(into: Collector, other: GitResolution): void {
   into.invocations.push(...other.invocations.map((g) => ({ ...g, line: into.line })));
-  if (other.opaque) into.opaque = true;
+  into.opaque.push(...other.opaque);
 }
 
 /**
@@ -113,7 +115,7 @@ function merge(into: Collector, other: GitResolution): void {
  * `timeout`, `if … then`), `bash -c`/`eval` scripts and `$(…)` substitutions. Heredoc bodies are data.
  */
 export function resolveGit(command: string): GitResolution {
-  const into: Collector = { invocations: [], opaque: false, dir: undefined, line: 0 };
+  const into: Collector = { invocations: [], opaque: [], dir: undefined, line: 0 };
   let heredocEnd: string | undefined;
   // Heredoc bodies are data (an apostrophe in one must not unbalance quote tracking).
   const lines = splitLines(stripHeredocs(command).rest);
@@ -129,3 +131,7 @@ export function resolveGit(command: string): GitResolution {
   }
   return into;
 }
+
+/** Whether something unreadable in the command may be running `git <subcommand>`. */
+export const opaqueMentions = (resolution: GitResolution, subcommand: string): boolean =>
+  resolution.opaque.includes(subcommand);

package/src/core/push-command.ts

@@ -1,4 +1,4 @@
-import { resolveGit } from "./git-invocations.ts";
+import { opaqueMentions, resolveGit } from "./git-invocations.ts";
 
 export type PushTarget = {
   readonly remote: string | undefined;
@@ -73,7 +73,7 @@ export function pushTargets(command: string): PushTarget[] {
     g.sub === "push" && !isDryRun(g.args) ? [toTarget(g.args, g.dir)] : [],
   );
   // git run through something opaque (xargs, `$CMD`): a push cannot be ruled out, so assume the worst.
-  const opaquePush = resolution.opaque && /\bpush\b/.test(command);
+  const opaquePush = opaqueMentions(resolution, "push");
   return opaquePush
     ? [
         ...targets,

package/src/gates/commit-guard.ts

@@ -170,6 +170,12 @@ export function registerCommitGuard(deps: CommitGuardDeps): void {
         why: "the message file cannot be read before the commit runs, so its rationale cannot be checked; use -m or a heredoc",
       });
     }
+    if (extractions.some((e) => e.kind === "unknown" && e.opaqueMessage)) {
+      all.push({
+        gate: RATIONALE,
+        why: "the message is built by a substitution or variable and cannot be checked; use a literal -m or a heredoc",
+      });
+    }
     for (const message of known) {
       for (const need of await needsOf(deps, ctx, message, command)) {
         if (!all.some((n) => n.gate === need.gate)) all.push(need);