sporel/sporel-lib-core.maps-test
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(maps-test): add API section documenting run_tests entrypoint

Browse Source 
Test-libs expose a single public function (run_tests) per ADR-0037.
Documenting it under ## API allows --lint to pass cleanly on test-libs,
now that parse_readme_api supports namespace-less H3 headers.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Axel Meyer
2026-05-16 17:51:54 +02:00
parent 30b909a54f
commit 83ab0526e9
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -75,6 +75,13 @@ Sporel.exe --libs-dir=<libs-path> --test-libs=lib-core.maps-test
Output is TAP version 13 on stdout; exit-code = failure-count (0 = all pass). Output is TAP version 13 on stdout; exit-code = failure-count (0 = all pass).
## API
### `run_tests(ctx)`
**Syntax:** `M.run_tests(ctx) → void` (test-lib entrypoint per ADR-0037)
Executes the test-suite against `lib-core.maps`. Calls `engine.exit(engine.test.failures())` at end; exit-code = failure-count.
## References ## References
- ADR-0037 (Tests-as-Libs Convention) - ADR-0037 (Tests-as-Libs Convention)