@enact/docs-utils

0.4.10 • Public • Published

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:

npm install --save-dev @enact/docs-utils
  "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

Readme

Keywords

Package Sidebar

Install

npm i @enact/docs-utils

Weekly Downloads

480

Version

0.4.10

License

Apache-2.0

Unpacked Size

41.2 kB

Total Files

8

Last publish

Collaborators

  • enact