executable-stories-formatters 1.17.1 → 1.19.0

package/dist/index.d.cts

@@ -273,6 +273,21 @@ interface FormatterOptions {
     sortTestCases?: SortTestCasesMode;
     /** Output routing configuration */
     output?: OutputConfig;
+    /**
+     * Link templates that apply to every format that can render a link.
+     *
+     * One place to say "this is where our tickets live", rather than repeating
+     * it per format: markdown, confluence and astro-markdown take these as their
+     * default, and the StoryReport (HTML report, Astro pages, story-report-json)
+     * resolves ticket URLs from `ticketUrlTemplate`. A per-format option of the
+     * same name still wins where one is set.
+     */
+    /** Base URL for source permalinks. E.g., "https://github.com/user/repo/blob/main" */
+    permalinkBaseUrl?: string;
+    /** URL template for ticket links. `{ticket}` is the id. E.g., "https://jira.example.com/browse/{ticket}" */
+    ticketUrlTemplate?: string;
+    /** URL template for trace links. `{traceId}` is the trace id. */
+    traceUrlTemplate?: string;
     /** Cucumber JSON specific options */
     cucumberJson?: {
         /** Pretty-print JSON output. Default: false */
@@ -310,6 +325,13 @@ interface FormatterOptions {
         staleAfterDays?: number;
         /** Show the Share button in the interactive report header. Default: false. */
         share?: boolean;
+        /**
+         * Draw the "Architecture, as it ran" section (the run's span graph) above
+         * the features. Default: false. Only an instrumented run has anything to
+         * draw, so it is opt-in rather than a section most reports would leave
+         * empty. `--html-architecture`.
+         */
+        architecture?: boolean;
         /** Command the share dialog shows. Default: `npx executable-stories share <output-dir>`. */
         shareCommand?: string;
     };
@@ -491,6 +513,9 @@ interface ResolvedFormatterOptions {
             toolVersion?: string;
         };
     };
+    permalinkBaseUrl: string | undefined;
+    ticketUrlTemplate: string | undefined;
+    traceUrlTemplate: string | undefined;
     html: {
         title: string;
         syntaxHighlighting: boolean;
@@ -498,6 +523,7 @@ interface ResolvedFormatterOptions {
         staleAfterDays: number;
         share: boolean;
         shareCommand: string | undefined;
+        architecture: boolean;
     };
     historyStore: HistoryStore | undefined;
     junit: {
@@ -1171,6 +1197,13 @@ interface Formatter {
 }
 interface ExecutableStoriesConfig {
     formatters?: Record<string, Formatter>;
+    /**
+     * Default values for CLI flags, keyed by flag name without the dashes
+     * (`"html-title": "Checkout"`, `"html-architecture": true`). Anything typed
+     * on the command line wins. Plain data, so a `.json` config carries it too —
+     * which is the only way the non-JS adapters' users can set these at all.
+     */
+    defaults?: Record<string, string | number | boolean | (string | number)[]>;
     /**
      * Test-management targets for `coverage` and `sync`. Shape only — credentials
      * are read from the environment so this file stays committable.
@@ -1661,6 +1694,12 @@ declare class CucumberJsonFormatter {
 interface StoryReportJsonOptions {
     /** Pretty-print JSON output with 2-space indent. Default: true. */
     pretty?: boolean;
+    /**
+     * URL template for tickets that carry no URL of their own (`{ticket}` is the
+     * id). The same template the HTML report resolves with, so the contract an
+     * agent reads and the page a person opens link a ticket to the same place.
+     */
+    ticketUrlTemplate?: string;
 }
 declare class StoryReportJsonFormatter {
     private options;

package/dist/index.d.ts

@@ -273,6 +273,21 @@ interface FormatterOptions {
     sortTestCases?: SortTestCasesMode;
     /** Output routing configuration */
     output?: OutputConfig;
+    /**
+     * Link templates that apply to every format that can render a link.
+     *
+     * One place to say "this is where our tickets live", rather than repeating
+     * it per format: markdown, confluence and astro-markdown take these as their
+     * default, and the StoryReport (HTML report, Astro pages, story-report-json)
+     * resolves ticket URLs from `ticketUrlTemplate`. A per-format option of the
+     * same name still wins where one is set.
+     */
+    /** Base URL for source permalinks. E.g., "https://github.com/user/repo/blob/main" */
+    permalinkBaseUrl?: string;
+    /** URL template for ticket links. `{ticket}` is the id. E.g., "https://jira.example.com/browse/{ticket}" */
+    ticketUrlTemplate?: string;
+    /** URL template for trace links. `{traceId}` is the trace id. */
+    traceUrlTemplate?: string;
     /** Cucumber JSON specific options */
     cucumberJson?: {
         /** Pretty-print JSON output. Default: false */
@@ -310,6 +325,13 @@ interface FormatterOptions {
         staleAfterDays?: number;
         /** Show the Share button in the interactive report header. Default: false. */
         share?: boolean;
+        /**
+         * Draw the "Architecture, as it ran" section (the run's span graph) above
+         * the features. Default: false. Only an instrumented run has anything to
+         * draw, so it is opt-in rather than a section most reports would leave
+         * empty. `--html-architecture`.
+         */
+        architecture?: boolean;
         /** Command the share dialog shows. Default: `npx executable-stories share <output-dir>`. */
         shareCommand?: string;
     };
@@ -491,6 +513,9 @@ interface ResolvedFormatterOptions {
             toolVersion?: string;
         };
     };
+    permalinkBaseUrl: string | undefined;
+    ticketUrlTemplate: string | undefined;
+    traceUrlTemplate: string | undefined;
     html: {
         title: string;
         syntaxHighlighting: boolean;
@@ -498,6 +523,7 @@ interface ResolvedFormatterOptions {
         staleAfterDays: number;
         share: boolean;
         shareCommand: string | undefined;
+        architecture: boolean;
     };
     historyStore: HistoryStore | undefined;
     junit: {
@@ -1171,6 +1197,13 @@ interface Formatter {
 }
 interface ExecutableStoriesConfig {
     formatters?: Record<string, Formatter>;
+    /**
+     * Default values for CLI flags, keyed by flag name without the dashes
+     * (`"html-title": "Checkout"`, `"html-architecture": true`). Anything typed
+     * on the command line wins. Plain data, so a `.json` config carries it too —
+     * which is the only way the non-JS adapters' users can set these at all.
+     */
+    defaults?: Record<string, string | number | boolean | (string | number)[]>;
     /**
      * Test-management targets for `coverage` and `sync`. Shape only — credentials
      * are read from the environment so this file stays committable.
@@ -1661,6 +1694,12 @@ declare class CucumberJsonFormatter {
 interface StoryReportJsonOptions {
     /** Pretty-print JSON output with 2-space indent. Default: true. */
     pretty?: boolean;
+    /**
+     * URL template for tickets that carry no URL of their own (`{ticket}` is the
+     * id). The same template the HTML report resolves with, so the contract an
+     * agent reads and the page a person opens link a ticket to the same place.
+     */
+    ticketUrlTemplate?: string;
 }
 declare class StoryReportJsonFormatter {
     private options;