executable-stories-formatters 0.13.0 → 0.15.0

package/dist/index.d.cts

@@ -360,6 +360,12 @@ interface MarkdownFormatterOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /** Emit a stable per-scenario anchor for deep-linking. Returns the id, or undefined to skip. */
+    scenarioAnchor?: (tc: TestCaseResult) => string | undefined;
+    /** Render a badge line under a scenario heading (e.g. a what's-changed marker). Undefined to skip. */
+    scenarioBadge?: (tc: TestCaseResult) => string | undefined;
+    /** Render a business-context link line under a scenario heading. Undefined to skip. */
+    scenarioNoteLink?: (tc: TestCaseResult) => string | undefined;
 }
 
 /** Astro/Starlight formatter options */
@@ -487,6 +493,9 @@ interface ResolvedFormatterOptions {
             ticketUrlTemplate?: string;
             traceUrlTemplate?: string;
             customRenderers?: MarkdownRenderers;
+            scenarioAnchor?: (tc: TestCaseResult) => string | undefined;
+            scenarioBadge?: (tc: TestCaseResult) => string | undefined;
+            scenarioNoteLink?: (tc: TestCaseResult) => string | undefined;
         };
     };
     assetMode: "none" | "copy";
@@ -1924,6 +1933,25 @@ interface MarkdownOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /**
+     * Emit a stable in-page anchor before each scenario heading, so external tools
+     * can deep-link to a scenario by fragment. Given a test case, return the anchor
+     * id (without `#`), or undefined to skip. Off by default — only the living-docs
+     * site opts in, so plain markdown output is unchanged.
+     */
+    scenarioAnchor?: (tc: TestCaseResult) => string | undefined;
+    /**
+     * Render a short badge line directly under a scenario heading (e.g. a
+     * what's-changed marker like "🆕 New" / "⚠️ Regressed"). Return the markdown
+     * line, or undefined to skip. Off by default — only the living-docs site opts in.
+     */
+    scenarioBadge?: (tc: TestCaseResult) => string | undefined;
+    /**
+     * Render a link line under a scenario heading pointing at hand-written context
+     * (the scenario's note page). Return the markdown line, or undefined to skip.
+     * Off by default — only the living-docs site opts in.
+     */
+    scenarioNoteLink?: (tc: TestCaseResult) => string | undefined;
 }
 /**
  * Markdown Formatter.

package/dist/index.d.ts

@@ -360,6 +360,12 @@ interface MarkdownFormatterOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /** Emit a stable per-scenario anchor for deep-linking. Returns the id, or undefined to skip. */
+    scenarioAnchor?: (tc: TestCaseResult) => string | undefined;
+    /** Render a badge line under a scenario heading (e.g. a what's-changed marker). Undefined to skip. */
+    scenarioBadge?: (tc: TestCaseResult) => string | undefined;
+    /** Render a business-context link line under a scenario heading. Undefined to skip. */
+    scenarioNoteLink?: (tc: TestCaseResult) => string | undefined;
 }
 
 /** Astro/Starlight formatter options */
@@ -487,6 +493,9 @@ interface ResolvedFormatterOptions {
             ticketUrlTemplate?: string;
             traceUrlTemplate?: string;
             customRenderers?: MarkdownRenderers;
+            scenarioAnchor?: (tc: TestCaseResult) => string | undefined;
+            scenarioBadge?: (tc: TestCaseResult) => string | undefined;
+            scenarioNoteLink?: (tc: TestCaseResult) => string | undefined;
         };
     };
     assetMode: "none" | "copy";
@@ -1924,6 +1933,25 @@ interface MarkdownOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /**
+     * Emit a stable in-page anchor before each scenario heading, so external tools
+     * can deep-link to a scenario by fragment. Given a test case, return the anchor
+     * id (without `#`), or undefined to skip. Off by default — only the living-docs
+     * site opts in, so plain markdown output is unchanged.
+     */
+    scenarioAnchor?: (tc: TestCaseResult) => string | undefined;
+    /**
+     * Render a short badge line directly under a scenario heading (e.g. a
+     * what's-changed marker like "🆕 New" / "⚠️ Regressed"). Return the markdown
+     * line, or undefined to skip. Off by default — only the living-docs site opts in.
+     */
+    scenarioBadge?: (tc: TestCaseResult) => string | undefined;
+    /**
+     * Render a link line under a scenario heading pointing at hand-written context
+     * (the scenario's note page). Return the markdown line, or undefined to skip.
+     * Off by default — only the living-docs site opts in.
+     */
+    scenarioNoteLink?: (tc: TestCaseResult) => string | undefined;
 }
 /**
  * Markdown Formatter.

package/dist/index.js

@@ -15124,7 +15124,10 @@ var MarkdownFormatter = class {
       ticketUrlTemplate: options.ticketUrlTemplate,
       traceUrlTemplate: options.traceUrlTemplate,
       includeSourceLinks: options.includeSourceLinks ?? true,
-      customRenderers: options.customRenderers
+      customRenderers: options.customRenderers,
+      scenarioAnchor: options.scenarioAnchor,
+      scenarioBadge: options.scenarioBadge,
+      scenarioNoteLink: options.scenarioNoteLink
     };
   }
   /**
@@ -15311,6 +15314,11 @@ var MarkdownFormatter = class {
    * Render a single scenario.
    */
   renderScenario(lines, tc) {
+    const anchorId = this.options.scenarioAnchor?.(tc);
+    if (anchorId) {
+      lines.push(`<a id="${anchorId}"></a>`);
+      lines.push("");
+    }
     if (this.options.customRenderers?.renderScenarioHeader) {
       const custom = this.options.customRenderers.renderScenarioHeader(tc);
       if (custom !== null) {
@@ -15326,6 +15334,14 @@ var MarkdownFormatter = class {
       icon = this.getStatusIcon(tc.status) + " ";
     }
     lines.push(`${headingPrefix} ${icon}${tc.story.scenario}`);
+    const badge = this.options.scenarioBadge?.(tc);
+    if (badge) {
+      lines.push(badge);
+    }
+    const noteLink = this.options.scenarioNoteLink?.(tc);
+    if (noteLink) {
+      lines.push(noteLink);
+    }
     if (this.options.includeSourceLinks && this.options.permalinkBaseUrl && tc.sourceFile !== "unknown") {
       const permalink = this.buildPermalink(tc);
       lines.push(`Source: [${tc.sourceFile}](${permalink})`);
@@ -18142,12 +18158,16 @@ function groupBy7(items, keyFn) {
 import * as fs5 from "fs";
 import * as path6 from "path";
 var SKIP_PREFIXES = ["http://", "https://", "data:", "#"];
-function isLocalPath(src) {
+function isRemoteRef(src) {
   const trimmed = src.trim();
-  if (SKIP_PREFIXES.some((prefix) => trimmed.startsWith(prefix))) {
-    return false;
-  }
-  return !path6.posix.isAbsolute(trimmed) && !path6.win32.isAbsolute(trimmed);
+  return SKIP_PREFIXES.some((prefix) => trimmed.startsWith(prefix));
+}
+function isAbsoluteRef(src) {
+  const trimmed = src.trim();
+  return path6.posix.isAbsolute(trimmed) || path6.win32.isAbsolute(trimmed);
+}
+function isRelativeLocalPath(src) {
+  return !isRemoteRef(src) && !isAbsoluteRef(src);
 }
 function stripCodeContent(markdown) {
   let result = markdown.replace(/^[ \t]*(`{3,}|~{3,})[^\n]*\n[\s\S]*?^[ \t]*\1\s*$/gm, "");
@@ -18163,21 +18183,21 @@ function scanMarkdownAssets(markdown) {
   let match;
   while ((match = mdImageRe.exec(stripped)) !== null) {
     const src = match[1].trim();
-    if (isLocalPath(src)) {
+    if (!isRemoteRef(src)) {
       found.add(src);
     }
   }
   const htmlSrcRe = /<(?:img|source|video)[^>]+\bsrc=["']([^"']+)["'][^>]*>/gi;
   while ((match = htmlSrcRe.exec(stripped)) !== null) {
     const src = match[1].trim();
-    if (isLocalPath(src)) {
+    if (!isRemoteRef(src)) {
       found.add(src);
     }
   }
   const posterRe = /<video[^>]+\bposter=["']([^"']+)["'][^>]*>/gi;
   while ((match = posterRe.exec(stripped)) !== null) {
     const src = match[1].trim();
-    if (isLocalPath(src)) {
+    if (!isRemoteRef(src)) {
       found.add(src);
     }
   }
@@ -18203,48 +18223,21 @@ function isCode(segment) {
   const trimmed = segment.trimStart();
   return trimmed.startsWith("`") || trimmed.startsWith("~") || trimmed.startsWith("<pre") || trimmed.startsWith("<code");
 }
+function resolveRewrite(trimmed, assetsBaseUrl, pathMap) {
+  if (isRemoteRef(trimmed)) return null;
+  if (pathMap) {
+    const mapped = pathMap.get(trimmed);
+    return mapped === void 0 ? null : `${assetsBaseUrl}/${mapped}`;
+  }
+  if (!isRelativeLocalPath(trimmed)) return null;
+  return `${assetsBaseUrl}/${trimmed}`;
+}
 function rewriteProseSegment(prose, assetsBaseUrl, pathMap) {
-  let result = prose;
-  result = result.replace(
-    /(!\[[^\]]*\]\()([^)"'\s]+)((?:\s+["'][^"']*["'])?\s*\))/g,
-    (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}`;
-    }
-  );
-  result = result.replace(
-    /(<(?:img|source|video)[^>]+\bsrc=["'])([^"']+)(["'][^>]*>)/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}`;
-    }
-  );
-  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;
+  const rewrite = (full, pre, src, post) => {
+    const target = resolveRewrite(src.trim(), assetsBaseUrl, pathMap);
+    return target === null ? full : `${pre}${target}${post}`;
+  };
+  return prose.replace(/(!\[[^\]]*\]\()([^)"'\s]+)((?:\s+["'][^"']*["'])?\s*\))/g, rewrite).replace(/(<(?:img|source|video)[^>]+\bsrc=["'])([^"']+)(["'][^>]*>)/gi, rewrite).replace(/(<video[^>]+\bposter=["'])([^"']+)(["'][^>]*>)/gi, rewrite);
 }
 function rewriteAssetPaths(markdown, assetsBaseUrl, pathMap) {
   return splitByCode(markdown).map((seg) => isCode(seg) ? seg : rewriteProseSegment(seg, assetsBaseUrl, pathMap)).join("");
@@ -18261,8 +18254,9 @@ function copyMarkdownAssets(options) {
   const pathMap = /* @__PURE__ */ new Map();
   const missing = [];
   for (const ref of refs) {
-    const absPath = path6.resolve(markdownDir, ref);
+    const absPath = isAbsoluteRef(ref) ? ref : path6.resolve(markdownDir, ref);
     if (!fs5.existsSync(absPath)) {
+      if (isAbsoluteRef(ref)) continue;
       if (!allowMissing) {
         throw new Error(`Asset not found: ${absPath}`);
       }
@@ -21888,7 +21882,10 @@ var ReportGenerator = class {
           permalinkBaseUrl: options.astro?.markdown?.permalinkBaseUrl,
           ticketUrlTemplate: options.astro?.markdown?.ticketUrlTemplate,
           traceUrlTemplate: options.astro?.markdown?.traceUrlTemplate,
-          customRenderers: options.astro?.markdown?.customRenderers
+          customRenderers: options.astro?.markdown?.customRenderers,
+          scenarioAnchor: options.astro?.markdown?.scenarioAnchor,
+          scenarioBadge: options.astro?.markdown?.scenarioBadge,
+          scenarioNoteLink: options.astro?.markdown?.scenarioNoteLink
         }
       },
       assetMode: options.assetMode ?? "none",