executable-stories-formatters 0.10.0 → 0.11.0

package/dist/{index-CbWFyoTx.d.cts → index-DF16Xl5i.d.cts}

@@ -113,6 +113,13 @@ type DocEntry = {
     alt?: string;
     phase: DocPhase;
     children?: DocEntry[];
+} | {
+    kind: "video";
+    path: string;
+    caption?: string;
+    poster?: string;
+    phase: DocPhase;
+    children?: DocEntry[];
 } | {
     kind: "custom";
     type: string;

package/dist/{index-CbWFyoTx.d.ts → index-DF16Xl5i.d.ts}

@@ -113,6 +113,13 @@ type DocEntry = {
     alt?: string;
     phase: DocPhase;
     children?: DocEntry[];
+} | {
+    kind: "video";
+    path: string;
+    caption?: string;
+    poster?: string;
+    phase: DocPhase;
+    children?: DocEntry[];
 } | {
     kind: "custom";
     type: string;

package/dist/index.cjs

@@ -87,6 +87,7 @@ __export(src_exports, {
   hasSufficientHistory: () => hasSufficientHistory,
   isReviewableSource: () => isReviewableSource,
   isTestFile: () => isTestFile,
+  joinNameAndExt: () => joinNameAndExt,
   listScenarios: () => listScenarios,
   loadHistory: () => loadHistory,
   mergeStepResults: () => mergeStepResults,
@@ -893,6 +894,15 @@ function copyDocEntry(entry) {
         phase: entry.phase,
         ...children
       };
+    case "video":
+      return {
+        kind: "video",
+        path: entry.path,
+        ...entry.caption ? { caption: entry.caption } : {},
+        ...entry.poster ? { poster: entry.poster } : {},
+        phase: entry.phase,
+        ...children
+      };
     case "custom":
       return {
         kind: "custom",
@@ -14054,6 +14064,23 @@ function renderDocScreenshot(entry, deps) {
   ${entry.alt ? `<div class="doc-screenshot-caption">${deps.escapeHtml(entry.alt)}</div>` : ""}
 </div>`;
 }
+function renderDocVideo(entry, deps) {
+  const isRemote = /^(?:https?:|data:)/i.test(entry.path);
+  const isAbsoluteFsPath = !isRemote && /^(?:[/\\]|[A-Za-z]:[/\\])/.test(entry.path);
+  const captionHtml = entry.caption ? `<div class="doc-video-caption">${deps.escapeHtml(entry.caption)}</div>` : "";
+  if ((deps.embedScreenshots ?? true) && isAbsoluteFsPath) {
+    return `<div class="doc-video doc-video-missing">
+  <div class="doc-video-missing-label">Video unavailable</div>
+  <div class="doc-video-missing-path">${deps.escapeHtml(entry.path)}</div>
+  ${captionHtml}
+</div>`;
+  }
+  const poster = entry.poster ? ` poster="${deps.escapeHtml(entry.poster)}"` : "";
+  return `<div class="doc-video">
+  <video class="doc-video-player" controls preload="metadata"${poster} src="${deps.escapeHtml(entry.path)}"></video>
+  ${captionHtml}
+</div>`;
+}
 function renderDocCustom(entry, deps) {
   if (entry.type === "visual" && entry.data && typeof entry.data === "object") {
     const data = entry.data;
@@ -14107,6 +14134,9 @@ function renderDocEntry(entry, deps) {
     case "screenshot":
       html = renderDocScreenshot(entry, deps);
       break;
+    case "video":
+      html = renderDocVideo(entry, deps);
+      break;
     case "custom":
       html = renderDocCustom(entry, deps);
       break;
@@ -15433,6 +15463,19 @@ var MarkdownFormatter = class {
       case "screenshot":
         lines.push(`${indent}![${entry.alt ?? "Screenshot"}](${entry.path})`);
         break;
+      case "video": {
+        const poster = entry.poster ? ` poster="${entry.poster}"` : "";
+        lines.push(`${indent}`);
+        lines.push(`${indent}<video controls preload="metadata"${poster} class="doc-video">`);
+        lines.push(`${indent}  <source src="${entry.path}" />`);
+        lines.push(`${indent}</video>`);
+        if (entry.caption) {
+          lines.push(`${indent}`);
+          lines.push(`${indent}*${entry.caption}*`);
+        }
+        lines.push(`${indent}`);
+        break;
+      }
       case "custom":
         if (entry.type === "visual" && entry.data && typeof entry.data === "object") {
           const data = entry.data;
@@ -16592,6 +16635,8 @@ function formatDocEntry(doc) {
       return `${escapeHtml2(doc.title ?? "mermaid diagram")}: <code>${escapeHtml2(doc.code)}</code>`;
     case "screenshot":
       return `${doc.alt ? `${escapeHtml2(doc.alt)}: ` : ""}${escapeHtml2(doc.path)}`;
+    case "video":
+      return `${doc.caption ? `${escapeHtml2(doc.caption)}: ` : ""}${escapeHtml2(doc.path)}`;
     case "custom":
       return `${escapeHtml2(doc.type)}: ${escapeHtml2(JSON.stringify(doc.data))}`;
   }
@@ -17048,6 +17093,8 @@ function formatDocEntry2(doc) {
       return `${doc.title ?? "mermaid diagram"}: \`${doc.code}\``;
     case "screenshot":
       return `${doc.alt ? `${doc.alt}: ` : ""}${doc.path}`;
+    case "video":
+      return `${doc.caption ? `${doc.caption}: ` : ""}${doc.path}`;
     case "custom":
       return `${doc.type}: ${JSON.stringify(doc.data)}`;
   }
@@ -17293,19 +17340,35 @@ function replaceAssetRef(html, original, replacement) {
   return html;
 }
 
+// src/utils/source-file.ts
+function cleanTestStem(fileName) {
+  const base = fileName.split(/[\\/]/).pop() ?? fileName;
+  const stripped = base.replace(/\.(story\.)?(test|spec|cy)\.[cm]?[jt]sx?$/i, "");
+  if (stripped !== base) return stripped;
+  return base.replace(/\.[^.]+$/, "");
+}
+function humanizeSourceFile(fileName) {
+  return cleanTestStem(fileName).split(/[-_.\s]+/).filter(Boolean).map((w) => w.charAt(0).toUpperCase() + w.slice(1)).join(" ");
+}
+
 // src/formatters/astro.ts
 var AstroFormatter = class _AstroFormatter {
   markdownFormatter;
   title;
+  perFileTitle;
   constructor(options = {}) {
     this.title = options.markdown?.title ?? "User Stories";
+    this.perFileTitle = options.perFileTitle ?? false;
     this.markdownFormatter = new MarkdownFormatter({
       ...options.markdown,
       title: this.title,
       stepStyle: "gherkin",
       includeFrontMatter: false,
       includeSummaryTable: false,
-      includeMetadata: false
+      includeMetadata: false,
+      // A per-file page is one file already — group by suite/describe so the
+      // body shows clean section headings, not the redundant source path.
+      groupBy: this.perFileTitle ? "suite" : options.markdown?.groupBy ?? "file"
     });
   }
   format(run) {
@@ -17315,13 +17378,31 @@ var AstroFormatter = class _AstroFormatter {
     return `${frontmatter}
 ${body}`;
   }
+  /**
+   * Title for the page. A per-file page (one source file — i.e. colocated mode)
+   * is titled by its suite/describe name, falling back to a humanized filename,
+   * so the docs nav reads "Convert Currency" not "User Stories" six times over.
+   * Multi-file (aggregated) pages keep the configured title.
+   */
+  deriveTitle(run) {
+    if (!this.perFileTitle) return this.title;
+    const sourceFiles = new Set(
+      run.testCases.map((tc) => tc.sourceFile).filter((f) => f && f !== "unknown")
+    );
+    if (sourceFiles.size !== 1) return this.title;
+    const suites = new Set(
+      run.testCases.map((tc) => tc.titlePath?.[0]).filter((s) => Boolean(s))
+    );
+    if (suites.size === 1) return [...suites][0];
+    return humanizeSourceFile([...sourceFiles][0]) || this.title;
+  }
   buildFrontmatter(run) {
     const badge = _AstroFormatter.computeBadge(run.testCases);
     const count = run.testCases.length;
     const description = `${count} scenario${count !== 1 ? "s" : ""} \u2014 ${badge.text.toLowerCase()}`;
     const lines = [
       "---",
-      `title: ${this.title}`,
+      `title: ${yamlScalar(this.deriveTitle(run))}`,
       `description: ${description}`,
       "sidebar:",
       "  badge:",
@@ -17339,6 +17420,12 @@ ${body}`;
     return { text: "Passed", variant: "success" };
   }
 };
+function yamlScalar(value) {
+  if (/[:#[\]{}&*!|>'"%@`]|^[\s-]|\s$/.test(value)) {
+    return `'${value.replace(/'/g, "''")}'`;
+  }
+  return value;
+}
 
 // src/formatters/confluence.ts
 var ConfluenceFormatter = class {
@@ -17615,6 +17702,15 @@ ${tc.errorStack}` : "");
           ])
         );
         break;
+      case "video":
+        content.push(
+          paragraph([
+            text(entry.caption ?? "Video", strong()),
+            text(": "),
+            link(entry.path, entry.path)
+          ])
+        );
+        break;
       case "custom":
         content.push(paragraph([text(`[${entry.type}]`, strong())]));
         content.push(codeBlock(JSON.stringify(entry.data ?? null, null, 2), "json"));
@@ -17784,6 +17880,13 @@ function scanMarkdownAssets(markdown) {
       found.add(src);
     }
   }
+  const posterRe = /<video[^>]+\bposter=["']([^"']+)["'][^>]*>/gi;
+  while ((match = posterRe.exec(stripped)) !== null) {
+    const src = match[1].trim();
+    if (isLocalPath(src)) {
+      found.add(src);
+    }
+  }
   return Array.from(found);
 }
 function splitByCode(markdown) {
@@ -17834,6 +17937,19 @@ function rewriteProseSegment(prose, assetsBaseUrl, pathMap) {
       return `${pre}${assetsBaseUrl}/${trimmed}${post}`;
     }
   );
+  result = result.replace(
+    /(<video[^>]+\bposter=["'])([^"']+)(["'][^>]*>)/gi,
+    (full, pre, src, post) => {
+      const trimmed = src.trim();
+      if (!isLocalPath(trimmed)) return full;
+      if (pathMap) {
+        const mapped = pathMap.get(trimmed);
+        if (mapped === void 0) return full;
+        return `${pre}${assetsBaseUrl}/${mapped}${post}`;
+      }
+      return `${pre}${assetsBaseUrl}/${trimmed}${post}`;
+    }
+  );
   return result;
 }
 function rewriteAssetPaths(markdown, assetsBaseUrl, pathMap) {
@@ -20865,6 +20981,10 @@ var FORMAT_EXTENSIONS = {
   "scenario-index-json": ".scenarios-index.json",
   "story-report-json": ".story-report.json"
 };
+function joinNameAndExt(name, ext) {
+  const stutter = `.${name}.`;
+  return ext.startsWith(stutter) ? `${name}.${ext.slice(stutter.length)}` : `${name}${ext}`;
+}
 var TEST_EXTENSIONS = [
   ".test.ts",
   ".test.tsx",
@@ -20890,7 +21010,7 @@ function computeOutputPath(sourceFile, format, mode, colocatedStyle, baseOutputD
   const ext = FORMAT_EXTENSIONS[format];
   const effectiveName = outputName + (outputNameSuffix ?? "");
   if (mode === "aggregated") {
-    return toPosix(path10.join(baseOutputDir, `${effectiveName}${ext}`));
+    return toPosix(path10.join(baseOutputDir, joinNameAndExt(effectiveName, ext)));
   }
   const normalizedSource = toPosix(sourceFile);
   const dirOfSource = path10.posix.dirname(normalizedSource);
@@ -20905,6 +21025,9 @@ function computeOutputPath(sourceFile, format, mode, colocatedStyle, baseOutputD
   if (colocatedStyle === "adjacent") {
     return toPosix(path10.posix.join(dirOfSource, fileName));
   }
+  if (colocatedStyle === "flat") {
+    return toPosix(path10.posix.join(baseOutputDir, `${cleanTestStem(normalizedSource)}${ext}`));
+  }
   return toPosix(path10.posix.join(baseOutputDir, dirOfSource, fileName));
 }
 function groupTestCasesByOutput(testCases, format, options, logger, outputNameSuffix) {
@@ -21144,7 +21267,7 @@ var ReportGenerator = class {
     if (groups.size === 0 && this.options.output.mode === "aggregated") {
       const ext = FORMAT_EXTENSIONS[format];
       const effectiveName = this.options.outputName + (outputNameSuffix ?? "");
-      const outputPath = toPosix(path10.join(this.options.outputDir, `${effectiveName}${ext}`));
+      const outputPath = toPosix(path10.join(this.options.outputDir, joinNameAndExt(effectiveName, ext)));
       const content = await this.formatContent(run, format);
       const dir = path10.dirname(outputPath);
       await fsPromises.mkdir(dir, { recursive: true });
@@ -21224,6 +21347,8 @@ var ReportGenerator = class {
       case "astro": {
         const formatter = new AstroFormatter({
           assetsBaseUrl: this.options.astro.assetsBaseUrl,
+          // Colocated = one page per file, so title each by its own suite/file.
+          perFileTitle: this.options.output.mode === "colocated",
           markdown: this.options.astro.markdown
         });
         return formatter.format(run);
@@ -21377,6 +21502,7 @@ function normalizePlaywrightResults(testResults, adapterOptions, canonicalizeOpt
   hasSufficientHistory,
   isReviewableSource,
   isTestFile,
+  joinNameAndExt,
   listScenarios,
   loadHistory,
   mergeStepResults,