nhcarrigan/eslint-config
2
0
Fork 0
generated from nhcarrigan/template
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

feat: migrate to eslint verison 9 (#1)

Browse Source 
This is a pretty sizeable change. It also removes all external configuration sets. Every rule is now defined by us.

Additionally, this version will conflict with other formatters, and should not be used in tandem with Prettier.

Reviewed-on: https://codeberg.org/nhcarrigan/eslint-config/pulls/1
Co-authored-by: Naomi Carrigan <commits@nhcarrigan.com>
Co-committed-by: Naomi Carrigan <commits@nhcarrigan.com>
This commit is contained in:
Naomi Carrigan
2024-07-28 21:11:31 +00:00
committed by Naomi the Technomancer
parent dea44dbd7f
commit f13bcd87a9
25 changed files with 3127 additions and 752 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
README.md
View File

@ -16,24 +16,81 @@ npm i @nhcarrigan/eslint-config eslint
## Compatibility
This package is compatible with ESLint 8.
This package is compatible with ESLint 9.
## Usage
To use this package, add the following to your `.eslintrc.json` file:
To use this package, add the following to your `eslint.config.js` file:
```js
import NaomisConfig from "@nhcarrigan/eslint-config";
export default [
...NaomisConfig,
// Any overrides you need, such as:
// {
// rules: {
// complexity: "off",
// "max-lines-per-function": "off",
// "max-statements": "off",
// "jsdoc/require-file-overview": "off"
// },
// },
// {
// files: ["test/__mocks__/Database.mock.ts"],
// rules: {
// "require-await": "off"
// }
// },
];
```
Then set up these two scripts in your `package.json`:
```json
{
"extends": "@nhcarrigan/eslint-config"
"format": "eslint src test --max-warnings 0 --fix",
"lint": "eslint src test --max-warnings 0",
}
```
## Warnings and Errors
### Formatting
Our rulesets include the `stylistic` package, which enforces quite a bit of specific formatting. With this being the case, projects should NOT use Prettier in tandem with this config.
Instead, set your editor to run the ESLint formatter on save. For example, in VSCodium, you can add a `.vscode/settings.json` file to your project:
```json
{
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
"eslint.validate": ["typescript"]
}
```
## Stylistic Standards
This configuration does not extend or incorporate any external rulesets. Every rule this config sets has been added deliberately and with reason.
### 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).
### No Deactivated Rules
Because this config is built from scratch, there is no need to explicitly deactivate any rules. Everything is "off" by default, and turned on as desired by this package.
The tests will not allow you to explicitly disable rules.
The only exception is the `disabledEslintRules` object, which explicitly turns off built-in ESLint rules to avoid conflicts with external packages like `@typescript-eslint`.
### Proposing Style Changes
All style changes should be proposed in our [chat server](https://chat.nhcarrigan.com).
## Feedback and Bugs
If you have feedback or a bug report, please feel free to open a GitHub issue!