executable-stories-formatters 0.7.7 → 0.7.8

package/dist/cli.js

@@ -15813,11 +15813,11 @@ var CucumberHtmlFormatter = class {
     for (const envelope of envelopes) {
       const accepted = htmlStream.write(envelope);
       if (!accepted) {
-        await new Promise((resolve7) => htmlStream.once("drain", resolve7));
+        await new Promise((resolve8) => htmlStream.once("drain", resolve8));
       }
     }
-    await new Promise((resolve7, reject) => {
-      collector.on("finish", resolve7);
+    await new Promise((resolve8, reject) => {
+      collector.on("finish", resolve8);
       collector.on("error", reject);
       htmlStream.end();
     });
@@ -17973,6 +17973,37 @@ function listScenarios(args, _deps) {
     }));
     return JSON.stringify(items, null, 2);
   }
+  if (format === "csv") {
+    const header = "id,scenario,status,sourceFile,sourceLine,tags";
+    const rows = testCases.map((tc) => {
+      const fields = [
+        tc.id,
+        tc.story.scenario,
+        tc.status,
+        tc.sourceFile,
+        String(tc.sourceLine),
+        tc.tags.join(" ")
+      ];
+      return fields.map((f) => {
+        if (f.includes(",") || f.includes('"') || f.includes("\n")) {
+          return `"${f.replace(/"/g, '""')}"`;
+        }
+        return f;
+      }).join(",");
+    });
+    return [header, ...rows].join("\n");
+  }
+  if (format === "markdown-table") {
+    const header = "| Status | Scenario | Location | Tags |";
+    const divider = "|--------|----------|----------|------|";
+    const rows = testCases.map((tc) => {
+      const icon = STATUS_ICONS[tc.status] ?? "?";
+      const location = `${tc.sourceFile}:${tc.sourceLine}`;
+      const tags = tc.tags.map((t) => `@${t}`).join(" ");
+      return `| ${icon} | ${tc.story.scenario} | ${location} | ${tags} |`;
+    });
+    return [header, divider, ...rows].join("\n");
+  }
   if (testCases.length === 0) {
     return "No scenarios found.";
   }
@@ -18444,6 +18475,22 @@ function copyDirRecursive(src, dest) {
   }
 }
 
+// src/config.ts
+import { existsSync as existsSync6 } from "fs";
+import { resolve as resolve6 } from "path";
+async function loadConfig(configPath) {
+  const resolved = configPath ? resolve6(configPath) : resolve6(process.cwd(), "executable-stories.config.js");
+  if (!existsSync6(resolved)) return {};
+  const mod = await import(resolved);
+  const config = mod.default;
+  if (!config || typeof config !== "object" || Array.isArray(config)) {
+    throw new Error(
+      `Config file at ${resolved} must export a default object. Got: ${typeof config}`
+    );
+  }
+  return config;
+}
+
 // src/cli.ts
 var EXIT_SUCCESS = 0;
 var EXIT_SCHEMA_VALIDATION = 1;
@@ -18470,7 +18517,7 @@ SUBCOMMANDS
   init-astro Scaffold an Astro Starlight docs site for story output
 
 OPTIONS
-  --format <formats>            Comma-separated formats (default: html)
+  --format <formats>            Comma-separated formats: html, markdown, junit, cucumber-json, cucumber-messages, cucumber-html, astro, or custom names from config (default: html)
                                   astro             Starlight-compatible Markdown (for Astro docs sites)
                                   html              Custom HTML report (accessible, dark mode, mermaid)
                                   cucumber-html     Official Cucumber HTML report
@@ -18478,6 +18525,7 @@ OPTIONS
                                   junit             JUnit XML
                                   cucumber-json     Cucumber JSON
                                   cucumber-messages Raw NDJSON (Cucumber Messages)
+  --config <path>               Path to executable-stories.config.js (default: ./executable-stories.config.js)
   --input-type <type>           Input type: raw, canonical, or ndjson (default: raw)
   --output-dir <dir>            Output directory (default: reports)
   --output-name <name>          Base filename (default: index)
@@ -18501,7 +18549,8 @@ OPTIONS
   --asset-mode <mode>         Asset bundling: "none" (default) or "copy"
   --allow-missing-assets      Warn on missing assets instead of failing
   --stdin                       Read JSON from stdin instead of file
-  --json-summary                Print machine-parsable JSON summary
+  --list-format <format>        list output format: text (default), json, csv, markdown-table
+  --json-summary                Deprecated alias for --list-format json
   --baseline <path|auto>        Compare baseline file, or auto-pick a prior run for compare
   --baseline-dir <dir>          Directory to scan when --baseline auto is used
   --pr-summary                  Print a PR-friendly markdown summary after compare
@@ -18510,7 +18559,8 @@ OPTIONS
   --help                        Show this help message
 
 LIST
-  list prints one scenario per line (text by default, JSON with --json-summary)
+  list prints one scenario per line (--list-format text by default)
+  list --list-format json outputs machine-parsable JSON (--json-summary is a deprecated alias)
   list supports --include-tags, --exclude-tags for filtering
   list supports --input-type and --stdin
 
@@ -18549,7 +18599,7 @@ EXIT CODES
   3  Formatter/generation failure
   4  Bad arguments / usage error
 `.trim();
-function parseCliArgs(argv) {
+async function parseCliArgs(argv) {
   const args = argv.slice(2);
   if (args.length === 0 || args.includes("--help") || args.includes("-h")) {
     console.log(HELP_TEXT);
@@ -18609,6 +18659,7 @@ function parseCliArgs(argv) {
       "html-theme-picker": { type: "boolean", default: false },
       stdin: { type: "boolean", default: false },
       "json-summary": { type: "boolean", default: false },
+      "list-format": { type: "string", default: "text" },
       "emit-canonical": { type: "string" },
       "slack-webhook": { type: "string" },
       "teams-webhook": { type: "string" },
@@ -18627,6 +18678,7 @@ function parseCliArgs(argv) {
       "allow-missing-assets": { type: "boolean", default: false },
       "pr-summary": { type: "boolean", default: false },
       "pr-summary-file": { type: "string" },
+      "config": { type: "string" },
       help: { type: "boolean", default: false }
     },
     allowPositionals: true,
@@ -18664,15 +18716,20 @@ function parseCliArgs(argv) {
     console.error(`Error: --input-type must be "raw", "canonical", or "ndjson", got "${inputType}".`);
     process.exit(EXIT_USAGE);
   }
-  const validFormats = /* @__PURE__ */ new Set(["astro", "html", "markdown", "junit", "cucumber-json", "cucumber-messages", "cucumber-html"]);
+  const pluginConfig = await loadConfig(values["config"]);
+  const customFormatterNames = new Set(Object.keys(pluginConfig.formatters ?? {}));
+  const builtInFormats = /* @__PURE__ */ new Set(["astro", "html", "markdown", "junit", "cucumber-json", "cucumber-messages", "cucumber-html"]);
   const formatStr = values.format;
-  const formats = formatStr.split(",").map((f) => f.trim());
-  for (const f of formats) {
-    if (!validFormats.has(f)) {
-      console.error(`Error: Unknown format "${f}". Valid: astro, html, markdown, junit, cucumber-json, cucumber-messages, cucumber-html.`);
-      process.exit(EXIT_USAGE);
-    }
+  const allRequestedFormats = formatStr.split(",").map((f) => f.trim());
+  const builtInRequested = allRequestedFormats.filter((f) => builtInFormats.has(f));
+  const customRequested = allRequestedFormats.filter((f) => customFormatterNames.has(f));
+  const unknownFormats = allRequestedFormats.filter((f) => !builtInFormats.has(f) && !customFormatterNames.has(f));
+  if (unknownFormats.length > 0) {
+    const knownCustom = customFormatterNames.size > 0 ? `, ${[...customFormatterNames].join(", ")}` : "";
+    console.error(`Error: Unknown format(s): ${unknownFormats.join(", ")}. Valid built-in: astro, html, markdown, junit, cucumber-json, cucumber-messages, cucumber-html${knownCustom}.`);
+    process.exit(EXIT_USAGE);
   }
+  const formats = builtInRequested;
   const htmlTheme = values["html-theme"];
   const validThemes = /* @__PURE__ */ new Set(["default", "corporate", "terminal", "minimal", "dashboard", "playful"]);
   if (!validThemes.has(htmlTheme)) {
@@ -18740,7 +18797,7 @@ function parseCliArgs(argv) {
     console.error(`Error: --asset-mode must be "none" or "copy", got "${assetModeRaw}".`);
     process.exit(EXIT_USAGE);
   }
-  return {
+  const cliArgs = {
     subcommand,
     inputFile,
     baselineFile,
@@ -18769,6 +18826,7 @@ function parseCliArgs(argv) {
     htmlNoToc: values["html-no-toc"],
     htmlThemePicker: values["html-theme-picker"],
     jsonSummary: values["json-summary"],
+    listFormat: values["list-format"],
     emitCanonical: values["emit-canonical"],
     slackWebhook,
     teamsWebhook,
@@ -18786,8 +18844,10 @@ function parseCliArgs(argv) {
     assetMode: assetModeRaw,
     allowMissingAssets: values["allow-missing-assets"],
     prSummary: values["pr-summary"],
-    prSummaryFile: values["pr-summary-file"]
+    prSummaryFile: values["pr-summary-file"],
+    config: values["config"]
   };
+  return { args: cliArgs, pluginConfig, customRequested };
 }
 async function readInput(args) {
   if (args.stdin) {
@@ -18809,11 +18869,11 @@ function readFileInput(filePath) {
   return fs7.readFileSync(resolved, "utf8");
 }
 function readStdin() {
-  return new Promise((resolve7, reject) => {
+  return new Promise((resolve8, reject) => {
     const chunks = [];
     process.stdin.setEncoding("utf8");
     process.stdin.on("data", (chunk) => chunks.push(chunk));
-    process.stdin.on("end", () => resolve7(chunks.join("")));
+    process.stdin.on("end", () => resolve8(chunks.join("")));
     process.stdin.on("error", reject);
   });
 }
@@ -18973,7 +19033,7 @@ function resolveBaselineAuto(currentFile, currentRun, args) {
   return picked.file;
 }
 async function main() {
-  const args = parseCliArgs(process.argv);
+  const { args, pluginConfig, customRequested } = await parseCliArgs(process.argv);
   const startMs = Date.now();
   if (args.subcommand === "compare") {
     const currentText = readFileInput(args.currentFile);
@@ -18994,8 +19054,16 @@ async function main() {
   if (args.subcommand === "list") {
     const text2 = await readInput(args);
     const run = applySelection(normalizeRunFromText(text2, args).run, args);
-    const outputFormat = args.jsonSummary ? "json" : "text";
-    const output = listScenarios({ testCases: run.testCases, format: outputFormat }, {});
+    const resolvedFormat = args.jsonSummary ? "json" : args.listFormat;
+    const validListFormats = /* @__PURE__ */ new Set(["text", "json", "csv", "markdown-table"]);
+    if (!validListFormats.has(resolvedFormat)) {
+      console.error(`Error: Unknown list format "${resolvedFormat}". Valid: text, json, csv, markdown-table.`);
+      process.exit(EXIT_USAGE);
+    }
+    const output = listScenarios(
+      { testCases: run.testCases, format: resolvedFormat },
+      {}
+    );
     console.log(output);
     process.exit(EXIT_SUCCESS);
   }
@@ -19048,6 +19116,7 @@ async function main() {
     }
     try {
       const result = await generateReports(run, args);
+      runCustomFormatters(run, customRequested, pluginConfig.formatters ?? {}, args);
       await dispatchNotifications(run, args);
       runHistoryPipeline(run, args);
       printResult(result, args, startMs);
@@ -19106,6 +19175,7 @@ ${msg}`);
     }
     try {
       const result = await generateReports(run, args);
+      runCustomFormatters(run, customRequested, pluginConfig.formatters ?? {}, args);
       await dispatchNotifications(run, args);
       runHistoryPipeline(run, args);
       printResult(result, args, startMs);
@@ -19163,6 +19233,7 @@ ${msg}`);
   }
   try {
     const result = await generateReports(canonical, args, droppedMissingStory);
+    runCustomFormatters(canonical, customRequested, pluginConfig.formatters ?? {}, args);
     await dispatchNotifications(canonical, args);
     runHistoryPipeline(canonical, args);
     printResult(result, args, startMs, droppedMissingStory);
@@ -19173,6 +19244,25 @@ ${msg}`);
     process.exit(EXIT_GENERATION);
   }
 }
+function runCustomFormatters(run, customRequested, formatters, args) {
+  if (customRequested.length === 0) return;
+  const outputDir = args.outputDir ?? ".";
+  for (const formatName of customRequested) {
+    const formatter = formatters[formatName];
+    try {
+      const content = formatter.format(run);
+      const ext = formatter.fileExtension ?? formatName;
+      const baseName = args.outputName ?? "report";
+      const filename = args.outputNameTimestamp ? `${baseName}-${Math.floor(run.startedAtMs / 1e3)}.${ext}` : `${baseName}.${ext}`;
+      const filepath = path7.join(outputDir, filename);
+      fs7.mkdirSync(outputDir, { recursive: true });
+      fs7.writeFileSync(filepath, content, "utf8");
+      console.log(`Generated: ${filepath}`);
+    } catch (err) {
+      console.error(`Error running custom formatter "${formatName}": ${err instanceof Error ? err.message : String(err)}`);
+    }
+  }
+}
 async function dispatchNotifications(run, args) {
   const webhooks = args.webhookUrls.map((url) => {
     const opts = { url };