Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enactjs/docs-utils
Utilities for parsing and validating JSDoc
https://github.com/enactjs/docs-utils
Last synced: about 1 month ago
JSON representation
Utilities for parsing and validating JSDoc
- Host: GitHub
- URL: https://github.com/enactjs/docs-utils
- Owner: enactjs
- License: apache-2.0
- Created: 2020-01-30T20:53:01.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T07:48:46.000Z (4 months ago)
- Last Synced: 2024-11-11T21:54:25.248Z (2 months ago)
- Language: JavaScript
- Size: 762 KB
- Stars: 0
- Watchers: 21
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# docs-utils
> Utilities for parsing and validating JSDoc
**Note:** Requires Node 14+.
## Standalone Usage
Can be used standalone to validate inline documentation. Add as a dev dependency and create an npm task:
```sh
npm install --save-dev @enact/docs-utils
```
```json
"validate-docs": "validate-docs --strict --standalone"
```
### Options
`--standalone` - Operate in standalone mode
`--strict` - Set exit code when warnings are discovered
`--path` - Path to scan for modules. Defaults to current directory