@adp-psych/eslint-config

ESLint configuration

Usage no npm install needed!

<script type="module">
  import adpPsychEslintConfig from 'https://cdn.skypack.dev/@adp-psych/eslint-config';
</script>

README

Anthony Di Pietro’s ESLint Configuration

The ESLint configuration for Anthony Di Pietro’s projects.

Usage

Installation

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

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

Install peer dependencies:

npm install --save-dev eslint@next eslint-plugin-array-func eslint-plugin-ava eslint-plugin-babel eslint-plugin-eslint-comments eslint-plugin-filenames eslint-plugin-fp eslint-plugin-html eslint-plugin-import eslint-plugin-jsdoc eslint-plugin-no-use-extend-native eslint-plugin-node eslint-plugin-prefer-arrow eslint-plugin-prefer-object-spread eslint-plugin-promise eslint-plugin-security eslint-plugin-sort-class-members eslint-plugin-unicorn eslint-plugin-xss

Configuration

Configure ESLint to use the configuration by editing eslint.config.js:

module.exports = {
    'extends': '@adp-psych',
};

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 ESLint:

npm run test

Dependencies

Check for new dependencies with npm-check:

npm run npm-check

Rules

Check for new rules with eslint-find-rules:

npm run eslint-find-rules

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