executable-stories-formatters 0.17.0 → 1.0.1

package/schemas/story-report-v1.json

@@ -1,456 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://executable-stories.dev/schemas/story-report-v1.schema.json",
-  "title": "StoryReport",
-  "description": "Pre-grouped, denormalized report shape consumed by UI renderers (React, Svelte, Vue, etc.). Stable public contract — additive-only within a major. Distinct from internal TestRunResult.",
-  "type": "object",
-  "$ref": "#/$defs/StoryReport",
-  "$defs": {
-    "StoryReport": {
-      "type": "object",
-      "description": "Top-level report containing all features, runtime metadata, and a pre-computed summary.",
-      "properties": {
-        "schemaVersion": {
-          "type": "string",
-          "pattern": "^1\\.[0-9]+$",
-          "description": "Schema version as 'major.minor'. Major bumps are breaking; minors are additive-only. UI packages must accept any 1.x."
-        },
-        "runId": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Unique deterministic identifier for this run."
-        },
-        "startedAtMs": {
-          "type": "number",
-          "minimum": 0,
-          "description": "Run start time as Unix epoch milliseconds."
-        },
-        "finishedAtMs": {
-          "type": "number",
-          "minimum": 0,
-          "description": "Run finish time as Unix epoch milliseconds."
-        },
-        "durationMs": {
-          "type": "number",
-          "minimum": 0,
-          "description": "Total run duration in milliseconds."
-        },
-        "projectRoot": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Absolute path to the project root (for context only; relative paths in features.sourceFile are preferred)."
-        },
-        "packageVersion": {
-          "type": "string",
-          "description": "Version of the package under test, if known."
-        },
-        "gitSha": {
-          "type": "string",
-          "description": "Git commit SHA at the time of the run."
-        },
-        "ci": {
-          "$ref": "#/$defs/CIInfo"
-        },
-        "coverage": {
-          "$ref": "#/$defs/CoverageSummary"
-        },
-        "summary": {
-          "$ref": "#/$defs/Summary",
-          "description": "Pre-computed counts across all features and scenarios."
-        },
-        "features": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/Feature" },
-          "description": "Features grouped by sourceFile, sorted by title."
-        }
-      },
-      "required": ["schemaVersion", "runId", "startedAtMs", "finishedAtMs", "durationMs", "projectRoot", "summary", "features"],
-      "additionalProperties": false
-    },
-    "Summary": {
-      "type": "object",
-      "description": "Counts by status. Sums equal 'total'.",
-      "properties": {
-        "total": { "type": "integer", "minimum": 0 },
-        "passed": { "type": "integer", "minimum": 0 },
-        "failed": { "type": "integer", "minimum": 0 },
-        "skipped": { "type": "integer", "minimum": 0 },
-        "pending": { "type": "integer", "minimum": 0 },
-        "durationMs": { "type": "number", "minimum": 0 }
-      },
-      "required": ["total", "passed", "failed", "skipped", "pending", "durationMs"],
-      "additionalProperties": false
-    },
-    "Feature": {
-      "type": "object",
-      "description": "A group of scenarios from the same source file.",
-      "properties": {
-        "id": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Stable slug derived from the relative source path. Suitable for use as a deep-link anchor."
-        },
-        "title": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Display title. Derived from describe block when present, otherwise the file basename."
-        },
-        "sourceFile": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Source path, relative to projectRoot when possible."
-        },
-        "summary": { "$ref": "#/$defs/Summary" },
-        "scenarios": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/Scenario" },
-          "description": "Scenarios in this feature, in declaration order."
-        }
-      },
-      "required": ["id", "title", "sourceFile", "summary", "scenarios"],
-      "additionalProperties": false
-    },
-    "Scenario": {
-      "type": "object",
-      "description": "A single scenario with its steps, story-level doc entries, and attachments.",
-      "properties": {
-        "id": {
-          "type": "string",
-          "minLength": 1,
-          "description": "Stable identifier: '<feature.id>--<slug-of-title>'. Suitable for use as a deep-link anchor."
-        },
-        "title": { "type": "string", "minLength": 1 },
-        "status": { "$ref": "#/$defs/TestStatus" },
-        "durationMs": { "type": "number", "minimum": 0 },
-        "tags": {
-          "type": "array",
-          "items": { "type": "string" },
-          "description": "Normalized tags, deduplicated, lowercased."
-        },
-        "tickets": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/Ticket" }
-        },
-        "covers": {
-          "type": "array",
-          "items": { "type": "string" },
-          "description": "Product-code paths/globs this scenario exercises."
-        },
-        "sourceLine": { "type": "integer", "minimum": 1 },
-        "errorMessage": { "type": "string" },
-        "errorStack": { "type": "string" },
-        "retry": { "type": "integer", "minimum": 0 },
-        "retries": { "type": "integer", "minimum": 0 },
-        "docEntries": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" },
-          "description": "Story-level doc entries (rendered before steps)."
-        },
-        "steps": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/Step" }
-        },
-        "attachments": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/Attachment" }
-        }
-      },
-      "required": ["id", "title", "status", "durationMs", "tags", "retry", "retries", "docEntries", "steps", "attachments"],
-      "additionalProperties": false
-    },
-    "Step": {
-      "type": "object",
-      "description": "A single BDD step.",
-      "properties": {
-        "id": { "type": "string", "minLength": 1 },
-        "index": { "type": "integer", "minimum": 0 },
-        "keyword": { "$ref": "#/$defs/StepKeyword" },
-        "text": { "type": "string" },
-        "status": { "$ref": "#/$defs/TestStatus" },
-        "durationMs": { "type": "number", "minimum": 0 },
-        "errorMessage": { "type": "string" },
-        "mode": { "$ref": "#/$defs/StepMode" },
-        "docEntries": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" },
-          "description": "Doc entries attached to this step."
-        }
-      },
-      "required": ["id", "index", "keyword", "text", "status", "durationMs", "docEntries"],
-      "additionalProperties": false
-    },
-    "StepKeyword": {
-      "type": "string",
-      "enum": ["Given", "When", "Then", "And", "But"]
-    },
-    "StepMode": {
-      "type": "string",
-      "enum": ["normal", "skip", "only", "todo", "fails", "concurrent"]
-    },
-    "TestStatus": {
-      "type": "string",
-      "enum": ["passed", "failed", "skipped", "pending"]
-    },
-    "Ticket": {
-      "type": "object",
-      "properties": {
-        "id": { "type": "string", "minLength": 1 },
-        "url": { "type": "string" }
-      },
-      "required": ["id"],
-      "additionalProperties": false
-    },
-    "Attachment": {
-      "type": "object",
-      "properties": {
-        "name": { "type": "string" },
-        "mediaType": { "type": "string", "minLength": 1 },
-        "body": { "type": "string" },
-        "contentEncoding": {
-          "type": "string",
-          "enum": ["BASE64", "IDENTITY"]
-        }
-      },
-      "required": ["name", "mediaType", "body", "contentEncoding"],
-      "additionalProperties": false
-    },
-    "CIInfo": {
-      "type": "object",
-      "properties": {
-        "name": { "type": "string" },
-        "url": { "type": "string" },
-        "buildNumber": { "type": "string" },
-        "branch": { "type": "string" },
-        "commitSha": { "type": "string" },
-        "prNumber": { "type": "string" }
-      },
-      "required": ["name"],
-      "additionalProperties": false
-    },
-    "CoverageSummary": {
-      "type": "object",
-      "properties": {
-        "linesPct": { "type": "number", "minimum": 0, "maximum": 100 },
-        "branchesPct": { "type": "number", "minimum": 0, "maximum": 100 },
-        "functionsPct": { "type": "number", "minimum": 0, "maximum": 100 },
-        "statementsPct": { "type": "number", "minimum": 0, "maximum": 100 }
-      },
-      "additionalProperties": false
-    },
-    "DocPhase": {
-      "type": "string",
-      "enum": ["static", "runtime"]
-    },
-    "DocEntry": {
-      "oneOf": [
-        { "$ref": "#/$defs/DocNote" },
-        { "$ref": "#/$defs/DocTag" },
-        { "$ref": "#/$defs/DocKv" },
-        { "$ref": "#/$defs/DocCode" },
-        { "$ref": "#/$defs/DocTable" },
-        { "$ref": "#/$defs/DocLink" },
-        { "$ref": "#/$defs/DocSection" },
-        { "$ref": "#/$defs/DocMermaid" },
-        { "$ref": "#/$defs/DocScreenshot" },
-        { "$ref": "#/$defs/DocVideo" },
-        { "$ref": "#/$defs/DocHtml" },
-        { "$ref": "#/$defs/DocCustom" }
-      ]
-    },
-    "DocNote": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "note" },
-        "text": { "type": "string" },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "text", "phase"],
-      "additionalProperties": false
-    },
-    "DocTag": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "tag" },
-        "names": { "type": "array", "items": { "type": "string" } },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "names", "phase"],
-      "additionalProperties": false
-    },
-    "DocKv": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "kv" },
-        "label": { "type": "string" },
-        "value": {},
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "label", "value", "phase"],
-      "additionalProperties": false
-    },
-    "DocCode": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "code" },
-        "label": { "type": "string" },
-        "content": { "type": "string" },
-        "lang": { "type": "string" },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "label", "content", "phase"],
-      "additionalProperties": false
-    },
-    "DocTable": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "table" },
-        "label": { "type": "string" },
-        "columns": { "type": "array", "items": { "type": "string" } },
-        "rows": {
-          "type": "array",
-          "items": {
-            "type": "array",
-            "items": { "type": "string" }
-          }
-        },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "label", "columns", "rows", "phase"],
-      "additionalProperties": false
-    },
-    "DocLink": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "link" },
-        "label": { "type": "string" },
-        "url": { "type": "string" },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "label", "url", "phase"],
-      "additionalProperties": false
-    },
-    "DocSection": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "section" },
-        "title": { "type": "string" },
-        "markdown": { "type": "string" },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "title", "markdown", "phase"],
-      "additionalProperties": false
-    },
-    "DocMermaid": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "mermaid" },
-        "code": { "type": "string" },
-        "title": { "type": "string" },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "code", "phase"],
-      "additionalProperties": false
-    },
-    "DocScreenshot": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "screenshot" },
-        "path": { "type": "string" },
-        "alt": { "type": "string" },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "path", "phase"],
-      "additionalProperties": false
-    },
-    "DocVideo": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "video" },
-        "path": { "type": "string" },
-        "caption": { "type": "string" },
-        "poster": { "type": "string" },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "path", "phase"],
-      "additionalProperties": false
-    },
-    "DocHtml": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "html" },
-        "path": { "type": "string" },
-        "url": { "type": "string" },
-        "content": { "type": "string" },
-        "title": { "type": "string" },
-        "height": { "oneOf": [{ "type": "number" }, { "type": "string" }] },
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "phase"],
-      "oneOf": [
-        { "required": ["path"] },
-        { "required": ["url"] },
-        { "required": ["content"] }
-      ],
-      "additionalProperties": false
-    },
-    "DocCustom": {
-      "type": "object",
-      "properties": {
-        "kind": { "const": "custom" },
-        "type": { "type": "string", "minLength": 1 },
-        "data": {},
-        "phase": { "$ref": "#/$defs/DocPhase" },
-        "children": {
-          "type": "array",
-          "items": { "$ref": "#/$defs/DocEntry" }
-        }
-      },
-      "required": ["kind", "type", "data", "phase"],
-      "additionalProperties": false
-    }
-  }
-}

package/templates/astro-starlight/astro.config.mjs

@@ -1,57 +0,0 @@
-// @ts-check
-import starlight from '@astrojs/starlight';
-import astroMermaid from 'astro-mermaid';
-import remarkGfm from 'remark-gfm';
-import { defineConfig } from 'astro/config';
-
-/*
- * Available themes (match HTML formatter themes):
- *   default    — cucumber green, IBM Plex typography
- *   corporate  — navy, Playfair Display serif headings
- *   terminal   — green-on-dark, JetBrains Mono, flat
- *   minimal    — teal, Noto Serif Display headings, warm neutrals
- *   dashboard  — blue, DM Sans + JetBrains Mono
- *   playful    — coral, rounded corners, Source Sans 3
- *
- * To switch themes, replace `themes/default.css` below with the filename
- * of the theme you want (e.g. `./src/styles/themes/corporate.css`).
- */
-
-export default defineConfig({
-  // GFM tables don't render in .mdx by default — enable them so hand-written
-  // and generated .mdx pages (ADRs, API coverage, decision logs) show tables.
-  markdown: {
-    remarkPlugins: [remarkGfm],
-  },
-  integrations: [
-    astroMermaid(),
-    starlight({
-      title: 'Story Docs',
-      description: 'Living documentation generated from executable stories.',
-      // Renders a live verification badge under the title of any page that
-      // declares `verifiedBy` in its frontmatter.
-      components: {
-        PageTitle: './src/components/PageTitle.astro',
-      },
-      sidebar: [
-        { label: 'Home', slug: 'index' },
-        { label: 'Explorer', link: '/explorer/' },
-        // Hand-written content — edited by the team, never overwritten by a regenerate.
-        { label: 'Guides', autogenerate: { directory: 'guides' } },
-        { label: 'Notes', autogenerate: { directory: 'notes' } },
-        // Autogenerated, not a hard-coded slug — clearing the sample ADR (or the
-        // whole directory) leaves the build green instead of 404ing on a missing slug.
-        { label: 'Examples', autogenerate: { directory: 'examples' } },
-        // Generated from tests by `format --format astro`.
-        {
-          label: 'Stories',
-          autogenerate: { directory: 'stories' },
-        },
-      ],
-      customCss: [
-        './src/styles/global.css',
-        './src/styles/themes/default.css',
-      ],
-    }),
-  ],
-});

package/templates/astro-starlight/gitignore

@@ -1,14 +0,0 @@
-node_modules/
-.astro/
-dist/
-
-# Machine-owned portal output. Regenerated by build-docs / CI.
-src/content/docs/stories/*
-!src/content/docs/stories/.gitkeep
-public/stories/assets/*
-!public/stories/assets/.gitkeep
-public/stories/story-report.json
-public/stories/scenario-links.json
-public/stories/notes-index.json
-!public/stories/notes-index.json
-public/stories/changes.json

package/templates/astro-starlight/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "story-docs",
-  "type": "module",
-  "version": "0.0.1",
-  "private": true,
-  "scripts": {
-    "dev": "astro dev",
-    "build": "astro build",
-    "preview": "astro preview"
-  },
-  "dependencies": {
-    "@astrojs/starlight": "^0.38.3",
-    "astro": "^6.1.8",
-    "astro-mermaid": "^2.0.1",
-    "highlight.js": "^11.10.0",
-    "marked": "^12.0.0",
-    "mermaid": "^11.14.0",
-    "remark-gfm": "^4.0.0"
-  }
-}

package/templates/astro-starlight/public/stories/notes-index.json

@@ -1,4 +0,0 @@
-{
-  "schemaVersion": "1.0",
-  "notes": []
-}

package/templates/astro-starlight/public/stories/story-report.json

@@ -1,17 +0,0 @@
-{
-  "schemaVersion": "1.0",
-  "runId": "empty",
-  "startedAtMs": 0,
-  "finishedAtMs": 0,
-  "durationMs": 0,
-  "projectRoot": "",
-  "summary": {
-    "total": 0,
-    "passed": 0,
-    "failed": 0,
-    "skipped": 0,
-    "pending": 0,
-    "durationMs": 0
-  },
-  "features": []
-}