✨ Compile doc code fences into tests
Every `ts`-tagged fence in README.md / CONTRIBUTING.md now becomes an executed `node:test` case in a gitignored generated file, so a documented example cannot drift from the API. The generator hoists and merges the leading imports, rewrites the library specifier to the `#test-tiny-pattern-ts` alias, and rejects a fence with no describing paragraph or one that re-imports a prelude module. CI regenerates via `pretest:ci`; `create:doc-tests` runs the generator, formats, then typechecks the output against a scoped tsconfig that relaxes `noUnusedLocals`. c8's default excludes already omit the generated `*.test.ts`, so `test:ci` is unchanged.
This commit is contained in:
1 parent
d1963b0329
commit
30d97a9209
15 files changed
+1180
-8
No files matched your search
@@ -0,0 +1,12 @@
|
||||
# Generated doc-tests
|
||||
|
||||
`__generated__/` is the output of [`scripts/create-doc-tests.ts`](../../scripts/create-doc-tests.ts):
|
||||
each `*.test.ts` is compiled from the ```ts fences in a prose doc and is
|
||||
**gitignored**, not edited by hand. `npm run create:doc-tests` regenerates them,
|
||||
formats them with `oxfmt`, then type-checks them with
|
||||
[`tsconfig.json`](./tsconfig.json) — the scoped config that relaxes
|
||||
`noUnusedLocals` so example-only locals (and the injected `assert`) compile.
|
||||
|
||||
CI regenerates them first via `pretest:ci`; the fast local `test` / `verify`
|
||||
tiers do not. See [development/docs.md](../../development/docs.md) for why the
|
||||
generator is shaped this way.
|
||||
Reference in new issue
Block a user