executable-stories-formatters 0.7.9 → 0.7.11

package/dist/index.js

@@ -1,6 +1,6 @@
 // src/index.ts
 import "fs";
-import * as path7 from "path";
+import * as path8 from "path";
 import * as fsPromises from "fs/promises";
 
 // src/converters/acl/status.ts
@@ -653,6 +653,10 @@ ${doc.markdown}`,
   }
 };
 
+// src/formatters/html/renderers/index.ts
+import * as fs2 from "fs";
+import * as path2 from "path";
+
 // src/formatters/html/template.ts
 var JS_THEME = `
 // Theme management
@@ -12963,7 +12967,9 @@ function renderDocMermaid(entry, deps) {
 }
 function renderDocScreenshot(entry, deps) {
   const alt = entry.alt ?? "Screenshot";
-  const src = entry.path;
+  const embedEnabled = deps.embedScreenshots ?? true;
+  const isRemote = /^(?:https?:|data:)/i.test(entry.path);
+  const src = embedEnabled && !isRemote && deps.readScreenshot ? deps.readScreenshot(entry.path) ?? entry.path : entry.path;
   return `<div class="doc-screenshot">
   <img src="${deps.escapeHtml(src)}" alt="${deps.escapeHtml(alt)}" class="doc-screenshot-img" />
   ${entry.alt ? `<div class="doc-screenshot-caption">${deps.escapeHtml(entry.alt)}</div>` : ""}
@@ -13550,6 +13556,28 @@ function renderToc(args, deps) {
 }
 
 // src/formatters/html/renderers/index.ts
+var SCREENSHOT_MIME_BY_EXT = {
+  png: "image/png",
+  jpg: "image/jpeg",
+  jpeg: "image/jpeg",
+  gif: "image/gif",
+  webp: "image/webp",
+  svg: "image/svg+xml",
+  avif: "image/avif",
+  bmp: "image/bmp"
+};
+function readScreenshotAsDataUri(filePath) {
+  try {
+    const ext = path2.extname(filePath).slice(1).toLowerCase();
+    const mime = SCREENSHOT_MIME_BY_EXT[ext];
+    if (!mime) return void 0;
+    if (!fs2.existsSync(filePath)) return void 0;
+    const buf = fs2.readFileSync(filePath);
+    return `data:${mime};base64,${buf.toString("base64")}`;
+  } catch {
+    return void 0;
+  }
+}
 function normalizeOptions(options = {}) {
   return {
     title: options.title ?? "Test Results",
@@ -13573,7 +13601,9 @@ function createHtmlFormatter(options = {}) {
     escapeHtml,
     syntaxHighlighting: opts.syntaxHighlighting,
     markdownEnabled: opts.markdownEnabled,
-    mermaidEnabled: opts.mermaidEnabled
+    mermaidEnabled: opts.mermaidEnabled,
+    embedScreenshots: opts.embedScreenshots,
+    readScreenshot: (filePath) => readScreenshotAsDataUri(filePath)
   };
   const renderDocs = (docs, containerClass) => {
     if (!docs || docs.length === 0) return "";
@@ -15002,8 +15032,8 @@ function extractDocAttachments(step) {
   }
   return attachments;
 }
-function guessMediaType(path8) {
-  const lower = path8.toLowerCase();
+function guessMediaType(path9) {
+  const lower = path9.toLowerCase();
   if (lower.endsWith(".png")) return "image/png";
   if (lower.endsWith(".jpg") || lower.endsWith(".jpeg")) return "image/jpeg";
   if (lower.endsWith(".gif")) return "image/gif";
@@ -16047,8 +16077,8 @@ function selectTestCases(args, deps) {
 }
 
 // src/bundler/bundle-assets.ts
-import * as fs3 from "fs";
-import * as path3 from "path";
+import * as fs4 from "fs";
+import * as path4 from "path";
 
 // src/bundler/scan-html-assets.ts
 function scanHtmlAssets(html) {
@@ -16078,21 +16108,21 @@ function isLocalAssetRef(ref) {
 }
 
 // src/bundler/copy-asset.ts
-import * as fs2 from "fs";
-import * as path2 from "path";
+import * as fs3 from "fs";
+import * as path3 from "path";
 import * as crypto from "crypto";
 function copyAsset(sourcePath, assetsDir) {
-  if (!fs2.existsSync(assetsDir)) {
-    fs2.mkdirSync(assetsDir, { recursive: true });
+  if (!fs3.existsSync(assetsDir)) {
+    fs3.mkdirSync(assetsDir, { recursive: true });
   }
-  const content = fs2.readFileSync(sourcePath);
+  const content = fs3.readFileSync(sourcePath);
   const hash = crypto.createHash("sha256").update(content).digest("hex").slice(0, 8);
-  const ext = path2.extname(sourcePath);
-  const baseName = sanitize(path2.basename(sourcePath, ext));
+  const ext = path3.extname(sourcePath);
+  const baseName = sanitize(path3.basename(sourcePath, ext));
   const destName = `${baseName}-${hash}${ext}`;
-  const destPath = path2.join(assetsDir, destName);
-  if (!fs2.existsSync(destPath)) {
-    fs2.copyFileSync(sourcePath, destPath);
+  const destPath = path3.join(assetsDir, destName);
+  if (!fs3.existsSync(destPath)) {
+    fs3.copyFileSync(sourcePath, destPath);
   }
   return `assets/${destName}`;
 }
@@ -16102,15 +16132,15 @@ function sanitize(name) {
 
 // src/bundler/bundle-assets.ts
 function bundleAssets(htmlPath, options = {}) {
-  const htmlDir = path3.dirname(htmlPath);
-  const assetsDir = path3.join(htmlDir, "assets");
-  let html = fs3.readFileSync(htmlPath, "utf8");
+  const htmlDir = path4.dirname(htmlPath);
+  const assetsDir = path4.join(htmlDir, "assets");
+  let html = fs4.readFileSync(htmlPath, "utf8");
   const refs = scanHtmlAssets(html);
   let copiedCount = 0;
   const missing = [];
   for (const ref of refs) {
-    const absolutePath = path3.resolve(htmlDir, ref);
-    if (!fs3.existsSync(absolutePath)) {
+    const absolutePath = path4.resolve(htmlDir, ref);
+    if (!fs4.existsSync(absolutePath)) {
       missing.push(ref);
       continue;
     }
@@ -16123,7 +16153,7 @@ function bundleAssets(htmlPath, options = {}) {
       `Missing asset${missing.length > 1 ? "s" : ""}: ${missing.join(", ")}`
     );
   }
-  fs3.writeFileSync(htmlPath, html, "utf8");
+  fs4.writeFileSync(htmlPath, html, "utf8");
   return {
     copiedCount,
     missingCount: missing.length,
@@ -16606,15 +16636,15 @@ function groupBy7(items, keyFn) {
 }
 
 // src/formatters/astro-assets.ts
-import * as fs4 from "fs";
-import * as path4 from "path";
+import * as fs5 from "fs";
+import * as path5 from "path";
 var SKIP_PREFIXES = ["http://", "https://", "data:", "#"];
 function isLocalPath(src) {
   const trimmed = src.trim();
   if (SKIP_PREFIXES.some((prefix) => trimmed.startsWith(prefix))) {
     return false;
   }
-  return !path4.posix.isAbsolute(trimmed) && !path4.win32.isAbsolute(trimmed);
+  return !path5.posix.isAbsolute(trimmed) && !path5.win32.isAbsolute(trimmed);
 }
 function stripCodeContent(markdown) {
   let result = markdown.replace(/^[ \t]*(`{3,}|~{3,})[^\n]*\n[\s\S]*?^[ \t]*\1\s*$/gm, "");
@@ -16708,8 +16738,8 @@ function copyMarkdownAssets(options) {
   const pathMap = /* @__PURE__ */ new Map();
   const missing = [];
   for (const ref of refs) {
-    const absPath = path4.resolve(markdownDir, ref);
-    if (!fs4.existsSync(absPath)) {
+    const absPath = path5.resolve(markdownDir, ref);
+    if (!fs5.existsSync(absPath)) {
       if (!allowMissing) {
         throw new Error(`Asset not found: ${absPath}`);
       }
@@ -17725,27 +17755,27 @@ function pickleStepArgumentToDocs(ps) {
 }
 
 // src/utils/git-info.ts
-import * as fs5 from "fs";
-import * as path5 from "path";
+import * as fs6 from "fs";
+import * as path6 from "path";
 function readGitSha(cwd = process.cwd()) {
   const envSha = process.env.GITHUB_SHA || process.env.GIT_COMMIT || process.env.CI_COMMIT_SHA;
   if (envSha) return envSha;
   const gitDir = findGitDir(cwd);
   if (!gitDir) return void 0;
   try {
-    const headPath = path5.join(gitDir, "HEAD");
-    const head = fs5.readFileSync(headPath, "utf8").trim();
+    const headPath = path6.join(gitDir, "HEAD");
+    const head = fs6.readFileSync(headPath, "utf8").trim();
     if (!head.startsWith("ref:")) {
       return head;
     }
     const refPath = head.replace("ref:", "").trim();
-    const refFile = path5.join(gitDir, refPath);
-    if (fs5.existsSync(refFile)) {
-      return fs5.readFileSync(refFile, "utf8").trim();
+    const refFile = path6.join(gitDir, refPath);
+    if (fs6.existsSync(refFile)) {
+      return fs6.readFileSync(refFile, "utf8").trim();
     }
-    const packedRefs = path5.join(gitDir, "packed-refs");
-    if (fs5.existsSync(packedRefs)) {
-      const content = fs5.readFileSync(packedRefs, "utf8");
+    const packedRefs = path6.join(gitDir, "packed-refs");
+    if (fs6.existsSync(packedRefs)) {
+      const content = fs6.readFileSync(packedRefs, "utf8");
       for (const line of content.split("\n")) {
         if (!line || line.startsWith("#") || line.startsWith("^")) continue;
         const [sha, ref] = line.split(" ");
@@ -17760,19 +17790,19 @@ function readGitSha(cwd = process.cwd()) {
 function findGitDir(start) {
   let current = start;
   while (true) {
-    const candidate = path5.join(current, ".git");
-    if (fs5.existsSync(candidate)) {
-      const stat = fs5.statSync(candidate);
+    const candidate = path6.join(current, ".git");
+    if (fs6.existsSync(candidate)) {
+      const stat = fs6.statSync(candidate);
       if (stat.isFile()) {
-        const content = fs5.readFileSync(candidate, "utf8").trim();
+        const content = fs6.readFileSync(candidate, "utf8").trim();
         const match = content.match(/^gitdir: (.+)$/);
         if (match) {
-          return path5.resolve(current, match[1]);
+          return path6.resolve(current, match[1]);
         }
       }
       return candidate;
     }
-    const parent = path5.dirname(current);
+    const parent = path6.dirname(current);
     if (parent === current) return void 0;
     current = parent;
   }
@@ -17783,8 +17813,8 @@ function readBranchName(cwd = process.cwd()) {
   const gitDir = findGitDir(cwd);
   if (!gitDir) return void 0;
   try {
-    const headPath = path5.join(gitDir, "HEAD");
-    const head = fs5.readFileSync(headPath, "utf8").trim();
+    const headPath = path6.join(gitDir, "HEAD");
+    const head = fs6.readFileSync(headPath, "utf8").trim();
     if (head.startsWith("ref:")) {
       const refPath = head.replace("ref:", "").trim();
       const match = refPath.match(/^refs\/heads\/(.+)$/);
@@ -17821,8 +17851,8 @@ function nanosecondsToMs(ns) {
 }
 
 // src/utils/metadata.ts
-import * as fs6 from "fs";
-import * as path6 from "path";
+import * as fs7 from "fs";
+import * as path7 from "path";
 var versionCache = /* @__PURE__ */ new Map();
 function readPackageVersion(root) {
   if (versionCache.has(root)) {
@@ -17833,18 +17863,18 @@ function readPackageVersion(root) {
   return version;
 }
 function findPackageVersion(startDir) {
-  let current = path6.resolve(startDir);
+  let current = path7.resolve(startDir);
   while (true) {
-    const pkgPath = path6.join(current, "package.json");
+    const pkgPath = path7.join(current, "package.json");
     try {
-      if (fs6.existsSync(pkgPath)) {
-        const raw = fs6.readFileSync(pkgPath, "utf8");
+      if (fs7.existsSync(pkgPath)) {
+        const raw = fs7.readFileSync(pkgPath, "utf8");
         const parsed = JSON.parse(raw);
         return parsed.version;
       }
     } catch {
     }
-    const parent = path6.dirname(current);
+    const parent = path7.dirname(current);
     if (parent === current) {
       return void 0;
     }
@@ -18834,11 +18864,11 @@ function computeOutputPath(sourceFile, format, mode, colocatedStyle, baseOutputD
   const ext = FORMAT_EXTENSIONS[format];
   const effectiveName = outputName + (outputNameSuffix ?? "");
   if (mode === "aggregated") {
-    return toPosix(path7.join(baseOutputDir, `${effectiveName}${ext}`));
+    return toPosix(path8.join(baseOutputDir, `${effectiveName}${ext}`));
   }
   const normalizedSource = toPosix(sourceFile);
-  const dirOfSource = path7.posix.dirname(normalizedSource);
-  let baseName = path7.posix.basename(normalizedSource);
+  const dirOfSource = path8.posix.dirname(normalizedSource);
+  let baseName = path8.posix.basename(normalizedSource);
   for (const testExt of TEST_EXTENSIONS) {
     if (baseName.endsWith(testExt)) {
       baseName = baseName.slice(0, -testExt.length);
@@ -18847,9 +18877,9 @@ function computeOutputPath(sourceFile, format, mode, colocatedStyle, baseOutputD
   }
   const fileName = `${baseName}.${effectiveName}${ext}`;
   if (colocatedStyle === "adjacent") {
-    return toPosix(path7.posix.join(dirOfSource, fileName));
+    return toPosix(path8.posix.join(dirOfSource, fileName));
   }
-  return toPosix(path7.posix.join(baseOutputDir, dirOfSource, fileName));
+  return toPosix(path8.posix.join(baseOutputDir, dirOfSource, fileName));
 }
 function groupTestCasesByOutput(testCases, format, options, logger, outputNameSuffix) {
   const groups = /* @__PURE__ */ new Map();
@@ -19047,8 +19077,8 @@ var ReportGenerator = class {
       if (astroPaths) {
         for (const mdPath of astroPaths) {
           const content = await fsPromises.readFile(mdPath, "utf8");
-          const mdDir = path7.dirname(mdPath);
-          const assetsDir = path7.resolve(this.options.astro.assetsDir);
+          const mdDir = path8.dirname(mdPath);
+          const assetsDir = path8.resolve(this.options.astro.assetsDir);
           const result = copyMarkdownAssets({
             markdown: content,
             markdownDir: mdDir,
@@ -19079,9 +19109,9 @@ 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(path7.join(this.options.outputDir, `${effectiveName}${ext}`));
+      const outputPath = toPosix(path8.join(this.options.outputDir, `${effectiveName}${ext}`));
       const content = await this.formatContent(run, format);
-      const dir = path7.dirname(outputPath);
+      const dir = path8.dirname(outputPath);
       await fsPromises.mkdir(dir, { recursive: true });
       await this.deps.writeFile(outputPath, content);
       return [outputPath];
@@ -19093,7 +19123,7 @@ var ReportGenerator = class {
         testCases
       };
       const content = await this.formatContent(groupRun, format);
-      const dir = path7.dirname(outputPath);
+      const dir = path8.dirname(outputPath);
       await fsPromises.mkdir(dir, { recursive: true });
       await this.deps.writeFile(outputPath, content);
       writtenPaths.push(outputPath);
@@ -19216,7 +19246,7 @@ async function generateRunComparison(args) {
   await fsPromises.mkdir(outputDir, { recursive: true });
   for (const format of args.formats) {
     const ext = format === "html" ? ".html" : ".md";
-    const outputPath = toPosix(path7.join(outputDir, `${outputName}${ext}`));
+    const outputPath = toPosix(path8.join(outputDir, `${outputName}${ext}`));
     const content = format === "html" ? new RunDiffHtmlFormatter({ title: args.title }).format(diff) : new RunDiffMarkdownFormatter({ title: args.title }).format(diff);
     await fsPromises.writeFile(outputPath, content, "utf8");
     files.push(outputPath);