https://github.com/enactjs/docs-utils

Utilities for parsing and validating JSDoc
https://github.com/enactjs/docs-utils

Last synced: 3 months 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 (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-03-28T05:46:51.000Z (4 months ago)
• Last Synced: 2025-04-13T05:52:09.386Z (3 months ago)
• Language: JavaScript
• Size: 1.21 MB
• Stars: 0
• Watchers: 19
• Forks: 2
• Open Issues: 1
• 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