@goflag/cli 0.2.11 → 0.2.13

package/dist/cli.js

@@ -9,11 +9,12 @@ import {
   SITE_PROSE_RULES,
   SITE_RULES,
   exitCode,
+  renderPreview,
   renderSummaryTerminal,
   renderTerminal,
   runAudit,
   summarize
-} from "./chunk-CWEJ6EXT.js";
+} from "./chunk-57NVXEJS.js";
 
 // src/report/diff.ts
 function collectFindings(report) {
@@ -313,7 +314,9 @@ var FLAGS = [
     group: "output",
     help: [
       "Roll findings up (dedup by link/rule/code). Pairs",
-      "with --json for a compact, agent-friendly payload."
+      "with --json for a compact, agent-friendly payload.",
+      "Not available with --baseline: there the diff is the",
+      "answer, and --report writes the full report."
     ],
     takesValue: false,
     apply: ({ parsed }) => {
@@ -754,6 +757,16 @@ var COMMANDS = [
       "table this help is rendered from, so the two cannot",
       "disagree."
     ]
+  },
+  {
+    name: "preview",
+    usage: "preview <url>",
+    help: [
+      "Write .goflag/preview.html \u2014 the page's share cards",
+      "as Google, Open Graph, X, LinkedIn, Slack, Discord",
+      "and WhatsApp make them, each with the rigor of its",
+      "source. Never gates: exits 0 unless the run failed."
+    ]
   }
 ];
 var DESCRIPTION_COLUMN = 25;
@@ -772,8 +785,9 @@ function renderHelp() {
   ];
   for (const command of COMMANDS) {
     const pad = " ".repeat(28);
+    const label = command.usage ?? command.name;
     command.help.forEach((line, i) => {
-      lines.push(i === 0 ? `  goflag ${command.name.padEnd(19)}${line}` : `${pad}${line}`);
+      lines.push(i === 0 ? `  goflag ${label.padEnd(19)}${line}` : `${pad}${line}`);
     });
   }
   lines.push("", "Options:");
@@ -787,6 +801,9 @@ function renderHelp() {
 // src/cli-args.ts
 var HELP = renderHelp();
 var COMMAND_NAMES = COMMANDS.map((c) => c.name);
+function isCommand(arg) {
+  return COMMAND_NAMES.includes(arg);
+}
 function parseArgs(argv) {
   const parsed = {
     json: false,
@@ -819,10 +836,25 @@ function parseArgs(argv) {
       continue;
     }
     if (arg && arg.startsWith("-")) throw new Error(`unknown option: ${arg}`);
-    if (arg && COMMAND_NAMES.includes(arg) && i === 0) parsed.command = arg;
+    if (arg && isCommand(arg) && !parsed.url && !parsed.command) parsed.command = arg;
     else if (arg && !parsed.url) parsed.url = arg;
     else if (arg) throw new Error(`unexpected argument: ${arg}`);
   }
+  if (parsed.command === "preview") {
+    const inert = [
+      parsed.json && "--json",
+      parsed.summary && "--summary",
+      parsed.baseline && "--baseline",
+      parsed.updateBaseline && "--update-baseline",
+      parsed.regressionsOnly && "--regressions-only",
+      parsed.maxDebt !== void 0 && "--max-debt"
+    ].filter((flag) => typeof flag === "string");
+    if (inert.length > 0) {
+      throw new Error(
+        `preview renders what the crawl saw, it does not gate or reformat, so ${inert.join(", ")} would change nothing: drop them, or ask for the JSON with --report <file>`
+      );
+    }
+  }
   if (parsed.updateBaseline && !parsed.baseline) {
     throw new Error("--update-baseline needs a --baseline <file> to write to");
   }
@@ -834,6 +866,11 @@ function parseArgs(argv) {
   if (parsed.regressionsOnly && !parsed.baseline) {
     throw new Error("--regressions-only needs a --baseline <file> to compare against");
   }
+  if (parsed.summary && parsed.baseline) {
+    throw new Error(
+      "--summary cannot summarise a diff, and --baseline prints the diff: drop --summary, or use --report <file> to keep the full report"
+    );
+  }
   return parsed;
 }
 
@@ -1370,13 +1407,17 @@ async function readVersion() {
     return "0.0.0";
   }
 }
-async function writeJson(path, value) {
+async function writeText(path, contents) {
   const { mkdirSync, writeFileSync } = await import("fs");
   const { dirname } = await import("path");
   mkdirSync(dirname(path), { recursive: true });
-  writeFileSync(path, `${JSON.stringify(value, null, 2)}
-`, "utf8");
+  writeFileSync(path, contents, "utf8");
+}
+async function writeJson(path, value) {
+  await writeText(path, `${JSON.stringify(value, null, 2)}
+`);
 }
+var PREVIEW_PATH = ".goflag/preview.html";
 async function main() {
   let args;
   try {
@@ -1433,7 +1474,14 @@ ${HELP}
       });
     }
     logger.note(`goflag: auditing ${args.url} \u2026`);
-    report = await runAudit(args.url, { ...args.options, onProgress: logger.onProgress });
+    report = await runAudit(args.url, {
+      ...args.options,
+      // The preview is drawn from what the pages declared, and only this
+      // section carries that. Nothing else asks for it, so nothing else pays
+      // for it.
+      ...args.command === "preview" ? { extractions: true } : {},
+      onProgress: logger.onProgress
+    });
     logger.stop();
   } catch (err) {
     logger.stop();
@@ -1453,6 +1501,22 @@ goflag: retry, or pass --no-sitemap to audit by crawling on purpose.
     );
     return 2;
   }
+  if (args.command === "preview") {
+    if (args.report) {
+      await writeJson(args.report, report);
+      process.stderr.write(`goflag: report written to ${args.report}
+`);
+    }
+    await writeText(PREVIEW_PATH, renderPreview(report));
+    const pages = report.extractions?.length ?? 0;
+    process.stderr.write(
+      `goflag: preview written to ${PREVIEW_PATH} \u2014 ${pages} page${pages === 1 ? "" : "s"}
+`
+    );
+    process.stdout.write(`${PREVIEW_PATH}
+`);
+    return 0;
+  }
   if (args.baseline) {
     const { existsSync, readFileSync } = await import("fs");
     if (existsSync(args.baseline) || !args.updateBaseline) {
@@ -1468,6 +1532,11 @@ goflag: retry, or pass --no-sitemap to audit by crawling on purpose.
       }
     }
   }
+  if (args.report) {
+    await writeJson(args.report, report);
+    process.stderr.write(`goflag: report written to ${args.report}
+`);
+  }
   if (args.updateBaseline && args.baseline) {
     await writeJson(args.baseline, report);
     const total2 = totalFindings(report);
@@ -1493,11 +1562,6 @@ goflag: retry, or pass --no-sitemap to audit by crawling on purpose.
     );
     return 0;
   }
-  if (args.report) {
-    await writeJson(args.report, report);
-    process.stderr.write(`goflag: report written to ${args.report}
-`);
-  }
   if (report.diff && !args.json) {
     process.stdout.write(`${renderDiffTerminal(report.diff, { color: args.color })}
 `);
@@ -1537,9 +1601,25 @@ goflag: retry, or pass --no-sitemap to audit by crawling on purpose.
   }
   return exitCode(report, args.failOn);
 }
-main().then((code) => process.exit(code)).catch((err) => {
+function flush(stream) {
+  return new Promise((resolve) => {
+    if (stream.writableEnded || stream.destroyed) return resolve();
+    stream.write("", () => resolve());
+  });
+}
+var undelivered = false;
+for (const stream of [process.stdout, process.stderr]) {
+  stream.on("error", (err) => {
+    if (err.code !== "EPIPE") undelivered = true;
+  });
+}
+main().then(async (code) => {
+  await Promise.all([flush(process.stdout), flush(process.stderr)]);
+  process.exit(undelivered ? 2 : code);
+}).catch(async (err) => {
   process.stderr.write(`goflag: unexpected error: ${err.stack ?? err}
 `);
+  await flush(process.stderr);
   process.exit(2);
 });
 //# sourceMappingURL=cli.js.map