@agent-scope/cli 1.15.0 → 1.16.0

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 // src/program.ts
-import { readFileSync as readFileSync10 } from "fs";
+import { readFileSync as readFileSync11 } from "fs";
 import { generateTest, loadTrace } from "@agent-scope/playwright";
 import { Command as Command9 } from "commander";
 
@@ -1174,9 +1174,9 @@ function createRL() {
   });
 }
 async function ask(rl, question) {
-  return new Promise((resolve15) => {
+  return new Promise((resolve16) => {
     rl.question(question, (answer) => {
-      resolve15(answer.trim());
+      resolve16(answer.trim());
     });
   });
 }
@@ -2485,8 +2485,8 @@ Available: ${available}`
         wastedRenders: opts.wastedRenders
       });
       await shutdownPool2();
-      const fmt = resolveFormat2(opts.format);
-      if (fmt === "json") {
+      const fmt2 = resolveFormat2(opts.format);
+      if (fmt2 === "json") {
         process.stdout.write(`${JSON.stringify(instrumentRoot, null, 2)}
 `);
       } else {
@@ -3182,12 +3182,12 @@ Available: ${available}`
           );
           return;
         }
-        const fmt = resolveSingleFormat(opts.format);
-        if (fmt === "json") {
+        const fmt2 = resolveSingleFormat(opts.format);
+        if (fmt2 === "json") {
           const json = formatRenderJson(componentName, props, result);
           process.stdout.write(`${JSON.stringify(json, null, 2)}
 `);
-        } else if (fmt === "file") {
+        } else if (fmt2 === "file") {
           const dir = resolve8(process.cwd(), DEFAULT_OUTPUT_DIR);
           mkdirSync3(dir, { recursive: true });
           const outPath = resolve8(dir, `${componentName}.png`);
@@ -3308,8 +3308,8 @@ Available: ${available}`
           process.stderr.write(`Sprite sheet saved to ${spritePath}
 `);
         }
-        const fmt = resolveMatrixFormat(opts.format, opts.sprite !== void 0);
-        if (fmt === "file") {
+        const fmt2 = resolveMatrixFormat(opts.format, opts.sprite !== void 0);
+        if (fmt2 === "file") {
           const { SpriteSheetGenerator: SpriteSheetGenerator2 } = await import("@agent-scope/render");
           const gen = new SpriteSheetGenerator2();
           const sheet = await gen.generate(result);
@@ -3322,10 +3322,10 @@ Available: ${available}`
             `\u2713 ${componentName} matrix (${result.stats.totalCells} cells) \u2192 ${relPath} (${result.stats.wallClockTimeMs.toFixed(0)}ms total)
 `
           );
-        } else if (fmt === "json") {
+        } else if (fmt2 === "json") {
           process.stdout.write(`${JSON.stringify(formatMatrixJson(result), null, 2)}
 `);
-        } else if (fmt === "png") {
+        } else if (fmt2 === "png") {
           if (opts.sprite !== void 0) {
           } else {
             const { SpriteSheetGenerator: SpriteSheetGenerator2 } = await import("@agent-scope/render");
@@ -3333,9 +3333,9 @@ Available: ${available}`
             const sheet = await gen.generate(result);
             process.stdout.write(sheet.png);
           }
-        } else if (fmt === "html") {
+        } else if (fmt2 === "html") {
           process.stdout.write(formatMatrixHtml(componentName, result));
-        } else if (fmt === "csv") {
+        } else if (fmt2 === "csv") {
           process.stdout.write(formatMatrixCsv(componentName, result));
         }
       } catch (err) {
@@ -3643,12 +3643,12 @@ async function runBaseline(options = {}) {
   mkdirSync4(rendersDir, { recursive: true });
   let manifest;
   if (manifestPath !== void 0) {
-    const { readFileSync: readFileSync11 } = await import("fs");
+    const { readFileSync: readFileSync12 } = await import("fs");
     const absPath = resolve9(rootDir, manifestPath);
     if (!existsSync6(absPath)) {
       throw new Error(`Manifest not found at ${absPath}.`);
     }
-    manifest = JSON.parse(readFileSync11(absPath, "utf-8"));
+    manifest = JSON.parse(readFileSync12(absPath, "utf-8"));
     process.stderr.write(`Loaded manifest from ${manifestPath}
 `);
   } else {
@@ -4290,6 +4290,139 @@ function registerDiffSubCommand(reportCmd) {
   );
 }
 
+// src/report/pr-comment.ts
+import { existsSync as existsSync8, readFileSync as readFileSync7, writeFileSync as writeFileSync8 } from "fs";
+import { resolve as resolve11 } from "path";
+var STATUS_BADGE = {
+  added: "\u2705 added",
+  removed: "\u{1F5D1}\uFE0F removed",
+  unchanged: "\u2014 unchanged",
+  compliance_regressed: "\u274C regressed",
+  compliance_improved: "\u{1F4C8} improved",
+  size_changed: "\u{1F4D0} resized"
+};
+function fmt(n) {
+  return `${(n * 100).toFixed(1)}%`;
+}
+function fmtDelta(delta) {
+  if (delta === null) return "\u2014";
+  const sign = delta >= 0 ? "+" : "";
+  return `${sign}${(delta * 100).toFixed(1)}%`;
+}
+function fmtDimensions(d) {
+  if (d === null) return "\u2014";
+  return `${d.width} \xD7 ${d.height}`;
+}
+function complianceDeltaArrow(diff) {
+  const delta = diff.currentAggregateCompliance - diff.baselineAggregateCompliance;
+  if (Math.abs(delta) < 5e-4) return `\u2192 ${fmt(diff.currentAggregateCompliance)} (no change)`;
+  const arrow = delta > 0 ? "\u2191" : "\u2193";
+  return `${arrow} ${fmtDelta(delta)}`;
+}
+function formatPrComment(diff) {
+  const { summary, components } = diff;
+  const lines = [];
+  const hasRegressions = diff.hasRegressions;
+  const headerEmoji = hasRegressions ? "\u26A0\uFE0F" : "\u2705";
+  lines.push(`## ${headerEmoji} Scope Report`);
+  lines.push("");
+  lines.push("| Metric | Value |");
+  lines.push("|---|---|");
+  lines.push(`| Baseline compliance | ${fmt(diff.baselineAggregateCompliance)} |`);
+  lines.push(`| Current compliance | ${fmt(diff.currentAggregateCompliance)} |`);
+  lines.push(`| Delta | ${complianceDeltaArrow(diff)} |`);
+  lines.push(
+    `| Components | ${summary.total} total \xB7 ${summary.added} added \xB7 ${summary.removed} removed \xB7 ${summary.complianceRegressed} regressed |`
+  );
+  if (summary.renderFailed > 0) {
+    lines.push(`| Render failures | ${summary.renderFailed} |`);
+  }
+  lines.push("");
+  const changed = components.filter((c) => c.status !== "unchanged");
+  const unchanged = components.filter((c) => c.status === "unchanged");
+  if (changed.length > 0) {
+    lines.push("### Changes");
+    lines.push("");
+    lines.push("| Component | Status | Compliance \u0394 | Dimensions |");
+    lines.push("|---|---|---|---|");
+    for (const c of changed) {
+      const badge = STATUS_BADGE[c.status];
+      const delta = fmtDelta(c.complianceDelta);
+      const dims = fmtDimensions(c.currentDimensions ?? c.baselineDimensions);
+      lines.push(`| \`${c.name}\` | ${badge} | ${delta} | ${dims} |`);
+    }
+    lines.push("");
+  }
+  if (unchanged.length > 0) {
+    lines.push(
+      `<details><summary>${unchanged.length} unchanged component${unchanged.length === 1 ? "" : "s"}</summary>`
+    );
+    lines.push("");
+    lines.push("| Component | Compliance |");
+    lines.push("|---|---|");
+    for (const c of unchanged) {
+      lines.push(
+        `| \`${c.name}\` | ${c.currentCompliance !== null ? fmt(c.currentCompliance) : "\u2014"} |`
+      );
+    }
+    lines.push("");
+    lines.push("</details>");
+    lines.push("");
+  }
+  lines.push(
+    `> Generated by [Scope](https://github.com/FlatFilers/Scope) \xB7 diffed at ${diff.diffedAt}`
+  );
+  return lines.join("\n");
+}
+function loadDiffResult(filePath) {
+  const abs = resolve11(filePath);
+  if (!existsSync8(abs)) {
+    throw new Error(`DiffResult file not found: ${abs}`);
+  }
+  let raw;
+  try {
+    raw = readFileSync7(abs, "utf-8");
+  } catch (err) {
+    throw new Error(
+      `Failed to read DiffResult file: ${err instanceof Error ? err.message : String(err)}`
+    );
+  }
+  let parsed;
+  try {
+    parsed = JSON.parse(raw);
+  } catch {
+    throw new Error(`DiffResult file is not valid JSON: ${abs}`);
+  }
+  if (typeof parsed !== "object" || parsed === null || !("diffedAt" in parsed) || !("components" in parsed) || !("summary" in parsed)) {
+    throw new Error(
+      `DiffResult file does not match expected shape (missing diffedAt/components/summary): ${abs}`
+    );
+  }
+  return parsed;
+}
+function registerPrCommentSubCommand(reportCmd) {
+  reportCmd.command("pr-comment").description(
+    "Format a DiffResult JSON file as a GitHub PR comment (Markdown, written to stdout)"
+  ).requiredOption("-i, --input <path>", "Path to DiffResult JSON (from scope report diff --json)").option("-o, --output <path>", "Write comment to file instead of stdout").action(async (opts) => {
+    try {
+      const diff = loadDiffResult(opts.input);
+      const comment = formatPrComment(diff);
+      if (opts.output !== void 0) {
+        writeFileSync8(resolve11(opts.output), comment, "utf-8");
+        process.stderr.write(`PR comment written to ${opts.output}
+`);
+      } else {
+        process.stdout.write(`${comment}
+`);
+      }
+    } catch (err) {
+      process.stderr.write(`Error: ${err instanceof Error ? err.message : String(err)}
+`);
+      process.exit(1);
+    }
+  });
+}
+
 // src/tree-formatter.ts
 var BRANCH2 = "\u251C\u2500\u2500 ";
 var LAST_BRANCH2 = "\u2514\u2500\u2500 ";
@@ -4570,8 +4703,8 @@ function buildStructuredReport(report) {
 }
 
 // src/tokens/commands.ts
-import { existsSync as existsSync10, readFileSync as readFileSync9 } from "fs";
-import { resolve as resolve14 } from "path";
+import { existsSync as existsSync11, readFileSync as readFileSync10 } from "fs";
+import { resolve as resolve15 } from "path";
 import {
   parseTokenFileSync as parseTokenFileSync2,
   TokenParseError,
@@ -4582,23 +4715,23 @@ import {
 import { Command as Command8 } from "commander";
 
 // src/tokens/compliance.ts
-import { existsSync as existsSync8, readFileSync as readFileSync7 } from "fs";
-import { resolve as resolve11 } from "path";
+import { existsSync as existsSync9, readFileSync as readFileSync8 } from "fs";
+import { resolve as resolve12 } from "path";
 import {
   ComplianceEngine as ComplianceEngine4,
   TokenResolver as TokenResolver4
 } from "@agent-scope/tokens";
 var DEFAULT_STYLES_PATH = ".reactscope/compliance-styles.json";
 function loadStylesFile(stylesPath) {
-  const absPath = resolve11(process.cwd(), stylesPath);
-  if (!existsSync8(absPath)) {
+  const absPath = resolve12(process.cwd(), stylesPath);
+  if (!existsSync9(absPath)) {
     throw new Error(
       `Compliance styles file not found at ${absPath}.
 Run \`scope render all\` first to generate component styles, or use --styles to specify a path.
 Expected format: { "ComponentName": { colors: {}, spacing: {}, typography: {}, borders: {}, shadows: {} } }`
     );
   }
-  const raw = readFileSync7(absPath, "utf-8");
+  const raw = readFileSync8(absPath, "utf-8");
   let parsed;
   try {
     parsed = JSON.parse(raw);
@@ -4758,8 +4891,8 @@ function registerCompliance(tokensCmd) {
 }
 
 // src/tokens/export.ts
-import { existsSync as existsSync9, readFileSync as readFileSync8, writeFileSync as writeFileSync8 } from "fs";
-import { resolve as resolve12 } from "path";
+import { existsSync as existsSync10, readFileSync as readFileSync9, writeFileSync as writeFileSync9 } from "fs";
+import { resolve as resolve13 } from "path";
 import {
   exportTokens,
   parseTokenFileSync,
@@ -4772,21 +4905,21 @@ var CONFIG_FILE = "reactscope.config.json";
 var SUPPORTED_FORMATS = ["css", "ts", "scss", "tailwind", "flat-json", "figma"];
 function resolveTokenFilePath2(fileFlag) {
   if (fileFlag !== void 0) {
-    return resolve12(process.cwd(), fileFlag);
+    return resolve13(process.cwd(), fileFlag);
   }
-  const configPath = resolve12(process.cwd(), CONFIG_FILE);
-  if (existsSync9(configPath)) {
+  const configPath = resolve13(process.cwd(), CONFIG_FILE);
+  if (existsSync10(configPath)) {
     try {
-      const raw = readFileSync8(configPath, "utf-8");
+      const raw = readFileSync9(configPath, "utf-8");
       const config = JSON.parse(raw);
       if (typeof config === "object" && config !== null && "tokens" in config && typeof config.tokens === "object" && config.tokens !== null && typeof config.tokens?.file === "string") {
         const file = config.tokens.file;
-        return resolve12(process.cwd(), file);
+        return resolve13(process.cwd(), file);
       }
     } catch {
     }
   }
-  return resolve12(process.cwd(), DEFAULT_TOKEN_FILE);
+  return resolve13(process.cwd(), DEFAULT_TOKEN_FILE);
 }
 function createTokensExportCommand() {
   return new Command7("export").description("Export design tokens to a downstream format").requiredOption("--format <fmt>", `Output format: ${SUPPORTED_FORMATS.join(", ")}`).option("--file <path>", "Path to token file (overrides config)").option("--out <path>", "Write output to file instead of stdout").option("--prefix <prefix>", "CSS/SCSS: prefix for variable names (e.g. 'scope')").option("--selector <selector>", "CSS: custom root selector (default: ':root')").option(
@@ -4805,13 +4938,13 @@ Supported formats: ${SUPPORTED_FORMATS.join(", ")}
       const format = opts.format;
       try {
         const filePath = resolveTokenFilePath2(opts.file);
-        if (!existsSync9(filePath)) {
+        if (!existsSync10(filePath)) {
           throw new Error(
             `Token file not found at ${filePath}.
 Create a reactscope.tokens.json file or use --file to specify a path.`
           );
         }
-        const raw = readFileSync8(filePath, "utf-8");
+        const raw = readFileSync9(filePath, "utf-8");
         const { tokens, rawFile } = parseTokenFileSync(raw);
         let themesMap;
         if (opts.theme !== void 0) {
@@ -4850,8 +4983,8 @@ Available themes: ${themeNames.join(", ")}`
           themes: themesMap
         });
         if (opts.out !== void 0) {
-          const outPath = resolve12(process.cwd(), opts.out);
-          writeFileSync8(outPath, output, "utf-8");
+          const outPath = resolve13(process.cwd(), opts.out);
+          writeFileSync9(outPath, output, "utf-8");
           process.stderr.write(`Exported ${tokens.length} tokens to ${outPath}
 `);
         } else {
@@ -4965,8 +5098,8 @@ ${formatImpactSummary(report)}
 }
 
 // src/tokens/preview.ts
-import { mkdirSync as mkdirSync5, writeFileSync as writeFileSync9 } from "fs";
-import { resolve as resolve13 } from "path";
+import { mkdirSync as mkdirSync5, writeFileSync as writeFileSync10 } from "fs";
+import { resolve as resolve14 } from "path";
 import { BrowserPool as BrowserPool7, SpriteSheetGenerator } from "@agent-scope/render";
 import { ComplianceEngine as ComplianceEngine6, ImpactAnalyzer as ImpactAnalyzer2, TokenResolver as TokenResolver7 } from "@agent-scope/tokens";
 var DEFAULT_STYLES_PATH3 = ".reactscope/compliance-styles.json";
@@ -5147,10 +5280,10 @@ function registerPreview(tokensCmd) {
         });
         const spriteResult = await generator.generate(matrixResult);
         const tokenLabel = tokenPath.replace(/\./g, "-");
-        const outputPath = opts.output ?? resolve13(process.cwd(), DEFAULT_OUTPUT_DIR2, `preview-${tokenLabel}.png`);
-        const outputDir = resolve13(outputPath, "..");
+        const outputPath = opts.output ?? resolve14(process.cwd(), DEFAULT_OUTPUT_DIR2, `preview-${tokenLabel}.png`);
+        const outputDir = resolve14(outputPath, "..");
         mkdirSync5(outputDir, { recursive: true });
-        writeFileSync9(outputPath, spriteResult.png);
+        writeFileSync10(outputPath, spriteResult.png);
         const useJson = opts.format === "json" || opts.format !== "text" && !isTTY();
         if (useJson) {
           process.stdout.write(
@@ -5209,30 +5342,30 @@ function buildTable2(headers, rows) {
 }
 function resolveTokenFilePath(fileFlag) {
   if (fileFlag !== void 0) {
-    return resolve14(process.cwd(), fileFlag);
+    return resolve15(process.cwd(), fileFlag);
   }
-  const configPath = resolve14(process.cwd(), CONFIG_FILE2);
-  if (existsSync10(configPath)) {
+  const configPath = resolve15(process.cwd(), CONFIG_FILE2);
+  if (existsSync11(configPath)) {
     try {
-      const raw = readFileSync9(configPath, "utf-8");
+      const raw = readFileSync10(configPath, "utf-8");
       const config = JSON.parse(raw);
       if (typeof config === "object" && config !== null && "tokens" in config && typeof config.tokens === "object" && config.tokens !== null && typeof config.tokens?.file === "string") {
         const file = config.tokens.file;
-        return resolve14(process.cwd(), file);
+        return resolve15(process.cwd(), file);
       }
     } catch {
     }
   }
-  return resolve14(process.cwd(), DEFAULT_TOKEN_FILE2);
+  return resolve15(process.cwd(), DEFAULT_TOKEN_FILE2);
 }
 function loadTokens(absPath) {
-  if (!existsSync10(absPath)) {
+  if (!existsSync11(absPath)) {
     throw new Error(
       `Token file not found at ${absPath}.
 Create a reactscope.tokens.json file or use --file to specify a path.`
     );
   }
-  const raw = readFileSync9(absPath, "utf-8");
+  const raw = readFileSync10(absPath, "utf-8");
   return parseTokenFileSync2(raw);
 }
 function getRawValue(node, segments) {
@@ -5446,13 +5579,13 @@ function registerValidate(tokensCmd) {
   ).option("--file <path>", "Path to token file (overrides config)").option("--format <fmt>", "Output format: json or text (default: auto-detect)").action((opts) => {
     try {
       const filePath = resolveTokenFilePath(opts.file);
-      if (!existsSync10(filePath)) {
+      if (!existsSync11(filePath)) {
         throw new Error(
           `Token file not found at ${filePath}.
 Create a reactscope.tokens.json file or use --file to specify a path.`
         );
       }
-      const raw = readFileSync9(filePath, "utf-8");
+      const raw = readFileSync10(filePath, "utf-8");
       const useJson = opts.format === "json" || opts.format !== "text" && !isTTY2();
       const errors = [];
       let parsed;
@@ -5610,7 +5743,7 @@ function createProgram(options = {}) {
     }
   );
   program2.command("generate").description("Generate a Playwright test from a Scope trace file").argument("<trace>", "Path to a serialized Scope trace (.json)").option("-o, --output <path>", "Output file path", "scope.spec.ts").option("-d, --description <text>", "Test description").action((tracePath, opts) => {
-    const raw = readFileSync10(tracePath, "utf-8");
+    const raw = readFileSync11(tracePath, "utf-8");
     const trace = loadTrace(raw);
     const source = generateTest(trace, {
       description: opts.description,
@@ -5629,6 +5762,7 @@ function createProgram(options = {}) {
   if (existingReportCmd !== void 0) {
     registerBaselineSubCommand(existingReportCmd);
     registerDiffSubCommand(existingReportCmd);
+    registerPrCommentSubCommand(existingReportCmd);
   }
   return program2;
 }