@adp-psych/npm-package-json-lint-config

npm-package-json-lint configuration

Usage no npm install needed!

<script type="module">
  import adpPsychNpmPackageJsonLintConfig from 'https://cdn.skypack.dev/@adp-psych/npm-package-json-lint-config';
</script>

README

Anthony Di Pietro’s npm-package-json-lint Configuration

The npm-package-json-lint configuration for Anthony Di Pietro’s projects.

Usage

Installation

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

npm install --save-dev @adp-psych/npm-package-json-lint-config

Install peer dependencies:

npm install --save-dev npm-package-json-lint npm-package-json-lint-config-default

Configuration

Configure npm-package-json-lint to use the configuration by editing npmpackagejsonlint.config.js:

module.exports = {
    'extends': '@adp-psych/npm-package-json-lint-config',
};

Development

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 configuration by linting itself with npm-package-json-lint:

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