executable-stories-formatters 1.20.0 → 1.21.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -37
- package/dist/cli.js +438 -965
- package/dist/cli.js.map +1 -1
- package/dist/index.cjs +201 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +78 -6
- package/dist/index.d.ts +78 -6
- package/dist/index.js +196 -2
- package/dist/index.js.map +1 -1
- package/package.json +2 -3
- package/templates/astro-thin/astro.config.mjs +0 -46
- package/templates/astro-thin/executable-stories.config.mjs +0 -76
- package/templates/astro-thin/gitignore +0 -3
- package/templates/astro-thin/package.json +0 -20
- package/templates/astro-thin/reports/sample-run.json +0 -214
- package/templates/astro-thin/src/content/docs/404.md +0 -20
- package/templates/astro-thin/src/content/docs/guides/writing-docs.mdx +0 -58
- package/templates/astro-thin/src/content/docs/index.mdx +0 -51
- package/templates/astro-thin/src/content.config.ts +0 -33
- package/templates/astro-thin/src/styles/stories.css +0 -32
- package/templates/astro-thin/tsconfig.json +0 -5
package/README.md
CHANGED
|
@@ -209,43 +209,6 @@ A component appears because a span named it while a scenario ran; an arrow is th
|
|
|
209
209
|
|
|
210
210
|
It draws instrumented, exercised paths only. A component no scenario reaches does not appear, which is the same shape as coverage and worth reading as such. **A run with no spans writes no file**, so adding the format to a preset costs nothing until something is instrumented.
|
|
211
211
|
|
|
212
|
-
## Living docs site (Confluence replacement)
|
|
213
|
-
|
|
214
|
-
Scaffold an Astro/Starlight site whose pages stay honest because the tests keep
|
|
215
|
-
them verified. These commands operate on the canonical story report, so they
|
|
216
|
-
work for stories written in **any language** (TypeScript, Python, Go, Ruby,
|
|
217
|
-
Java/Kotlin, Rust, C#).
|
|
218
|
-
|
|
219
|
-
```bash
|
|
220
|
-
# 1. Scaffold the thin site (the executable-stories-astro integration ships the
|
|
221
|
-
# verified-by badges, health dashboard, and Scenario Explorer)
|
|
222
|
-
executable-stories init-astro story-docs
|
|
223
|
-
|
|
224
|
-
# 2. Run your tests to write run.json, then start the Astro dev server.
|
|
225
|
-
# The integration loads run.json as a live `stories` collection — pages at
|
|
226
|
-
# /stories hot-reload as tests re-run; no Markdown generation step.
|
|
227
|
-
cd story-docs && npm install && npm run dev
|
|
228
|
-
|
|
229
|
-
# 3. Start hand-written pages from a verified template
|
|
230
|
-
executable-stories new adr "Cap combined discount at 30%" # also: runbook, decision-log, incident
|
|
231
|
-
|
|
232
|
-
# 4. Generate API docs with per-endpoint test coverage
|
|
233
|
-
executable-stories import-openapi openapi.json --run run.json --output-dir story-docs/src/content/docs/api
|
|
234
|
-
|
|
235
|
-
# 5. Fail CI if docs links rot
|
|
236
|
-
executable-stories check-links story-docs/src/content/docs
|
|
237
|
-
```
|
|
238
|
-
|
|
239
|
-
Any page can declare the stories that prove it. The badge under the title turns
|
|
240
|
-
red the moment a linked story fails:
|
|
241
|
-
|
|
242
|
-
```yaml
|
|
243
|
-
---
|
|
244
|
-
title: ADR 0007 — Cap combined discount at 30%
|
|
245
|
-
verifiedBy: [pricing, checkout--caps-the-discount-at-30-percent]
|
|
246
|
-
---
|
|
247
|
-
```
|
|
248
|
-
|
|
249
212
|
## Architecture
|
|
250
213
|
|
|
251
214
|
```
|