mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-02-23 01:01:31 +01:00
Compare commits
No commits in common. "develop" and "v17.0.0-beta.1" have entirely different histories.
develop
...
v17.0.0-be
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.2"
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.2.0"
|
||||
uses: "actions/setup-node@v4.0.4"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
@ -28,6 +28,6 @@ jobs:
|
||||
commitlint:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.2.2"
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
|
||||
- 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.2"
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.2.0"
|
||||
uses: "actions/setup-node@v4.0.4"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
node-version: "22.x"
|
||||
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.2"
|
||||
- uses: "actions/checkout@v4.2.0"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.2.0"
|
||||
uses: "actions/setup-node@v4.0.4"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
|
31
README.md
31
README.md
@ -29,19 +29,19 @@ More information about **formatting rules** vs **code-quality rules** can be fou
|
||||
|
||||
### Prerequisites
|
||||
|
||||
[Node.js](https://nodejs.org/) >= 20.11.0
|
||||
[Node.js](https://nodejs.org/) >= 20.9.0
|
||||
|
||||
### Installation
|
||||
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
eslint@^9.21.0 \
|
||||
eslint-plugin-promise@^7.2.1 \
|
||||
eslint-plugin-unicorn@^57.0.0 \
|
||||
eslint-plugin-import-x@^4.6.1 \
|
||||
globals@^16.0.0 \
|
||||
typescript@^5.7.3 \
|
||||
typescript-eslint@^8.24.1 \
|
||||
eslint@^9.12.0 \
|
||||
eslint-plugin-promise@^7.1.0 \
|
||||
eslint-plugin-unicorn@^56.0.0 \
|
||||
eslint-plugin-import-x@^4.3.1 \
|
||||
globals@^15.10.0 \
|
||||
"typescript@~5.5.4" \
|
||||
"typescript-eslint@^8.8.0" \
|
||||
eslint-config-conventions@latest
|
||||
```
|
||||
|
||||
@ -59,22 +59,13 @@ Dependencies are:
|
||||
|
||||
### Configuration
|
||||
|
||||
#### `eslint.config.js`
|
||||
#### `eslint.config.js` (JavaScript and TypeScript)
|
||||
|
||||
```js
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import configConventions from "eslint-config-conventions"
|
||||
import eslintConfigConventions from "eslint-config-conventions"
|
||||
|
||||
export default typescriptESLint.config(...configConventions, {
|
||||
files: ["**/*.ts", "**/*.tsx"],
|
||||
languageOptions: {
|
||||
parser: typescriptESLint.parser,
|
||||
parserOptions: {
|
||||
projectService: true,
|
||||
tsconfigRootDir: import.meta.dirname,
|
||||
},
|
||||
},
|
||||
})
|
||||
export default typescriptESLint.config(...eslintConfigConventions)
|
||||
```
|
||||
|
||||
#### Configuration with [Prettier](https://prettier.io/) (recommended)
|
||||
|
@ -79,13 +79,7 @@ export default typescriptESLint.config(
|
||||
"no-unused-vars": [
|
||||
"error",
|
||||
{
|
||||
args: "all",
|
||||
argsIgnorePattern: "^_",
|
||||
caughtErrors: "all",
|
||||
caughtErrorsIgnorePattern: "^_",
|
||||
destructuredArrayIgnorePattern: "^_",
|
||||
varsIgnorePattern: "^_",
|
||||
ignoreRestSiblings: true,
|
||||
},
|
||||
],
|
||||
"no-use-before-define": [
|
||||
@ -132,8 +126,6 @@ export default typescriptESLint.config(
|
||||
"no-array-constructor": "error",
|
||||
"no-caller": "error",
|
||||
"no-delete-var": "error",
|
||||
"no-implicit-coercion": "error",
|
||||
"no-extra-boolean-cast": ["error", { enforceForInnerExpressions: true }],
|
||||
"no-empty": [
|
||||
"error",
|
||||
{
|
||||
@ -224,8 +216,8 @@ export default typescriptESLint.config(
|
||||
|
||||
"unicorn/better-regex": "error",
|
||||
"unicorn/catch-error-name": "error",
|
||||
"unicorn/consistent-destructuring": "error",
|
||||
"unicorn/custom-error-definition": "error",
|
||||
"unicorn/consistent-date-clone": "error",
|
||||
"unicorn/error-message": "error",
|
||||
"unicorn/escape-case": "error",
|
||||
"unicorn/explicit-length-check": "error",
|
||||
@ -234,10 +226,9 @@ export default typescriptESLint.config(
|
||||
"unicorn/no-array-for-each": "error",
|
||||
"unicorn/no-array-method-this-argument": "error",
|
||||
"unicorn/no-document-cookie": "error",
|
||||
"unicorn/no-named-default": "error",
|
||||
"unicorn/no-empty-file": "error",
|
||||
"unicorn/no-hex-escape": "error",
|
||||
"unicorn/no-instanceof-builtins": "error",
|
||||
"unicorn/no-instanceof-array": "error",
|
||||
"unicorn/no-new-array": "error",
|
||||
"unicorn/no-new-buffer": "error",
|
||||
"unicorn/no-this-assignment": "error",
|
||||
@ -251,7 +242,6 @@ export default typescriptESLint.config(
|
||||
"unicorn/prefer-modern-math-apis": "error",
|
||||
"unicorn/prefer-structured-clone": "error",
|
||||
"unicorn/template-indent": "error",
|
||||
"unicorn/consistent-existence-index-check": "error",
|
||||
|
||||
"import-x/no-absolute-path": "error",
|
||||
"import-x/no-webpack-loader-syntax": "error",
|
||||
@ -283,25 +273,19 @@ export default typescriptESLint.config(
|
||||
|
||||
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",
|
||||
{
|
||||
args: "all",
|
||||
argsIgnorePattern: "^_",
|
||||
caughtErrors: "all",
|
||||
caughtErrorsIgnorePattern: "^_",
|
||||
destructuredArrayIgnorePattern: "^_",
|
||||
varsIgnorePattern: "^_",
|
||||
ignoreRestSiblings: true,
|
||||
},
|
||||
],
|
||||
|
||||
"no-use-before-define": "off",
|
||||
|
||||
"@typescript-eslint/no-use-before-define": [
|
||||
"error",
|
||||
{
|
||||
@ -315,14 +299,12 @@ 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",
|
||||
|
||||
"@typescript-eslint/no-redeclare": [
|
||||
"error",
|
||||
{
|
||||
@ -332,8 +314,8 @@ export default typescriptESLint.config(
|
||||
|
||||
"no-throw-literal": "off",
|
||||
"@typescript-eslint/only-throw-error": "error",
|
||||
|
||||
"no-unused-expressions": "off",
|
||||
|
||||
"@typescript-eslint/no-unused-expressions": [
|
||||
"error",
|
||||
{
|
||||
@ -345,18 +327,30 @@ export default typescriptESLint.config(
|
||||
|
||||
"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-member-accessibility": "error",
|
||||
"@typescript-eslint/explicit-function-return-type": [
|
||||
"error",
|
||||
{
|
||||
@ -368,6 +362,7 @@ export default typescriptESLint.config(
|
||||
],
|
||||
|
||||
"@typescript-eslint/method-signature-style": "error",
|
||||
"@typescript-eslint/unbound-method": "error",
|
||||
|
||||
"@typescript-eslint/naming-convention": [
|
||||
"error",
|
||||
@ -392,19 +387,7 @@ export default typescriptESLint.config(
|
||||
},
|
||||
],
|
||||
|
||||
"@typescript-eslint/no-floating-promises": [
|
||||
"error",
|
||||
{
|
||||
allowForKnownSafeCalls: [
|
||||
{
|
||||
from: "package",
|
||||
name: ["it", "describe"],
|
||||
package: "node:test",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
"@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",
|
||||
@ -442,7 +425,6 @@ 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,6 +1,8 @@
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import configConventions from "./eslint.config.js"
|
||||
// @ts-check
|
||||
|
||||
export default typescriptESLint.config(...configConventions, {
|
||||
import typescriptESLint from "typescript-eslint"
|
||||
import eslintConfigConventions from "./eslint.config.js"
|
||||
|
||||
export default typescriptESLint.config(...eslintConfigConventions, {
|
||||
ignores: ["test/fixtures/*"],
|
||||
})
|
||||
|
2564
package-lock.json
generated
2564
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
37
package.json
37
package.json
@ -34,7 +34,7 @@
|
||||
"provenance": true
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=20.11.0"
|
||||
"node": ">=20.9.0"
|
||||
},
|
||||
"scripts": {
|
||||
"lint:editorconfig": "editorconfig-checker",
|
||||
@ -45,24 +45,25 @@
|
||||
"release": "semantic-release"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"eslint": "^9.21.0",
|
||||
"eslint-plugin-promise": "^7.2.1",
|
||||
"eslint-plugin-unicorn": "^57.0.0",
|
||||
"eslint-plugin-import-x": "^4.6.1",
|
||||
"globals": "^16.0.0",
|
||||
"typescript-eslint": "^8.24.1"
|
||||
"eslint": "^9.12.0",
|
||||
"eslint-plugin-promise": "^7.1.0",
|
||||
"eslint-plugin-unicorn": "^56.0.0",
|
||||
"eslint-plugin-import-x": "^4.3.1",
|
||||
"globals": "^15.10.0",
|
||||
"typescript-eslint": "^8.8.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/node": "22.13.5",
|
||||
"globals": "16.0.0",
|
||||
"editorconfig-checker": "6.0.1",
|
||||
"eslint": "9.21.0",
|
||||
"eslint-plugin-promise": "7.2.1",
|
||||
"eslint-plugin-unicorn": "57.0.0",
|
||||
"eslint-plugin-import-x": "4.6.1",
|
||||
"typescript-eslint": "8.24.1",
|
||||
"prettier": "3.5.2",
|
||||
"semantic-release": "24.2.3",
|
||||
"typescript": "5.7.3"
|
||||
"@types/eslint__js": "8.42.3",
|
||||
"@types/node": "22.7.4",
|
||||
"globals": "15.10.0",
|
||||
"editorconfig-checker": "6.0.0",
|
||||
"eslint": "9.12.0",
|
||||
"eslint-plugin-promise": "7.1.0",
|
||||
"eslint-plugin-unicorn": "56.0.0",
|
||||
"eslint-plugin-import-x": "4.3.1",
|
||||
"typescript-eslint": "8.8.0",
|
||||
"prettier": "3.3.3",
|
||||
"semantic-release": "23.1.1",
|
||||
"typescript": "5.5.4"
|
||||
}
|
||||
}
|
||||
|
77
test/validate-config.js
Normal file
77
test/validate-config.js
Normal file
@ -0,0 +1,77 @@
|
||||
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),
|
||||
)
|
||||
})
|
@ -1,87 +0,0 @@
|
||||
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),
|
||||
)
|
||||
})
|
||||
})
|
Loading…
x
Reference in New Issue
Block a user