@nhcarrigan/eslint-config

Naomi's ESLint Config

This package holds my ESLint configuration for easy installation and syncing changes across projects.

Live Version

This package is currently published. View the npm page.

Installation

To install this package, run the following command:

npm i @nhcarrigan/eslint-config eslint

Compatibility

This package is compatible with ESLint 8.

Usage

To use this package, add the following to your .eslintrc.json file:

{
  "extends": "@nhcarrigan/eslint-config"
}

Warnings and Errors

A rule is set to be a warning when it is something that is okay during development (e.g. using a console.log, or not having a JSDoc definition yet) but should not make it to production code.

A rule is set to an error when it is something that should not occur in development or production (e.g. missing semi-colons, using loose equality).

Feedback and Bugs

If you have feedback or a bug report, please feel free to open a GitHub issue!

Contributing

If you would like to contribute to the project, you may create a Pull Request containing your proposed changes and we will review it as soon as we are able! Please review our contributing guidelines first.

Code of Conduct

Before interacting with our community, please read our Code of Conduct.

Licensing

Copyright (C) 2022 Naomi Carrigan

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.

The full license terms may be viewed in the LICENSE.md file

Contact

We may be contacted through our Chat Server or via email at [e-mail].