jiji-hoon96/oxdoc
Native-speed documentation coverage, doctest, and API diff for TypeScript/JavaScript
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| source | Source directory to analyze | no | ./src |
| commands | Commands to run (space-separated: coverage doctest diff generate) | no | coverage doctest |
| threshold | Minimum documentation coverage percentage (0-100) | no | 0 |
| format | Output format for generate command (json, markdown, html, llms-txt) | no | json |
| output | Output directory for generate command | no | ./docs-output |
| diff-snapshot | Path to previous JSON snapshot for diff command | no | "" |
| fail-on-breaking | Fail if breaking API changes detected (for diff command) | no | false |
| node-version | Node.js version to use | no | 20 |
Outputs
| name | description |
|---|---|
| coverage | Documentation coverage percentage |
| doctest-passed | Number of doctest assertions passed |
| doctest-failed | Number of doctest assertions failed |