Anthony Di Pietro's JSDoc Configuration
The JSDoc configuration for Anthony Di Pietro's projects.
npm install --save-dev @adp-psych/jsdoc-config
Configure JSDoc to use the configuration by editing
module.exports = require('@adp-psych/jsdoc-config');
Remove generated files:
npm run clean
Generate documentation into the
doc directory with
npm run doc
npm run lint
Test the command by running it:
npm run test
Check for new dependencies with npm-check:
npm run npm-check
Publish a release with np:
npm run release
Copyright © 2020 Anthony Di Pietro
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see https://www.gnu.org/licenses/.