@adp-psych/jsdoc-config v2.1.4

Anthony Di Pietro's JSDoc Configuration

The JSDoc configuration for Anthony Di Pietro's projects.

Usage

Installation

Install the package from npm (requires Node.js):

npm install --save-dev @adp-psych/jsdoc-config

Configuration

Configure JSDoc to use the configuration by editing jsdoc.config.js:

module.exports = require('@adp-psych/jsdoc-config');

Development

Cleaning

Remove generated files:

npm run clean

Documentation

Generate documentation into the doc directory with JSDoc:

npm run doc

Linting

Lint the project with ESLint and npm-package-json-lint:

npm run lint

Testing

Test the command by running it:

npm run test

Dependencies

Check for new dependencies with npm-check:

npm run npm-check

Release

Publish a release with np:

npm run release

Legal Information

Copyright

Copyright © 2018, 2019, 2020, 2021, 2022 Anthony Di Pietro

License

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/.