executable-stories-formatters 1.16.1 → 1.17.1

package/dist/index.d.cts

@@ -199,7 +199,7 @@ declare class ConfluenceFormatter {
  */
 
 /** Output format for report generation */
-type OutputFormat = "agent-text" | "astro-markdown" | "behavior-manifest-json" | "confluence" | "cucumber-json" | "cucumber-messages" | "cucumber-html" | "html" | "junit" | "markdown" | "release-manifest" | "scenario-index-json" | "story-report-json" | "traceability-matrix" | "traceability-csv";
+type OutputFormat = "agent-text" | "astro-markdown" | "behavior-manifest-json" | "confluence" | "cucumber-json" | "cucumber-messages" | "cucumber-html" | "html" | "junit" | "markdown" | "release-manifest" | "scenario-index-json" | "span-graph" | "story-report-json" | "traceability-matrix" | "traceability-csv";
 /**
  * Format names accepted as INPUT. Adds `"astro"` as a deprecated alias for
  * `"astro-markdown"` — it is normalised (with a warning) wherever formats enter
@@ -345,6 +345,8 @@ interface FormatterOptions {
     markdown?: MarkdownFormatterOptions;
     /** Astro/Starlight specific options */
     astro?: AstroFormatterOptions$1;
+    /** Span-graph specific options */
+    spanGraph?: SpanGraphFormatterOptions;
     /** Confluence/ADF specific options */
     confluence?: ConfluenceFormatterOptions;
     /** History tracking options */
@@ -369,7 +371,7 @@ interface FormatterOptions {
         /** Generic webhook configurations */
         webhooks?: GenericWebhookNotifierOptions[];
     };
-    /** Asset bundling mode. "none" = no asset copying, "copy" = copy referenced assets next to HTML. Default: "none" */
+    /** Asset bundling mode. "none" = no asset copying, "copy" = copy referenced assets next to the report (html and markdown). Default: "none" */
     assetMode?: "none" | "copy";
     /** When true, warn on missing assets instead of throwing. Default: false */
     allowMissingAssets?: boolean;
@@ -379,6 +381,15 @@ interface FormatterOptions {
     writeFile?: WriteFile;
 }
 /** Markdown formatter options (extended for feature parity) */
+interface SpanGraphFormatterOptions {
+    /** Heading for the page. Default: "Architecture, as it ran" */
+    title?: string;
+    /** Scenario ids from a behavioural diff, which colour the changed components. */
+    delta?: {
+        added: string[];
+        changed: string[];
+    };
+}
 interface MarkdownFormatterOptions {
     /** Report title. Default: "User Stories" */
     title?: string;
@@ -412,6 +423,8 @@ interface MarkdownFormatterOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /** Keep local screenshot/video paths, for markdown posted with `gh ... --attach`. Default: false */
+    attachImages?: boolean;
     /** 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. */
@@ -508,7 +521,9 @@ interface ResolvedFormatterOptions {
         traceUrlTemplate?: string;
         includeSourceLinks: boolean;
         customRenderers?: MarkdownRenderers;
+        attachImages: boolean;
     };
+    spanGraph: SpanGraphFormatterOptions;
     confluence: {
         title: string;
         includeStatusIcons: boolean;
@@ -2046,6 +2061,14 @@ interface MarkdownOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /**
+     * Write a local screenshot/video path as an ordinary markdown reference
+     * instead of the "unavailable" line. Only for markdown handed to
+     * `gh pr comment|create|edit --attach <path>` (GitHub CLI 2.99+), which
+     * uploads the file and rewrites the reference. Anywhere else the reference
+     * is dead, which is why this is off by default. Default: false
+     */
+    attachImages?: boolean;
     /**
      * 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
@@ -3107,6 +3130,12 @@ declare class ReportGenerator {
      * @returns Map of output format to generated file paths
      */
     generate(run: TestRunResult, options?: GenerateOptions): Promise<GenerateResult>;
+    /**
+     * Copy every local asset these markdown reports reference into an assets
+     * directory and rewrite the refs. The destination is computed per report
+     * because colocated output writes one per source file.
+     */
+    private bundleMarkdownAssets;
     /**
      * Whether any output is colocated — the global mode, or any per-rule mode.
      * A colocated rule under a global aggregated mode still writes per-file

package/dist/index.d.ts

@@ -199,7 +199,7 @@ declare class ConfluenceFormatter {
  */
 
 /** Output format for report generation */
-type OutputFormat = "agent-text" | "astro-markdown" | "behavior-manifest-json" | "confluence" | "cucumber-json" | "cucumber-messages" | "cucumber-html" | "html" | "junit" | "markdown" | "release-manifest" | "scenario-index-json" | "story-report-json" | "traceability-matrix" | "traceability-csv";
+type OutputFormat = "agent-text" | "astro-markdown" | "behavior-manifest-json" | "confluence" | "cucumber-json" | "cucumber-messages" | "cucumber-html" | "html" | "junit" | "markdown" | "release-manifest" | "scenario-index-json" | "span-graph" | "story-report-json" | "traceability-matrix" | "traceability-csv";
 /**
  * Format names accepted as INPUT. Adds `"astro"` as a deprecated alias for
  * `"astro-markdown"` — it is normalised (with a warning) wherever formats enter
@@ -345,6 +345,8 @@ interface FormatterOptions {
     markdown?: MarkdownFormatterOptions;
     /** Astro/Starlight specific options */
     astro?: AstroFormatterOptions$1;
+    /** Span-graph specific options */
+    spanGraph?: SpanGraphFormatterOptions;
     /** Confluence/ADF specific options */
     confluence?: ConfluenceFormatterOptions;
     /** History tracking options */
@@ -369,7 +371,7 @@ interface FormatterOptions {
         /** Generic webhook configurations */
         webhooks?: GenericWebhookNotifierOptions[];
     };
-    /** Asset bundling mode. "none" = no asset copying, "copy" = copy referenced assets next to HTML. Default: "none" */
+    /** Asset bundling mode. "none" = no asset copying, "copy" = copy referenced assets next to the report (html and markdown). Default: "none" */
     assetMode?: "none" | "copy";
     /** When true, warn on missing assets instead of throwing. Default: false */
     allowMissingAssets?: boolean;
@@ -379,6 +381,15 @@ interface FormatterOptions {
     writeFile?: WriteFile;
 }
 /** Markdown formatter options (extended for feature parity) */
+interface SpanGraphFormatterOptions {
+    /** Heading for the page. Default: "Architecture, as it ran" */
+    title?: string;
+    /** Scenario ids from a behavioural diff, which colour the changed components. */
+    delta?: {
+        added: string[];
+        changed: string[];
+    };
+}
 interface MarkdownFormatterOptions {
     /** Report title. Default: "User Stories" */
     title?: string;
@@ -412,6 +423,8 @@ interface MarkdownFormatterOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /** Keep local screenshot/video paths, for markdown posted with `gh ... --attach`. Default: false */
+    attachImages?: boolean;
     /** 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. */
@@ -508,7 +521,9 @@ interface ResolvedFormatterOptions {
         traceUrlTemplate?: string;
         includeSourceLinks: boolean;
         customRenderers?: MarkdownRenderers;
+        attachImages: boolean;
     };
+    spanGraph: SpanGraphFormatterOptions;
     confluence: {
         title: string;
         includeStatusIcons: boolean;
@@ -2046,6 +2061,14 @@ interface MarkdownOptions {
     includeSourceLinks?: boolean;
     /** Custom renderers for doc entries */
     customRenderers?: MarkdownRenderers;
+    /**
+     * Write a local screenshot/video path as an ordinary markdown reference
+     * instead of the "unavailable" line. Only for markdown handed to
+     * `gh pr comment|create|edit --attach <path>` (GitHub CLI 2.99+), which
+     * uploads the file and rewrites the reference. Anywhere else the reference
+     * is dead, which is why this is off by default. Default: false
+     */
+    attachImages?: boolean;
     /**
      * 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
@@ -3107,6 +3130,12 @@ declare class ReportGenerator {
      * @returns Map of output format to generated file paths
      */
     generate(run: TestRunResult, options?: GenerateOptions): Promise<GenerateResult>;
+    /**
+     * Copy every local asset these markdown reports reference into an assets
+     * directory and rewrite the refs. The destination is computed per report
+     * because colocated output writes one per source file.
+     */
+    private bundleMarkdownAssets;
     /**
      * Whether any output is colocated — the global mode, or any per-rule mode.
      * A colocated rule under a global aggregated mode still writes per-file