Skip to content
forked from enactjs/docs-utils

Utilities for parsing and validating JSDoc

License

Notifications You must be signed in to change notification settings

sjro/docs-utils

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docs-utils

Utilities for parsing and validating JSDoc

Note: Requires Node 10.10+. Not designed to run on Windows.

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

About

Utilities for parsing and validating JSDoc

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%