1
1
mirror of https://github.com/theoludwig/eslint-config-conventions.git synced 2025-05-18 12:02:33 +02:00

Compare commits

...

18 Commits

Author SHA1 Message Date
fe7fddca13 fix: relax @typescript-eslint/unbound-method 2025-01-15 15:07:07 +01:00
42ae3ffe33 build(deps): update latest 2025-01-15 15:06:30 +01:00
8951ecc027 test: use describe and it 2025-01-06 23:17:18 +01:00
33c0f840ea build(deps): update latest 2025-01-06 23:12:38 +01:00
d9733dc1c8 fix: relax @typescript-eslint/no-floating-promises for node:test
Ref: https://github.com/nodejs/node/issues/51292
2025-01-06 23:09:18 +01:00
5e63c17030 build(deps): update latest 2024-12-14 21:06:54 +01:00
9d91c09bea fix: relax no-unused-vars to match TypeScript style of exempting names
Ref: https://typescript-eslint.io/rules/no-unused-vars/
2024-12-02 19:27:56 +01:00
e05233d429 fix: relax @typescript-eslint/array-type 2024-11-26 20:57:16 +01:00
c4c1a7f5dd feat: add @typescript-eslint/explicit-member-accessibility
BREAKING CHANGE: New rule introduced
2024-11-23 15:44:42 +01:00
adb164f604 build(deps): update latest 2024-11-11 20:46:20 +01:00
8ae05c8bee fix: relax unicorn/consistent-destructuring 2024-11-11 20:42:08 +01:00
ee4897153d chore: remove not needed @ts-check 2024-11-11 20:40:36 +01:00
67ff8e18b2 ci: use Node.js lts/* 2024-11-11 20:39:36 +01:00
d41573f12c docs: eslint.config.js 2024-10-29 23:48:40 +01:00
8efe22c23e fix: relax @typescript-eslint/no-unnecessary-condition 2024-10-22 11:47:11 +02:00
57f419c44a build(deps): update latest 2024-10-22 11:46:35 +02:00
a578bb80ba docs: add // @ts-check to config example 2024-10-08 08:10:28 +02:00
e32847fa3d chore: specify correct supported Node.js version
BREAKING CHANGE: Minimum supported Node.js >= 20.11.0

Ref: https://nodejs.org/api/esm.html#importmetadirname
2024-10-08 08:02:27 +02:00
10 changed files with 859 additions and 1409 deletions

View File

@ -10,12 +10,12 @@ jobs:
lint: lint:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.2.0" - uses: "actions/checkout@v4.2.2"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.0.4" uses: "actions/setup-node@v4.1.0"
with: with:
node-version: "22.x" node-version: "lts/*"
cache: "npm" cache: "npm"
- name: "Install dependencies" - name: "Install dependencies"
@ -28,6 +28,6 @@ jobs:
commitlint: commitlint:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.2.0" - uses: "actions/checkout@v4.2.2"
- uses: "wagoid/commitlint-github-action@v6.1.2" - uses: "wagoid/commitlint-github-action@v6.1.2"

View File

@ -13,15 +13,15 @@ jobs:
pull-requests: "write" pull-requests: "write"
id-token: "write" id-token: "write"
steps: steps:
- uses: "actions/checkout@v4.2.0" - uses: "actions/checkout@v4.2.2"
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.4" uses: "actions/setup-node@v4.1.0"
with: with:
node-version: "22.x" node-version: "lts/*"
cache: "npm" cache: "npm"
- name: "Install dependencies" - name: "Install dependencies"

View File

@ -10,12 +10,12 @@ jobs:
test: test:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.2.0" - uses: "actions/checkout@v4.2.2"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.0.4" uses: "actions/setup-node@v4.1.0"
with: with:
node-version: "22.x" node-version: "lts/*"
cache: "npm" cache: "npm"
- name: "Install dependencies" - name: "Install dependencies"

View File

@ -29,7 +29,7 @@ More information about **formatting rules** vs **code-quality rules** can be fou
### Prerequisites ### Prerequisites
[Node.js](https://nodejs.org/) >= 20.9.0 [Node.js](https://nodejs.org/) >= 20.11.0
### Installation ### Installation
@ -40,8 +40,8 @@ npm install --save-dev \
eslint-plugin-unicorn@^56.0.0 \ eslint-plugin-unicorn@^56.0.0 \
eslint-plugin-import-x@^4.3.1 \ eslint-plugin-import-x@^4.3.1 \
globals@^15.10.0 \ globals@^15.10.0 \
"typescript@~5.5.4" \ typescript@~5.5.4 \
"typescript-eslint@^8.8.0" \ typescript-eslint@^8.8.0 \
eslint-config-conventions@latest eslint-config-conventions@latest
``` ```
@ -59,13 +59,22 @@ Dependencies are:
### Configuration ### Configuration
#### `eslint.config.js` (JavaScript and TypeScript) #### `eslint.config.js`
```js ```js
import typescriptESLint from "typescript-eslint" import typescriptESLint from "typescript-eslint"
import eslintConfigConventions from "eslint-config-conventions" import configConventions from "eslint-config-conventions"
export default typescriptESLint.config(...eslintConfigConventions) export default typescriptESLint.config(...configConventions, {
files: ["**/*.ts", "**/*.tsx"],
languageOptions: {
parser: typescriptESLint.parser,
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
})
``` ```
#### Configuration with [Prettier](https://prettier.io/) (recommended) #### Configuration with [Prettier](https://prettier.io/) (recommended)

View File

@ -79,7 +79,13 @@ export default typescriptESLint.config(
"no-unused-vars": [ "no-unused-vars": [
"error", "error",
{ {
args: "all",
argsIgnorePattern: "^_",
caughtErrors: "all",
caughtErrorsIgnorePattern: "^_",
destructuredArrayIgnorePattern: "^_",
varsIgnorePattern: "^_", varsIgnorePattern: "^_",
ignoreRestSiblings: true,
}, },
], ],
"no-use-before-define": [ "no-use-before-define": [
@ -216,7 +222,6 @@ export default typescriptESLint.config(
"unicorn/better-regex": "error", "unicorn/better-regex": "error",
"unicorn/catch-error-name": "error", "unicorn/catch-error-name": "error",
"unicorn/consistent-destructuring": "error",
"unicorn/custom-error-definition": "error", "unicorn/custom-error-definition": "error",
"unicorn/error-message": "error", "unicorn/error-message": "error",
"unicorn/escape-case": "error", "unicorn/escape-case": "error",
@ -273,19 +278,25 @@ export default typescriptESLint.config(
rules: { rules: {
"no-undef": "off", "no-undef": "off",
"no-dupe-class-members": "off", "no-dupe-class-members": "off",
"@typescript-eslint/no-dupe-class-members": "error", "@typescript-eslint/no-dupe-class-members": "error",
"no-unused-vars": "off",
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": [ "@typescript-eslint/no-unused-vars": [
"error", "error",
{ {
args: "all",
argsIgnorePattern: "^_",
caughtErrors: "all",
caughtErrorsIgnorePattern: "^_",
destructuredArrayIgnorePattern: "^_",
varsIgnorePattern: "^_", varsIgnorePattern: "^_",
ignoreRestSiblings: true,
}, },
], ],
"no-use-before-define": "off", "no-use-before-define": "off",
"@typescript-eslint/no-use-before-define": [ "@typescript-eslint/no-use-before-define": [
"error", "error",
{ {
@ -299,12 +310,14 @@ export default typescriptESLint.config(
"default-param-last": "off", "default-param-last": "off",
"@typescript-eslint/default-param-last": "error", "@typescript-eslint/default-param-last": "error",
"no-array-constructor": "off", "no-array-constructor": "off",
"@typescript-eslint/no-array-constructor": "error", "@typescript-eslint/no-array-constructor": "error",
"no-implied-eval": "off", "no-implied-eval": "off",
"@typescript-eslint/no-implied-eval": "error", "@typescript-eslint/no-implied-eval": "error",
"no-redeclare": "off",
"no-redeclare": "off",
"@typescript-eslint/no-redeclare": [ "@typescript-eslint/no-redeclare": [
"error", "error",
{ {
@ -314,8 +327,8 @@ export default typescriptESLint.config(
"no-throw-literal": "off", "no-throw-literal": "off",
"@typescript-eslint/only-throw-error": "error", "@typescript-eslint/only-throw-error": "error",
"no-unused-expressions": "off",
"no-unused-expressions": "off",
"@typescript-eslint/no-unused-expressions": [ "@typescript-eslint/no-unused-expressions": [
"error", "error",
{ {
@ -327,30 +340,18 @@ export default typescriptESLint.config(
"no-useless-constructor": "off", "no-useless-constructor": "off",
"@typescript-eslint/no-useless-constructor": "error", "@typescript-eslint/no-useless-constructor": "error",
"@typescript-eslint/no-unnecessary-template-expression": "error", "@typescript-eslint/no-unnecessary-template-expression": "error",
"@typescript-eslint/no-unnecessary-condition": [
"error",
{
allowConstantLoopConditions: true,
},
],
"@typescript-eslint/adjacent-overload-signatures": "error", "@typescript-eslint/adjacent-overload-signatures": "error",
"@typescript-eslint/array-type": [
"error",
{
default: "array-simple",
},
],
"@typescript-eslint/no-unsafe-function-type": "error", "@typescript-eslint/no-unsafe-function-type": "error",
"@typescript-eslint/no-wrapper-object-types": "error", "@typescript-eslint/no-wrapper-object-types": "error",
"@typescript-eslint/consistent-type-definitions": ["error", "interface"], "@typescript-eslint/consistent-type-definitions": ["error", "interface"],
"no-duplicate-imports": "off", "no-duplicate-imports": "off",
"@typescript-eslint/consistent-type-imports": "error", "@typescript-eslint/consistent-type-imports": "error",
"@typescript-eslint/explicit-member-accessibility": "error",
"@typescript-eslint/explicit-function-return-type": [ "@typescript-eslint/explicit-function-return-type": [
"error", "error",
{ {
@ -362,7 +363,6 @@ export default typescriptESLint.config(
], ],
"@typescript-eslint/method-signature-style": "error", "@typescript-eslint/method-signature-style": "error",
"@typescript-eslint/unbound-method": "error",
"@typescript-eslint/naming-convention": [ "@typescript-eslint/naming-convention": [
"error", "error",
@ -387,7 +387,19 @@ export default typescriptESLint.config(
}, },
], ],
"@typescript-eslint/no-floating-promises": "error", "@typescript-eslint/no-floating-promises": [
"error",
{
allowForKnownSafeCalls: [
{
from: "package",
name: ["it", "describe"],
package: "node:test",
},
],
},
],
"@typescript-eslint/no-for-in-array": "error", "@typescript-eslint/no-for-in-array": "error",
"@typescript-eslint/no-invalid-void-type": "error", "@typescript-eslint/no-invalid-void-type": "error",
"@typescript-eslint/no-misused-new": "error", "@typescript-eslint/no-misused-new": "error",
@ -425,6 +437,7 @@ export default typescriptESLint.config(
"@typescript-eslint/prefer-reduce-type-parameter": "error", "@typescript-eslint/prefer-reduce-type-parameter": "error",
"@typescript-eslint/prefer-return-this-type": "error", "@typescript-eslint/prefer-return-this-type": "error",
"@typescript-eslint/promise-function-async": "error", "@typescript-eslint/promise-function-async": "error",
"prefer-promise-reject-errors": "off", "prefer-promise-reject-errors": "off",
"@typescript-eslint/prefer-promise-reject-errors": "error", "@typescript-eslint/prefer-promise-reject-errors": "error",

View File

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

1976
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -34,7 +34,7 @@
"provenance": true "provenance": true
}, },
"engines": { "engines": {
"node": ">=20.9.0" "node": ">=20.11.0"
}, },
"scripts": { "scripts": {
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
@ -54,16 +54,16 @@
}, },
"devDependencies": { "devDependencies": {
"@types/eslint__js": "8.42.3", "@types/eslint__js": "8.42.3",
"@types/node": "22.7.4", "@types/node": "22.10.6",
"globals": "15.10.0", "globals": "15.14.0",
"editorconfig-checker": "6.0.0", "editorconfig-checker": "6.0.1",
"eslint": "9.12.0", "eslint": "9.18.0",
"eslint-plugin-promise": "7.1.0", "eslint-plugin-promise": "7.2.1",
"eslint-plugin-unicorn": "56.0.0", "eslint-plugin-unicorn": "56.0.1",
"eslint-plugin-import-x": "4.3.1", "eslint-plugin-import-x": "4.6.1",
"typescript-eslint": "8.8.0", "typescript-eslint": "8.20.0",
"prettier": "3.3.3", "prettier": "3.4.2",
"semantic-release": "23.1.1", "semantic-release": "24.2.1",
"typescript": "5.5.4" "typescript": "5.7.3"
} }
} }

View File

@ -1,77 +0,0 @@
import test from "node:test"
import assert from "node:assert/strict"
import { ESLint } from "eslint"
const eslint = new ESLint()
test("ensure we validate correctly JavaScript files", async () => {
const [noErrors] = await eslint.lintFiles(
"test/fixtures/javascript-no-errors.js",
)
const [withErrors] = await eslint.lintFiles(
"test/fixtures/javascript-with-errors.js",
)
assert.strictEqual(noErrors?.errorCount, 0, JSON.stringify(noErrors, null, 2))
assert.strictEqual(
withErrors?.errorCount,
3,
JSON.stringify(withErrors, null, 2),
)
})
test("ensure we do not use deprecated rules", async () => {
const [javascriptLintResult] = await eslint.lintFiles(
"test/fixtures/javascript-no-errors.js",
)
const [typescriptLintResult] = await eslint.lintFiles(
"test/fixtures/typescript-no-errors.ts",
)
assert.strictEqual(
javascriptLintResult.usedDeprecatedRules.length,
0,
JSON.stringify(javascriptLintResult, null, 2),
)
assert.strictEqual(
typescriptLintResult.usedDeprecatedRules.length,
0,
JSON.stringify(typescriptLintResult, null, 2),
)
})
test("ensure we validate correctly TypeScript files", async () => {
const [noErrors] = await eslint.lintFiles(
"test/fixtures/typescript-no-errors.ts",
)
const [withErrors] = await eslint.lintFiles(
"test/fixtures/javascript-with-errors.js",
)
assert.strictEqual(noErrors?.errorCount, 0, JSON.stringify(noErrors, null, 2))
assert.strictEqual(
withErrors?.errorCount,
3,
JSON.stringify(withErrors, null, 2),
)
})
test("ensure we allow top-level await", async () => {
const [lintResult] = await eslint.lintFiles(
"test/fixtures/top-level-await.mjs",
)
assert.strictEqual(
lintResult?.errorCount,
0,
JSON.stringify(lintResult, null, 2),
)
})
test("ensure we allow to ignore floating promise with void operator (@typescript-eslint/no-floating-promises)", async () => {
const [lintResult] = await eslint.lintFiles(
"test/fixtures/typescript-no-errors-ignore-promise.ts",
)
assert.strictEqual(
lintResult?.errorCount,
0,
JSON.stringify(lintResult, null, 2),
)
})

View File

@ -0,0 +1,87 @@
import assert from "node:assert/strict"
import { describe, it } from "node:test"
import { ESLint } from "eslint"
const eslint = new ESLint()
describe("ESLint configuration", () => {
it("should validate correctly JavaScript files", async () => {
const [noErrors] = await eslint.lintFiles(
"test/fixtures/javascript-no-errors.js",
)
const [withErrors] = await eslint.lintFiles(
"test/fixtures/javascript-with-errors.js",
)
assert.strictEqual(
noErrors?.errorCount,
0,
JSON.stringify(noErrors, null, 2),
)
assert.strictEqual(
withErrors?.errorCount,
3,
JSON.stringify(withErrors, null, 2),
)
})
it("should validate correctly TypeScript files", async () => {
const [noErrors] = await eslint.lintFiles(
"test/fixtures/typescript-no-errors.ts",
)
const [withErrors] = await eslint.lintFiles(
"test/fixtures/javascript-with-errors.js",
)
assert.strictEqual(
noErrors?.errorCount,
0,
JSON.stringify(noErrors, null, 2),
)
assert.strictEqual(
withErrors?.errorCount,
3,
JSON.stringify(withErrors, null, 2),
)
})
it("should not use deprecated rules", async () => {
const [javascriptLintResult] = await eslint.lintFiles(
"test/fixtures/javascript-no-errors.js",
)
const [typescriptLintResult] = await eslint.lintFiles(
"test/fixtures/typescript-no-errors.ts",
)
assert.strictEqual(
javascriptLintResult.usedDeprecatedRules.length,
0,
JSON.stringify(javascriptLintResult, null, 2),
)
assert.strictEqual(
typescriptLintResult.usedDeprecatedRules.length,
0,
JSON.stringify(typescriptLintResult, null, 2),
)
})
it("should allow top-level await", async () => {
const [lintResult] = await eslint.lintFiles(
"test/fixtures/top-level-await.mjs",
)
assert.strictEqual(
lintResult?.errorCount,
0,
JSON.stringify(lintResult, null, 2),
)
})
it("should allow to ignore floating promise with void operator (@typescript-eslint/no-floating-promises)", async () => {
const [lintResult] = await eslint.lintFiles(
"test/fixtures/typescript-no-errors-ignore-promise.ts",
)
assert.strictEqual(
lintResult?.errorCount,
0,
JSON.stringify(lintResult, null, 2),
)
})
})