mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
f27aba37b7
API changes:
+ No more `jsdoc/template` module. Each JSDoc template uses whatever templating system it wants.
+ No more TaffyDB. Each template finds doclets however it wants. (TODO: Update `jsdoc/util/templateHelper` so none of its methods expect a TaffyDB object.)
+ Templates are now loaded with `require('my-template-name-here')`. The resulting object must include a `publish` method.
+ The `publish` method now takes two parameters: a `data` object with `doclets` and `tutorials` properties, and an `options` object. `data.doclets` is just an array.
Other notable changes:
+ No more `haruki` template.
+ Moved the `default` and `silent` templates to new packages.
+ The `.tmpl` files for the `default` template (now called `@jsdoc/template-original`) no longer use custom delimiters.
@jsdoc/template-silent
A JSDoc template that generates no output.
Why would that be useful? Primarily for running JSDoc as a linter to check for syntax errors and unrecognized tags in documentation comments.
Installing the package
Using npm:
npm install --save @jsdoc/template-silent
Using the package
The following command exits with a non-zero exit code if any errors are
encountered. It writes nothing to disk, and the only output it produces is any
error messages written to stderr:
jsdoc myscript.js -t templates/silent -a all --pedantic
To get warnings about tags that JSDoc does not recognize, create a configuration
file called conf.json that sets "allowUnknownTags": false, then run the
following command:
jsdoc myscript.js -t templates/silent -a all -c conf.json --pedantic