@adp-psych/npm-check-updates-config/README.md

npm-check-updates configuration

# Anthony Di Pietro's npm-check-updates Configuration

The [npm-check-updates](https://github.com/raineorshine/npm-check-updates)
configuration for Anthony Di Pietro's projects.

## Usage

### Installation

Install the package from [npm](https://www.npmjs.com/)
(requires [Node.js](https://nodejs.org/)):

```sh
npm install --save-dev @adp-psych/npm-check-updates-config
```

### Configuration

Configure npm-check-updates to use the configuration by editing `.ncurc.js`:

```js
module.exports = require('@adp-psych/npm-check-updates-config');
```

## Development

### Cleaning

Remove generated files:

```sh
npm run clean
```

### Documentation

Generate documentation into the `doc` directory with
[JSDoc](https://jsdoc.app/):

```sh
npm run doc
```

### Linting

Lint the project with [ESLint](https://eslint.org/) and
[npm-package-json-lint](https://npmpackagejsonlint.org/):

```sh
npm run lint
```

### Testing

Test the command by running it:

```sh
npm run test
```

### Dependencies

Check for new dependencies with
[npm-check](https://github.com/dylang/npm-check):

```sh
npm run npm-check
```

### Release

Publish a release with [np](https://github.com/sindresorhus/np):

```sh
npm run release
```

## Legal Information

### Copyright

Copyright © 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/](https://www.gnu.org/licenses/).