1
1
mirror of https://github.com/theoludwig/eslint-config-conventions.git synced 2024-11-14 22:53:13 +01:00

feat!: add support for ESLint v9

Fixes #2

BREAKING CHANGE: peerDependencies:
`eslint@^9.12.0`
`eslint-plugin-promise@^7.1.0`
`eslint-plugin-unicorn@^56.0.0`
`globals@^15.10.0`
`typescript-eslint@^8.8.0`

BREAKING CHANGE: Node.js >= 20.9.0
This commit is contained in:
Théo LUDWIG 2024-10-07 17:28:54 +02:00
parent f258d5ab41
commit d9536865d8
Signed by: theoludwig
GPG Key ID: ADFE5A563D718F3B
16 changed files with 1810 additions and 1394 deletions

View File

@ -1,2 +0,0 @@
node_modules
test/fixtures

View File

@ -1,338 +0,0 @@
{
"root": true,
"plugins": ["promise", "unicorn"],
"env": {
"browser": true,
"node": true,
"es2024": true
},
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"ecmaFeatures": {
"jsx": true
}
},
"rules": {
"constructor-super": "error",
"for-direction": "error",
"getter-return": "error",
"no-async-promise-executor": "error",
"no-class-assign": "error",
"no-compare-neg-zero": "error",
"no-cond-assign": "error",
"no-const-assign": "error",
"no-constant-binary-expression": "error",
"no-constant-condition": "error",
"no-constructor-return": "error",
"no-control-regex": "error",
"no-debugger": "error",
"no-dupe-args": "error",
"no-dupe-class-members": "error",
"no-dupe-else-if": "error",
"no-dupe-keys": "error",
"no-duplicate-case": "error",
"no-duplicate-imports": "error",
"no-empty-character-class": "error",
"no-empty-pattern": "error",
"no-ex-assign": "error",
"no-fallthrough": "error",
"no-func-assign": "error",
"no-import-assign": "error",
"no-invalid-regexp": "error",
"no-irregular-whitespace": "error",
"no-loss-of-precision": "error",
"no-misleading-character-class": "error",
"no-new-native-nonconstructor": "error",
"no-new-symbol": "error",
"no-obj-calls": "error",
"no-promise-executor-return": "error",
"no-prototype-builtins": "error",
"no-self-assign": "error",
"no-self-compare": "error",
"no-setter-return": "error",
"no-sparse-arrays": "error",
"no-this-before-super": "error",
"no-undef": "error",
"no-unexpected-multiline": "error",
"no-unmodified-loop-condition": "error",
"no-unreachable": "error",
"no-unreachable-loop": "error",
"no-unsafe-finally": "error",
"no-unsafe-negation": "error",
"no-unsafe-optional-chaining": "error",
"no-unused-private-class-members": "error",
"no-unused-vars": ["error", { "varsIgnorePattern": "^_" }],
"no-use-before-define": [
"error",
{
"functions": false,
"classes": false,
"variables": false
}
],
"no-useless-backreference": "error",
"use-isnan": [
"error",
{
"enforceForSwitchCase": true,
"enforceForIndexOf": true
}
],
"valid-typeof": ["error", { "requireStringLiterals": true }],
"consistent-this": "error",
"default-param-last": "error",
"default-case-last": "error",
"eqeqeq": ["error", "always", { "null": "ignore" }],
"grouped-accessor-pairs": "error",
"new-cap": [
"error",
{ "newIsCap": true, "capIsNew": false, "properties": true }
],
"no-array-constructor": "error",
"no-caller": "error",
"no-delete-var": "error",
"no-empty": ["error", { "allowEmptyCatch": true }],
"no-empty-static-block": "error",
"no-eval": "error",
"no-global-assign": "error",
"no-implied-eval": "error",
"no-multi-str": "error",
"no-new-func": "error",
"no-object-constructor": "error",
"no-octal": "error",
"no-octal-escape": "error",
"no-proto": "error",
"no-redeclare": ["error", { "builtinGlobals": false }],
"no-regex-spaces": "error",
"no-shadow-restricted-names": "error",
"no-throw-literal": "error",
"no-undef-init": "error",
"no-unused-expressions": [
"error",
{
"allowShortCircuit": true,
"allowTernary": true,
"allowTaggedTemplates": true
}
],
"no-useless-call": "error",
"no-useless-concat": "error",
"no-useless-computed-key": "error",
"no-useless-constructor": "error",
"no-useless-escape": "error",
"no-useless-rename": "error",
"no-useless-return": "error",
"no-else-return": ["error", { "allowElseIf": false }],
"no-var": "error",
"no-void": ["error", { "allowAsStatement": true }],
"no-with": "error",
"object-shorthand": ["error", "properties"],
"one-var": ["error", { "initialized": "never" }],
"prefer-const": ["error", { "destructuring": "all" }],
"prefer-object-has-own": "error",
"prefer-promise-reject-errors": "error",
"prefer-regex-literals": ["error", { "disallowRedundantWrapping": true }],
"radix": "error",
"yoda": ["error", "never"],
"curly": ["error", "all"],
"func-style": ["error", "expression"],
"prefer-arrow-callback": "error",
"arrow-body-style": ["error", "always"],
"promise/param-names": "error",
"promise/no-new-statics": "error",
"promise/no-multiple-resolved": "error",
"promise/no-nesting": "error",
"unicorn/better-regex": "error",
"unicorn/catch-error-name": "error",
"unicorn/consistent-destructuring": "error",
"unicorn/custom-error-definition": "error",
"unicorn/error-message": "error",
"unicorn/escape-case": "error",
"unicorn/explicit-length-check": "error",
"unicorn/new-for-builtins": "error",
"unicorn/no-array-callback-reference": "error",
"unicorn/no-array-for-each": "error",
"unicorn/no-array-method-this-argument": "error",
"unicorn/no-document-cookie": "error",
"unicorn/no-empty-file": "error",
"unicorn/no-hex-escape": "error",
"unicorn/no-instanceof-array": "error",
"unicorn/no-new-array": "error",
"unicorn/no-new-buffer": "error",
"unicorn/no-this-assignment": "error",
"unicorn/no-zero-fractions": "error",
"unicorn/number-literal-case": "error",
"unicorn/prefer-node-protocol": "error",
"unicorn/throw-new-error": "error",
"unicorn/no-typeof-undefined": "error",
"unicorn/require-array-join-separator": "error",
"unicorn/prefer-number-properties": "error",
"unicorn/prefer-modern-math-apis": "error",
"unicorn/prefer-structured-clone": "error",
"unicorn/template-indent": "error"
},
"overrides": [
{
"files": ["*.ts", "*.tsx"],
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"rules": {
"no-undef": "off",
"no-dupe-class-members": "off",
"@typescript-eslint/no-dupe-class-members": "error",
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": [
"error",
{ "varsIgnorePattern": "^_" }
],
"no-use-before-define": "off",
"@typescript-eslint/no-use-before-define": [
"error",
{
"functions": false,
"classes": false,
"enums": false,
"variables": false,
"typedefs": false
}
],
"default-param-last": "off",
"@typescript-eslint/default-param-last": "error",
"no-array-constructor": "off",
"@typescript-eslint/no-array-constructor": "error",
"no-implied-eval": "off",
"@typescript-eslint/no-implied-eval": "error",
"no-redeclare": "off",
"@typescript-eslint/no-redeclare": [
"error",
{ "builtinGlobals": false }
],
"no-throw-literal": "off",
"@typescript-eslint/only-throw-error": "error",
"no-unused-expressions": "off",
"@typescript-eslint/no-unused-expressions": [
"error",
{
"allowShortCircuit": true,
"allowTernary": true,
"allowTaggedTemplates": true
}
],
"no-useless-constructor": "off",
"@typescript-eslint/no-useless-constructor": "error",
"@typescript-eslint/no-unnecessary-template-expression": "error",
"@typescript-eslint/no-unnecessary-condition": [
"error",
{
"allowConstantLoopConditions": true
}
],
"@typescript-eslint/adjacent-overload-signatures": "error",
"@typescript-eslint/array-type": [
"error",
{ "default": "array-simple" }
],
"@typescript-eslint/no-unsafe-function-type": "error",
"@typescript-eslint/no-wrapper-object-types": "error",
"@typescript-eslint/consistent-type-definitions": [
"error",
"interface"
],
"no-duplicate-imports": "off",
"@typescript-eslint/consistent-type-imports": "error",
"@typescript-eslint/explicit-function-return-type": [
"error",
{
"allowExpressions": true,
"allowHigherOrderFunctions": true,
"allowTypedFunctionExpressions": true,
"allowDirectConstAssertionInArrowFunctions": true
}
],
"@typescript-eslint/method-signature-style": "error",
"@typescript-eslint/unbound-method": "error",
"@typescript-eslint/naming-convention": [
"error",
{
"selector": "variableLike",
"leadingUnderscore": "allow",
"trailingUnderscore": "allow",
"format": ["camelCase", "PascalCase", "UPPER_CASE"]
}
],
"@typescript-eslint/no-base-to-string": "error",
"@typescript-eslint/no-deprecated": "error",
"@typescript-eslint/no-dynamic-delete": "error",
"@typescript-eslint/no-extra-non-null-assertion": "error",
"@typescript-eslint/no-redundant-type-constituents": "error",
"@typescript-eslint/no-extraneous-class": [
"error",
{ "allowWithDecorator": true }
],
"@typescript-eslint/no-floating-promises": "error",
"@typescript-eslint/no-for-in-array": "error",
"@typescript-eslint/no-invalid-void-type": "error",
"@typescript-eslint/no-misused-new": "error",
"@typescript-eslint/no-non-null-asserted-optional-chain": "error",
"@typescript-eslint/no-non-null-assertion": "error",
"@typescript-eslint/no-this-alias": [
"error",
{ "allowDestructuring": true }
],
"@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
"@typescript-eslint/no-unnecessary-type-assertion": "error",
"@typescript-eslint/no-require-imports": "error",
"@typescript-eslint/no-unsafe-unary-minus": "error",
"@typescript-eslint/no-unsafe-declaration-merging": "error",
"@typescript-eslint/no-array-delete": "error",
"@typescript-eslint/prefer-as-const": "error",
"@typescript-eslint/prefer-function-type": "error",
"@typescript-eslint/prefer-find": "error",
"@typescript-eslint/prefer-includes": "error",
"@typescript-eslint/prefer-nullish-coalescing": [
"error",
{
"ignoreTernaryTests": true,
"ignoreConditionalTests": false,
"ignoreMixedLogicalExpressions": false
}
],
"@typescript-eslint/prefer-readonly": "error",
"@typescript-eslint/prefer-reduce-type-parameter": "error",
"@typescript-eslint/prefer-return-this-type": "error",
"@typescript-eslint/promise-function-async": "error",
"prefer-promise-reject-errors": "off",
"@typescript-eslint/prefer-promise-reject-errors": "error",
"@typescript-eslint/require-array-sort-compare": [
"error",
{ "ignoreStringArrays": true }
],
"@typescript-eslint/restrict-plus-operands": [
"error",
{ "skipCompoundAssignments": true }
],
"@typescript-eslint/restrict-template-expressions": [
"error",
{ "allowNumber": true }
],
"@typescript-eslint/strict-boolean-expressions": [
"error",
{
"allowString": false,
"allowNumber": false,
"allowNullableObject": false,
"allowNullableBoolean": false,
"allowNullableString": false,
"allowNullableNumber": false,
"allowAny": false
}
]
}
}
]
}

View File

@ -10,10 +10,10 @@ jobs:
lint: lint:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.1.7" - uses: "actions/checkout@v4.2.0"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.0.3" uses: "actions/setup-node@v4.0.4"
with: with:
node-version: "22.x" node-version: "22.x"
cache: "npm" cache: "npm"
@ -22,13 +22,12 @@ jobs:
run: "npm clean-install" run: "npm clean-install"
- run: "node --run lint:editorconfig" - run: "node --run lint:editorconfig"
- run: "node --run lint:markdown"
- run: "node --run lint:eslint" - run: "node --run lint:eslint"
- run: "node --run lint:prettier" - run: "node --run lint:prettier"
commitlint: commitlint:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.1.7" - uses: "actions/checkout@v4.2.0"
- uses: "wagoid/commitlint-github-action@v6.1.2" - uses: "wagoid/commitlint-github-action@v6.1.2"

View File

@ -13,13 +13,13 @@ jobs:
pull-requests: "write" pull-requests: "write"
id-token: "write" id-token: "write"
steps: steps:
- uses: "actions/checkout@v4.1.7" - uses: "actions/checkout@v4.2.0"
with: with:
fetch-depth: 0 fetch-depth: 0
persist-credentials: false persist-credentials: false
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.0.3" uses: "actions/setup-node@v4.0.4"
with: with:
node-version: "22.x" node-version: "22.x"
cache: "npm" cache: "npm"

View File

@ -10,10 +10,10 @@ jobs:
test: test:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.1.7" - uses: "actions/checkout@v4.2.0"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.0.3" uses: "actions/setup-node@v4.0.4"
with: with:
node-version: "22.x" node-version: "22.x"
cache: "npm" cache: "npm"

View File

@ -1,11 +0,0 @@
{
"config": {
"extends": "markdownlint/style/prettier",
"default": true,
"relative-links": true,
"no-inline-html": false,
},
"globs": ["**/*.md"],
"ignores": ["**/node_modules"],
"customRules": ["markdownlint-rule-relative-links"],
}

View File

@ -29,15 +29,18 @@ More information about **formatting rules** vs **code-quality rules** can be fou
### Prerequisites ### Prerequisites
[Node.js](https://nodejs.org/) >= 18.0.0 [Node.js](https://nodejs.org/) >= 20.9.0
### Installation ### Installation
```sh ```sh
npm install --save-dev \ npm install --save-dev \
eslint@^8.57.0 \ eslint@^9.12.0 \
eslint-plugin-promise@^7.0.0 \ eslint-plugin-promise@^7.1.0 \
eslint-plugin-unicorn@^55.0.0 \ eslint-plugin-unicorn@^56.0.0 \
globals@^15.10.0 \
"typescript@~5.5.4" \
"typescript-eslint@^8.8.0" \
eslint-config-conventions@latest eslint-config-conventions@latest
``` ```
@ -47,55 +50,20 @@ Dependencies are:
- [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins) - [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins)
- [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise) - [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise)
- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) - [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
- This package: `eslint-config-conventions` - [globals](https://github.com/sindresorhus/globals)
#### Installation with TypeScript
If you want to use **TypeScript**, you also need to install:
```sh
npm install --save-dev \
"typescript@~5.5.4" \
"@typescript-eslint/eslint-plugin@^8.3.0" \
"@typescript-eslint/parser@^8.3.0"
```
Dependencies are:
- [TypeScript](https://github.com/Microsoft/TypeScript) - [TypeScript](https://github.com/Microsoft/TypeScript)
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript. - [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint): tooling which enables ESLint to support TypeScript.
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript. - This package: `eslint-config-conventions`
### Configuration ### Configuration
#### `.eslintrc.json` (JavaScript) #### `eslint.config.js` (JavaScript and TypeScript)
```json ```js
{ import typescriptESLint from "typescript-eslint"
"root": true, import eslintConfigConventions from "eslint-config-conventions"
"extends": ["conventions"],
"plugins": ["promise", "unicorn"]
}
```
#### `.eslintrc.json` (TypeScript) export default typescriptESLint.config(...eslintConfigConventions)
```json
{
"root": true,
"extends": ["conventions"],
"plugins": ["promise", "unicorn"],
"overrides": [
{
"files": ["*.ts", "*.tsx"],
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"parserOptions": {
"projectService": true
}
}
]
}
``` ```
#### Configuration with [Prettier](https://prettier.io/) (recommended) #### Configuration with [Prettier](https://prettier.io/) (recommended)
@ -108,7 +76,7 @@ npm install --save-dev prettier
echo "{}" > .prettierrc.json echo "{}" > .prettierrc.json
``` ```
That's all! No need to update the `.eslintrc.json` configuration. That's all! No need to update the `eslint.config.js` configuration.
We discourage usage of [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), as `eslint-config-conventions` doesn't include any stylistic rules, and including these packages has several drawbacks (listed in [Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html)) and brings no benefits for this configuration. We discourage usage of [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), as `eslint-config-conventions` doesn't include any stylistic rules, and including these packages has several drawbacks (listed in [Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html)) and brings no benefits for this configuration.
@ -117,7 +85,7 @@ We discourage usage of [eslint-config-prettier](https://github.com/prettier/esli
```json ```json
{ {
"scripts": { "scripts": {
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore", "lint:eslint": "eslint . --max-warnings 0",
"lint:prettier": "prettier . --check" "lint:prettier": "prettier . --check"
} }
} }

453
eslint.config.js Normal file
View File

@ -0,0 +1,453 @@
import promise from "eslint-plugin-promise"
import unicorn from "eslint-plugin-unicorn"
import globals from "globals"
import typescriptESLint from "typescript-eslint"
export default typescriptESLint.config(
{
name: "eslint-config-conventions",
plugins: {
promise,
unicorn,
},
linterOptions: {
reportUnusedDisableDirectives: "error",
},
languageOptions: {
globals: {
...globals.browser,
...globals.node,
},
ecmaVersion: "latest",
sourceType: "module",
parserOptions: {
ecmaFeatures: {
jsx: true,
},
},
},
rules: {
"constructor-super": "error",
"for-direction": "error",
"getter-return": "error",
"no-async-promise-executor": "error",
"no-class-assign": "error",
"no-compare-neg-zero": "error",
"no-cond-assign": "error",
"no-const-assign": "error",
"no-constant-binary-expression": "error",
"no-constant-condition": "error",
"no-constructor-return": "error",
"no-control-regex": "error",
"no-debugger": "error",
"no-dupe-args": "error",
"no-dupe-class-members": "error",
"no-dupe-else-if": "error",
"no-dupe-keys": "error",
"no-duplicate-case": "error",
"no-duplicate-imports": "error",
"no-empty-character-class": "error",
"no-empty-pattern": "error",
"no-ex-assign": "error",
"no-fallthrough": "error",
"no-func-assign": "error",
"no-import-assign": "error",
"no-invalid-regexp": "error",
"no-irregular-whitespace": "error",
"no-loss-of-precision": "error",
"no-misleading-character-class": "error",
"no-new-native-nonconstructor": "error",
"no-obj-calls": "error",
"no-promise-executor-return": "error",
"no-prototype-builtins": "error",
"no-self-assign": "error",
"no-self-compare": "error",
"no-setter-return": "error",
"no-sparse-arrays": "error",
"no-this-before-super": "error",
"no-undef": "error",
"no-unexpected-multiline": "error",
"no-unmodified-loop-condition": "error",
"no-unreachable": "error",
"no-unreachable-loop": "error",
"no-unsafe-finally": "error",
"no-unsafe-negation": "error",
"no-unsafe-optional-chaining": "error",
"no-unused-private-class-members": "error",
"no-unused-vars": [
"error",
{
varsIgnorePattern: "^_",
},
],
"no-use-before-define": [
"error",
{
functions: false,
classes: false,
variables: false,
},
],
"no-useless-backreference": "error",
"use-isnan": [
"error",
{
enforceForSwitchCase: true,
enforceForIndexOf: true,
},
],
"valid-typeof": [
"error",
{
requireStringLiterals: true,
},
],
"consistent-this": "error",
"default-param-last": "error",
"default-case-last": "error",
eqeqeq: [
"error",
"always",
{
null: "ignore",
},
],
"grouped-accessor-pairs": "error",
"new-cap": [
"error",
{
newIsCap: true,
capIsNew: false,
properties: true,
},
],
"no-array-constructor": "error",
"no-caller": "error",
"no-delete-var": "error",
"no-empty": [
"error",
{
allowEmptyCatch: true,
},
],
"no-empty-static-block": "error",
"no-eval": "error",
"no-global-assign": "error",
"no-implied-eval": "error",
"no-multi-str": "error",
"no-new-func": "error",
"no-object-constructor": "error",
"no-octal": "error",
"no-octal-escape": "error",
"no-proto": "error",
"no-redeclare": [
"error",
{
builtinGlobals: false,
},
],
"no-regex-spaces": "error",
"no-shadow-restricted-names": "error",
"no-throw-literal": "error",
"no-undef-init": "error",
"no-unused-expressions": [
"error",
{
allowShortCircuit: true,
allowTernary: true,
allowTaggedTemplates: true,
},
],
"no-useless-call": "error",
"no-useless-concat": "error",
"no-useless-computed-key": "error",
"no-useless-constructor": "error",
"no-useless-escape": "error",
"no-useless-rename": "error",
"no-useless-return": "error",
"no-else-return": [
"error",
{
allowElseIf: false,
},
],
"no-var": "error",
"no-void": [
"error",
{
allowAsStatement: true,
},
],
"no-with": "error",
"object-shorthand": ["error", "properties"],
"one-var": [
"error",
{
initialized: "never",
},
],
"prefer-const": [
"error",
{
destructuring: "all",
},
],
"prefer-object-has-own": "error",
"prefer-promise-reject-errors": "error",
"prefer-regex-literals": [
"error",
{
disallowRedundantWrapping: true,
},
],
radix: "error",
yoda: ["error", "never"],
curly: ["error", "all"],
"func-style": ["error", "expression"],
"prefer-arrow-callback": "error",
"arrow-body-style": ["error", "always"],
"promise/param-names": "error",
"promise/no-new-statics": "error",
"promise/no-multiple-resolved": "error",
"promise/no-nesting": "error",
"unicorn/better-regex": "error",
"unicorn/catch-error-name": "error",
"unicorn/consistent-destructuring": "error",
"unicorn/custom-error-definition": "error",
"unicorn/error-message": "error",
"unicorn/escape-case": "error",
"unicorn/explicit-length-check": "error",
"unicorn/new-for-builtins": "error",
"unicorn/no-array-callback-reference": "error",
"unicorn/no-array-for-each": "error",
"unicorn/no-array-method-this-argument": "error",
"unicorn/no-document-cookie": "error",
"unicorn/no-empty-file": "error",
"unicorn/no-hex-escape": "error",
"unicorn/no-instanceof-array": "error",
"unicorn/no-new-array": "error",
"unicorn/no-new-buffer": "error",
"unicorn/no-this-assignment": "error",
"unicorn/no-zero-fractions": "error",
"unicorn/number-literal-case": "error",
"unicorn/prefer-node-protocol": "error",
"unicorn/throw-new-error": "error",
"unicorn/no-typeof-undefined": "error",
"unicorn/require-array-join-separator": "error",
"unicorn/prefer-number-properties": "error",
"unicorn/prefer-modern-math-apis": "error",
"unicorn/prefer-structured-clone": "error",
"unicorn/template-indent": "error",
},
},
{
name: "eslint-config-conventions/typescript",
files: ["**/*.ts", "**/*.tsx"],
plugins: {
"@typescript-eslint": typescriptESLint.plugin,
},
languageOptions: {
parser: typescriptESLint.parser,
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
rules: {
"no-undef": "off",
"no-dupe-class-members": "off",
"@typescript-eslint/no-dupe-class-members": "error",
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": [
"error",
{
varsIgnorePattern: "^_",
},
],
"no-use-before-define": "off",
"@typescript-eslint/no-use-before-define": [
"error",
{
functions: false,
classes: false,
enums: false,
variables: false,
typedefs: false,
},
],
"default-param-last": "off",
"@typescript-eslint/default-param-last": "error",
"no-array-constructor": "off",
"@typescript-eslint/no-array-constructor": "error",
"no-implied-eval": "off",
"@typescript-eslint/no-implied-eval": "error",
"no-redeclare": "off",
"@typescript-eslint/no-redeclare": [
"error",
{
builtinGlobals: false,
},
],
"no-throw-literal": "off",
"@typescript-eslint/only-throw-error": "error",
"no-unused-expressions": "off",
"@typescript-eslint/no-unused-expressions": [
"error",
{
allowShortCircuit: true,
allowTernary: true,
allowTaggedTemplates: true,
},
],
"no-useless-constructor": "off",
"@typescript-eslint/no-useless-constructor": "error",
"@typescript-eslint/no-unnecessary-template-expression": "error",
"@typescript-eslint/no-unnecessary-condition": [
"error",
{
allowConstantLoopConditions: true,
},
],
"@typescript-eslint/adjacent-overload-signatures": "error",
"@typescript-eslint/array-type": [
"error",
{
default: "array-simple",
},
],
"@typescript-eslint/no-unsafe-function-type": "error",
"@typescript-eslint/no-wrapper-object-types": "error",
"@typescript-eslint/consistent-type-definitions": ["error", "interface"],
"no-duplicate-imports": "off",
"@typescript-eslint/consistent-type-imports": "error",
"@typescript-eslint/explicit-function-return-type": [
"error",
{
allowExpressions: true,
allowHigherOrderFunctions: true,
allowTypedFunctionExpressions: true,
allowDirectConstAssertionInArrowFunctions: true,
},
],
"@typescript-eslint/method-signature-style": "error",
"@typescript-eslint/unbound-method": "error",
"@typescript-eslint/naming-convention": [
"error",
{
selector: "variableLike",
leadingUnderscore: "allow",
trailingUnderscore: "allow",
format: ["camelCase", "PascalCase", "UPPER_CASE"],
},
],
"@typescript-eslint/no-base-to-string": "error",
"@typescript-eslint/no-deprecated": "error",
"@typescript-eslint/no-dynamic-delete": "error",
"@typescript-eslint/no-extra-non-null-assertion": "error",
"@typescript-eslint/no-redundant-type-constituents": "error",
"@typescript-eslint/no-extraneous-class": [
"error",
{
allowWithDecorator: true,
},
],
"@typescript-eslint/no-floating-promises": "error",
"@typescript-eslint/no-for-in-array": "error",
"@typescript-eslint/no-invalid-void-type": "error",
"@typescript-eslint/no-misused-new": "error",
"@typescript-eslint/no-non-null-asserted-optional-chain": "error",
"@typescript-eslint/no-non-null-assertion": "error",
"@typescript-eslint/no-this-alias": [
"error",
{
allowDestructuring: true,
},
],
"@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
"@typescript-eslint/no-unnecessary-type-assertion": "error",
"@typescript-eslint/no-require-imports": "error",
"@typescript-eslint/no-unsafe-unary-minus": "error",
"@typescript-eslint/no-unsafe-declaration-merging": "error",
"@typescript-eslint/no-array-delete": "error",
"@typescript-eslint/prefer-as-const": "error",
"@typescript-eslint/prefer-function-type": "error",
"@typescript-eslint/prefer-find": "error",
"@typescript-eslint/prefer-includes": "error",
"@typescript-eslint/prefer-nullish-coalescing": [
"error",
{
ignoreTernaryTests: true,
ignoreConditionalTests: false,
ignoreMixedLogicalExpressions: false,
},
],
"@typescript-eslint/prefer-readonly": "error",
"@typescript-eslint/prefer-reduce-type-parameter": "error",
"@typescript-eslint/prefer-return-this-type": "error",
"@typescript-eslint/promise-function-async": "error",
"prefer-promise-reject-errors": "off",
"@typescript-eslint/prefer-promise-reject-errors": "error",
"@typescript-eslint/require-array-sort-compare": [
"error",
{
ignoreStringArrays: true,
},
],
"@typescript-eslint/restrict-plus-operands": [
"error",
{
skipCompoundAssignments: true,
},
],
"@typescript-eslint/restrict-template-expressions": [
"error",
{
allowNumber: true,
},
],
"@typescript-eslint/strict-boolean-expressions": [
"error",
{
allowString: false,
allowNumber: false,
allowNullableObject: false,
allowNullableBoolean: false,
allowNullableString: false,
allowNullableNumber: false,
allowAny: false,
},
],
},
},
)

8
eslint.config.mjs Normal file
View File

@ -0,0 +1,8 @@
// @ts-check
import typescriptESLint from "typescript-eslint"
import eslintConfigConventions from "./eslint.config.js"
export default typescriptESLint.config(...eslintConfigConventions, {
ignores: ["test/fixtures/*"],
})

View File

@ -1,6 +0,0 @@
{
"extends": "./index.js",
"parserOptions": {
"projectService": true
}
}

5
index.d.ts vendored Normal file
View File

@ -0,0 +1,5 @@
import type typescriptESLint from "typescript-eslint"
declare const eslintConfigConventions: ReturnType<typeof typescriptESLint.config>
export default eslintConfigConventions

View File

@ -1 +0,0 @@
module.exports = require("./.eslintrc.json")

2231
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -22,44 +22,46 @@
"code quality", "code quality",
"conventions" "conventions"
], ],
"main": "index.js", "main": "eslint.config.js",
"types": "index.d.ts",
"type": "module",
"files": [ "files": [
"index.js", "eslint.config.js",
".eslintrc.json" "index.d.ts"
], ],
"publishConfig": { "publishConfig": {
"access": "public", "access": "public",
"provenance": true "provenance": true
}, },
"engines": { "engines": {
"node": ">=18.0.0" "node": ">=20.9.0"
}, },
"scripts": { "scripts": {
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint-cli2", "lint:eslint": "eslint . --max-warnings 0 --config eslint.config.mjs",
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
"lint:prettier": "prettier . --check", "lint:prettier": "prettier . --check",
"inspect": "eslint --inspect-config",
"test": "node --test", "test": "node --test",
"release": "semantic-release" "release": "semantic-release"
}, },
"peerDependencies": { "peerDependencies": {
"eslint": "^8.57.0", "eslint": "^9.12.0",
"eslint-plugin-promise": "^7.0.0", "eslint-plugin-promise": "^7.1.0",
"eslint-plugin-unicorn": "^55.0.0" "eslint-plugin-unicorn": "^56.0.0",
"globals": "^15.10.0",
"typescript-eslint": "^8.8.0"
}, },
"devDependencies": { "devDependencies": {
"@types/eslint": "8.56.12", "@types/eslint__js": "8.42.3",
"@types/node": "22.7.4", "@types/node": "22.7.4",
"@typescript-eslint/eslint-plugin": "8.7.0", "globals": "15.10.0",
"@typescript-eslint/parser": "8.7.0",
"editorconfig-checker": "6.0.0", "editorconfig-checker": "6.0.0",
"eslint": "8.57.1", "eslint": "9.12.0",
"eslint-plugin-promise": "7.1.0", "eslint-plugin-promise": "7.1.0",
"eslint-plugin-unicorn": "55.0.0", "eslint-plugin-unicorn": "56.0.0",
"markdownlint-cli2": "0.14.0", "typescript-eslint": "8.8.0",
"markdownlint-rule-relative-links": "3.0.0",
"prettier": "3.3.3", "prettier": "3.3.3",
"semantic-release": "23.1.1", "semantic-release": "23.1.1",
"typescript": "5.6.2" "typescript": "5.5.4"
} }
} }

View File

@ -1,20 +0,0 @@
const test = require("node:test")
const assert = require("node:assert/strict")
const config = require("../index.js")
/**
* @param {unknown} object
* @returns {boolean}
*/
const isObject = (object) => {
return typeof object === "object" && object !== null
}
test("test basic properties of config", async () => {
assert.ok(isObject(config))
assert.ok(isObject(config.parserOptions))
assert.ok(isObject(config.env))
assert.ok(isObject(config.rules))
assert.ok(isObject(config.overrides))
})

View File

@ -1,13 +1,9 @@
const test = require("node:test") import test from "node:test"
const assert = require("node:assert/strict") import assert from "node:assert/strict"
const { ESLint } = require("eslint") import { ESLint } from "eslint"
const eslint = new ESLint({ const eslint = new ESLint()
ignore: false,
useEslintrc: false,
overrideConfigFile: "eslintrc.json",
})
test("ensure we validate correctly JavaScript files", async () => { test("ensure we validate correctly JavaScript files", async () => {
const [noErrors] = await eslint.lintFiles( const [noErrors] = await eslint.lintFiles(