mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
14 Commits
Author | SHA1 | Date | |
---|---|---|---|
fe7fddca13
|
|||
42ae3ffe33
|
|||
8951ecc027
|
|||
33c0f840ea
|
|||
d9733dc1c8
|
|||
5e63c17030
|
|||
9d91c09bea
|
|||
e05233d429
|
|||
c4c1a7f5dd
|
|||
adb164f604
|
|||
8ae05c8bee
|
|||
ee4897153d
|
|||
67ff8e18b2
|
|||
d41573f12c
|
8
.github/workflows/lint.yml
vendored
8
.github/workflows/lint.yml
vendored
@ -10,12 +10,12 @@ jobs:
|
||||
lint:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
- uses: "actions/checkout@v4.2.2"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.4"
|
||||
uses: "actions/setup-node@v4.1.0"
|
||||
with:
|
||||
node-version: "22.x"
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
@ -28,6 +28,6 @@ jobs:
|
||||
commitlint:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
- uses: "actions/checkout@v4.2.2"
|
||||
|
||||
- uses: "wagoid/commitlint-github-action@v6.1.2"
|
||||
|
6
.github/workflows/release.yml
vendored
6
.github/workflows/release.yml
vendored
@ -13,15 +13,15 @@ jobs:
|
||||
pull-requests: "write"
|
||||
id-token: "write"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
- uses: "actions/checkout@v4.2.2"
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.4"
|
||||
uses: "actions/setup-node@v4.1.0"
|
||||
with:
|
||||
node-version: "22.x"
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
|
6
.github/workflows/test.yml
vendored
6
.github/workflows/test.yml
vendored
@ -10,12 +10,12 @@ jobs:
|
||||
test:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
- uses: "actions/checkout@v4.2.2"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.4"
|
||||
uses: "actions/setup-node@v4.1.0"
|
||||
with:
|
||||
node-version: "22.x"
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
|
15
README.md
15
README.md
@ -59,15 +59,22 @@ Dependencies are:
|
||||
|
||||
### Configuration
|
||||
|
||||
#### `eslint.config.js` (JavaScript and TypeScript)
|
||||
#### `eslint.config.js`
|
||||
|
||||
```js
|
||||
// @ts-check
|
||||
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import configConventions from "eslint-config-conventions"
|
||||
|
||||
export default typescriptESLint.config(...configConventions)
|
||||
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)
|
||||
|
@ -1,5 +1,3 @@
|
||||
// @ts-check
|
||||
|
||||
import promise from "eslint-plugin-promise"
|
||||
import unicorn from "eslint-plugin-unicorn"
|
||||
import importX from "eslint-plugin-import-x"
|
||||
@ -81,7 +79,13 @@ export default typescriptESLint.config(
|
||||
"no-unused-vars": [
|
||||
"error",
|
||||
{
|
||||
args: "all",
|
||||
argsIgnorePattern: "^_",
|
||||
caughtErrors: "all",
|
||||
caughtErrorsIgnorePattern: "^_",
|
||||
destructuredArrayIgnorePattern: "^_",
|
||||
varsIgnorePattern: "^_",
|
||||
ignoreRestSiblings: true,
|
||||
},
|
||||
],
|
||||
"no-use-before-define": [
|
||||
@ -218,7 +222,6 @@ export default typescriptESLint.config(
|
||||
|
||||
"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",
|
||||
@ -275,19 +278,25 @@ export default typescriptESLint.config(
|
||||
|
||||
rules: {
|
||||
"no-undef": "off",
|
||||
|
||||
"no-dupe-class-members": "off",
|
||||
"@typescript-eslint/no-dupe-class-members": "error",
|
||||
"no-unused-vars": "off",
|
||||
|
||||
"no-unused-vars": "off",
|
||||
"@typescript-eslint/no-unused-vars": [
|
||||
"error",
|
||||
{
|
||||
args: "all",
|
||||
argsIgnorePattern: "^_",
|
||||
caughtErrors: "all",
|
||||
caughtErrorsIgnorePattern: "^_",
|
||||
destructuredArrayIgnorePattern: "^_",
|
||||
varsIgnorePattern: "^_",
|
||||
ignoreRestSiblings: true,
|
||||
},
|
||||
],
|
||||
|
||||
"no-use-before-define": "off",
|
||||
|
||||
"@typescript-eslint/no-use-before-define": [
|
||||
"error",
|
||||
{
|
||||
@ -301,12 +310,14 @@ export default typescriptESLint.config(
|
||||
|
||||
"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",
|
||||
|
||||
"no-redeclare": "off",
|
||||
"@typescript-eslint/no-redeclare": [
|
||||
"error",
|
||||
{
|
||||
@ -316,8 +327,8 @@ export default typescriptESLint.config(
|
||||
|
||||
"no-throw-literal": "off",
|
||||
"@typescript-eslint/only-throw-error": "error",
|
||||
"no-unused-expressions": "off",
|
||||
|
||||
"no-unused-expressions": "off",
|
||||
"@typescript-eslint/no-unused-expressions": [
|
||||
"error",
|
||||
{
|
||||
@ -329,23 +340,18 @@ export default typescriptESLint.config(
|
||||
|
||||
"no-useless-constructor": "off",
|
||||
"@typescript-eslint/no-useless-constructor": "error",
|
||||
|
||||
"@typescript-eslint/no-unnecessary-template-expression": "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-wrapper-object-types": "error",
|
||||
"@typescript-eslint/consistent-type-definitions": ["error", "interface"],
|
||||
|
||||
"no-duplicate-imports": "off",
|
||||
"@typescript-eslint/consistent-type-imports": "error",
|
||||
|
||||
"@typescript-eslint/explicit-member-accessibility": "error",
|
||||
"@typescript-eslint/explicit-function-return-type": [
|
||||
"error",
|
||||
{
|
||||
@ -357,7 +363,6 @@ export default typescriptESLint.config(
|
||||
],
|
||||
|
||||
"@typescript-eslint/method-signature-style": "error",
|
||||
"@typescript-eslint/unbound-method": "error",
|
||||
|
||||
"@typescript-eslint/naming-convention": [
|
||||
"error",
|
||||
@ -382,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-invalid-void-type": "error",
|
||||
"@typescript-eslint/no-misused-new": "error",
|
||||
@ -420,6 +437,7 @@ export default typescriptESLint.config(
|
||||
"@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",
|
||||
|
||||
|
@ -1,5 +1,3 @@
|
||||
// @ts-check
|
||||
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import configConventions from "./eslint.config.js"
|
||||
|
||||
|
1966
package-lock.json
generated
1966
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
22
package.json
22
package.json
@ -54,16 +54,16 @@
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/eslint__js": "8.42.3",
|
||||
"@types/node": "22.7.8",
|
||||
"globals": "15.11.0",
|
||||
"editorconfig-checker": "6.0.0",
|
||||
"eslint": "9.13.0",
|
||||
"eslint-plugin-promise": "7.1.0",
|
||||
"eslint-plugin-unicorn": "56.0.0",
|
||||
"eslint-plugin-import-x": "4.3.1",
|
||||
"typescript-eslint": "8.11.0",
|
||||
"prettier": "3.3.3",
|
||||
"semantic-release": "23.1.1",
|
||||
"typescript": "5.6.3"
|
||||
"@types/node": "22.10.6",
|
||||
"globals": "15.14.0",
|
||||
"editorconfig-checker": "6.0.1",
|
||||
"eslint": "9.18.0",
|
||||
"eslint-plugin-promise": "7.2.1",
|
||||
"eslint-plugin-unicorn": "56.0.1",
|
||||
"eslint-plugin-import-x": "4.6.1",
|
||||
"typescript-eslint": "8.20.0",
|
||||
"prettier": "3.4.2",
|
||||
"semantic-release": "24.2.1",
|
||||
"typescript": "5.7.3"
|
||||
}
|
||||
}
|
||||
|
@ -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),
|
||||
)
|
||||
})
|
87
test/validate-config.test.js
Normal file
87
test/validate-config.test.js
Normal 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),
|
||||
)
|
||||
})
|
||||
})
|
Reference in New Issue
Block a user