1
1
mirror of https://github.com/theoludwig/eslint-config-conventions.git synced 2025-09-11 23:09:27 +02:00

Compare commits

..

10 Commits

11 changed files with 812 additions and 413 deletions

View File

@@ -10,10 +10,10 @@ jobs:
lint: lint:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
steps: steps:
- uses: "actions/checkout@v4.2.2" - uses: "actions/checkout@v5.0.0"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.2.0" uses: "actions/setup-node@v5.0.0"
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"
@@ -24,10 +24,3 @@ jobs:
- run: "node --run lint:editorconfig" - run: "node --run lint:editorconfig"
- run: "node --run lint:eslint" - run: "node --run lint:eslint"
- run: "node --run lint:prettier" - run: "node --run lint:prettier"
commitlint:
runs-on: "ubuntu-latest"
steps:
- uses: "actions/checkout@v4.2.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.2.2" - uses: "actions/checkout@v5.0.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.2.0" uses: "actions/setup-node@v5.0.0"
with: with:
node-version: "lts/*" node-version: "lts/*"
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.2.2" - uses: "actions/checkout@v5.0.0"
- name: "Setup Node.js" - name: "Setup Node.js"
uses: "actions/setup-node@v4.2.0" uses: "actions/setup-node@v5.0.0"
with: with:
node-version: "lts/*" node-version: "lts/*"
cache: "npm" cache: "npm"

View File

@@ -1,18 +1,19 @@
{ {
"$schema": "./node_modules/oxlint/configuration_schema.json", "$schema": "./node_modules/oxlint/configuration_schema.json",
"plugins": ["promise", "unicorn", "import"], "plugins": ["typescript", "unicorn", "react", "oxc", "promise"],
"categories": { "categories": {
"correctness": "off" "correctness": "error",
"perf": "error",
"suspicious": "error"
}, },
"env": { "env": {
"builtin": true, "builtin": true,
"es2025": true,
"browser": true, "browser": true,
"commonjs": true,
"node": true, "node": true,
"shared-node-browser": true "shared-node-browser": true
}, },
"rules": { "rules": {
"no-await-in-loop": "off",
"for-direction": "error", "for-direction": "error",
"no-async-promise-executor": "error", "no-async-promise-executor": "error",
"no-class-assign": "error", "no-class-assign": "error",
@@ -159,6 +160,7 @@
"yoda": ["error", "never"], "yoda": ["error", "never"],
"curly": ["error", "all"], "curly": ["error", "all"],
"func-style": ["error", "expression"], "func-style": ["error", "expression"],
"arrow-body-style": ["error", "always"],
"promise/param-names": "error", "promise/param-names": "error",
"promise/no-new-statics": "error", "promise/no-new-statics": "error",
"promise/no-nesting": "error", "promise/no-nesting": "error",
@@ -190,19 +192,62 @@
"unicorn/no-unnecessary-array-flat-depth": "error", "unicorn/no-unnecessary-array-flat-depth": "error",
"unicorn/consistent-assert": "error", "unicorn/consistent-assert": "error",
"unicorn/no-accessor-recursion": "error", "unicorn/no-accessor-recursion": "error",
"import-x/no-absolute-path": "error", "unicorn/no-array-reverse": "off",
"import-x/no-webpack-loader-syntax": "error", "react/no-array-index-key": "off",
"import-x/no-self-import": "error", "react-hooks/rules-of-hooks": "error",
"import-x/no-duplicates": "error", "react-hooks/exhaustive-deps": "error",
"import-x/no-named-default": "error", "react/jsx-key": "error",
"import-x/no-empty-named-blocks": "error", "react/jsx-no-comment-textnodes": "error",
"import-x/no-anonymous-default-export": "error", "react/jsx-no-duplicate-props": "error",
"import-x/consistent-type-specifier-style": ["error", "prefer-top-level"] "react/jsx-no-target-blank": "off",
"react/jsx-no-undef": "error",
"react/no-children-prop": "error",
"react/no-danger-with-children": "error",
"react/no-direct-mutation-state": "error",
"react/no-find-dom-node": "error",
"react/no-is-mounted": "error",
"react/no-render-return-value": "error",
"react/no-string-refs": "error",
"react/no-unescaped-entities": "error",
"react/no-unknown-property": "off",
"react/react-in-jsx-scope": "off",
"react/iframe-missing-sandbox": "off",
"react/self-closing-comp": [
"error",
{
"component": true,
"html": true
}
],
"react/void-dom-elements-no-children": "error",
"react/jsx-boolean-value": "error",
"@next/next/google-font-display": "error",
"@next/next/google-font-preconnect": "error",
"@next/next/next-script-for-ga": "error",
"@next/next/no-async-client-component": "error",
"@next/next/no-before-interactive-script-outside-document": "error",
"@next/next/no-css-tags": "error",
"@next/next/no-head-element": "error",
"@next/next/no-html-link-for-pages": "off",
"@next/next/no-img-element": "off",
"@next/next/no-page-custom-font": "error",
"@next/next/no-styled-jsx-in-document": "error",
"@next/next/no-sync-scripts": "error",
"@next/next/no-title-in-document-head": "error",
"@next/next/no-typos": "error",
"@next/next/no-unwanted-polyfillio": "error",
"@next/next/inline-script-id": "error",
"@next/next/no-assign-module-variable": "error",
"@next/next/no-document-import-in-page": "error",
"@next/next/no-duplicate-head": "error",
"@next/next/no-head-import-in-document": "error",
"@next/next/no-script-component-in-head": "error"
}, },
"overrides": [ "overrides": [
{ {
"files": ["**/*.ts", "**/*.tsx"], "files": ["**/*.ts", "**/*.tsx"],
"rules": { "rules": {
"@typescript-eslint/no-unnecessary-type-arguments": "off",
"no-unused-vars": [ "no-unused-vars": [
"error", "error",
{ {
@@ -215,6 +260,7 @@
"ignoreRestSiblings": true "ignoreRestSiblings": true
} }
], ],
"@typescript-eslint/no-implied-eval": "error",
"no-redeclare": [ "no-redeclare": [
"error", "error",
{ {
@@ -222,6 +268,7 @@
} }
], ],
"no-throw-literal": "off", "no-throw-literal": "off",
"@typescript-eslint/only-throw-error": "error",
"no-unused-expressions": [ "no-unused-expressions": [
"error", "error",
{ {
@@ -230,6 +277,7 @@
"allowTaggedTemplates": true "allowTaggedTemplates": true
} }
], ],
"@typescript-eslint/no-unnecessary-template-expression": "error",
"@typescript-eslint/adjacent-overload-signatures": "error", "@typescript-eslint/adjacent-overload-signatures": "error",
"@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",
@@ -248,14 +296,29 @@
"allowDirectConstAssertionInArrowFunctions": true "allowDirectConstAssertionInArrowFunctions": true
} }
], ],
"@typescript-eslint/no-dynamic-delete": "error", "@typescript-eslint/no-base-to-string": "error",
"@typescript-eslint/no-dynamic-delete": "off",
"@typescript-eslint/no-extra-non-null-assertion": "error", "@typescript-eslint/no-extra-non-null-assertion": "error",
"@typescript-eslint/no-redundant-type-constituents": "error",
"@typescript-eslint/no-extraneous-class": [ "@typescript-eslint/no-extraneous-class": [
"error", "error",
{ {
"allowWithDecorator": true "allowWithDecorator": true
} }
], ],
"@typescript-eslint/no-floating-promises": [
"error",
{
"allowForKnownSafeCalls": [
{
"from": "package",
"name": ["test", "it", "suite", "describe"],
"package": "node:test"
}
]
}
],
"@typescript-eslint/no-for-in-array": "error",
"@typescript-eslint/no-misused-new": "error", "@typescript-eslint/no-misused-new": "error",
"@typescript-eslint/no-non-null-asserted-optional-chain": "error", "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
"@typescript-eslint/no-non-null-assertion": "error", "@typescript-eslint/no-non-null-assertion": "error",
@@ -265,11 +328,37 @@
"allowDestructuring": true "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-require-imports": "error",
"@typescript-eslint/no-unsafe-unary-minus": "error",
"@typescript-eslint/no-unsafe-declaration-merging": "error", "@typescript-eslint/no-unsafe-declaration-merging": "error",
"@typescript-eslint/no-array-delete": "error",
"@typescript-eslint/prefer-as-const": "error", "@typescript-eslint/prefer-as-const": "error",
"@typescript-eslint/prefer-function-type": "error", "@typescript-eslint/prefer-function-type": "error",
"prefer-promise-reject-errors": "off" "@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
}
]
}, },
"plugins": ["typescript"] "plugins": ["typescript"]
} }

View File

@@ -1,6 +1,6 @@
# 💡 Contributing # Contributing
Thanks a lot for your interest in contributing to **eslint-config-conventions**! 🎉 Thanks a lot for your interest in contributing to **eslint-config-conventions**!
## Code of Conduct ## Code of Conduct

View File

@@ -17,7 +17,7 @@
<a href="https://www.npmjs.com/package/eslint-config-conventions"><img src="https://img.shields.io/npm/v/eslint-config-conventions.svg" alt="npm version"></a> <a href="https://www.npmjs.com/package/eslint-config-conventions"><img src="https://img.shields.io/npm/v/eslint-config-conventions.svg" alt="npm version"></a>
</p> </p>
## 📜 About ## About
**eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality. It supports both **JavaScript** and **TypeScript**. **eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality. It supports both **JavaScript** and **TypeScript**.
@@ -25,7 +25,7 @@ This configuration is mostly **for catching bugs** and **code-quality** so it is
More information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html). More information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html).
## ⚙️ Getting Started ## Getting Started
### Prerequisites ### Prerequisites
@@ -35,9 +35,9 @@ More information about **formatting rules** vs **code-quality rules** can be fou
```sh ```sh
npm install --save-dev \ npm install --save-dev \
eslint@^9.21.0 \ eslint@^9.22.0 \
eslint-plugin-promise@^7.2.1 \ eslint-plugin-promise@^7.2.1 \
eslint-plugin-unicorn@^59.0.0 \ eslint-plugin-unicorn@^61.0.0 \
eslint-plugin-import-x@^4.6.1 \ eslint-plugin-import-x@^4.6.1 \
globals@^16.0.0 \ globals@^16.0.0 \
typescript@^5.8.3 \ typescript@^5.8.3 \
@@ -62,10 +62,10 @@ Dependencies are:
#### `eslint.config.js` #### `eslint.config.js`
```js ```js
import typescriptESLint from "typescript-eslint" import { defineConfig } from "eslint/config"
import configConventions from "eslint-config-conventions" import configConventions from "eslint-config-conventions"
export default typescriptESLint.config(...configConventions, { export default defineConfig(...configConventions, {
files: ["**/*.ts", "**/*.tsx"], files: ["**/*.ts", "**/*.tsx"],
languageOptions: { languageOptions: {
parser: typescriptESLint.parser, parser: typescriptESLint.parser,
@@ -113,12 +113,21 @@ node --run lint:eslint -- --fix
node --run lint:prettier node --run lint:prettier
``` ```
## 💡 Contributing ### `.oxlintrc.json` (if using [oxlint](https://oxc.rs/))
```json
{
"$schema": "./node_modules/oxlint/configuration_schema.json",
"extends": ["node_modules/eslint-config-conventions/.oxlintrc.json"]
}
```
## Contributing
Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake. Anyone can help to improve the project, submit a Feature Request, a bug report or even correct a simple spelling mistake.
The steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file. The steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
## 📄 License ## License
[MIT](./LICENSE) [MIT](./LICENSE)

View File

@@ -1,10 +1,11 @@
import importX from "eslint-plugin-import-x"
import promise from "eslint-plugin-promise" import promise from "eslint-plugin-promise"
import unicorn from "eslint-plugin-unicorn" import unicorn from "eslint-plugin-unicorn"
import importX from "eslint-plugin-import-x" import { defineConfig } from "eslint/config"
import globals from "globals" import globals from "globals"
import typescriptESLint from "typescript-eslint" import typescriptESLint from "typescript-eslint"
export default typescriptESLint.config( export default defineConfig(
{ {
name: "eslint-config-conventions", name: "eslint-config-conventions",
plugins: { plugins: {
@@ -349,8 +350,6 @@ 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-type-conversion": "error",
"@typescript-eslint/no-unnecessary-template-expression": "error", "@typescript-eslint/no-unnecessary-template-expression": "error",
"@typescript-eslint/adjacent-overload-signatures": "error", "@typescript-eslint/adjacent-overload-signatures": "error",
@@ -386,7 +385,6 @@ export default typescriptESLint.config(
"@typescript-eslint/no-base-to-string": "error", "@typescript-eslint/no-base-to-string": "error",
"@typescript-eslint/no-deprecated": "error", "@typescript-eslint/no-deprecated": "error",
"@typescript-eslint/no-dynamic-delete": "error",
"@typescript-eslint/no-extra-non-null-assertion": "error", "@typescript-eslint/no-extra-non-null-assertion": "error",
"@typescript-eslint/no-redundant-type-constituents": "error", "@typescript-eslint/no-redundant-type-constituents": "error",
@@ -403,7 +401,7 @@ export default typescriptESLint.config(
allowForKnownSafeCalls: [ allowForKnownSafeCalls: [
{ {
from: "package", from: "package",
name: ["it", "describe"], name: ["test", "it", "suite", "describe"],
package: "node:test", package: "node:test",
}, },
], ],

View File

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

8
index.d.ts vendored
View File

@@ -1,7 +1,5 @@
import type typescriptESLint from "typescript-eslint" import type { defineConfig } from "eslint/config"
declare const eslintConfigConventions: ReturnType< declare const eslintConfig: ReturnType<typeof defineConfig>
typeof typescriptESLint.config
>
export default eslintConfigConventions export default eslintConfig

994
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -41,32 +41,52 @@
"lint:editorconfig": "editorconfig-checker", "lint:editorconfig": "editorconfig-checker",
"lint:eslint": "eslint . --max-warnings 0 --config eslint.config.mjs", "lint:eslint": "eslint . --max-warnings 0 --config eslint.config.mjs",
"lint:prettier": "prettier . --check", "lint:prettier": "prettier . --check",
"oxlint:migrate": "npx @oxlint/migrate", "oxlint:migrate": "npx @oxlint/migrate@latest eslint.config.js --type-aware",
"inspect": "eslint --inspect-config", "inspect": "eslint --inspect-config",
"test": "node --test", "test": "node --test",
"release": "semantic-release" "release": "semantic-release"
}, },
"peerDependencies": { "peerDependencies": {
"eslint": "^9.21.0", "eslint": "^9.22.0",
"eslint-plugin-promise": "^7.2.1", "eslint-plugin-promise": "^7.2.1",
"eslint-plugin-unicorn": "^59.0.0 || ^60.0.0", "eslint-plugin-unicorn": "^61.0.0",
"eslint-plugin-import-x": "^4.6.1", "eslint-plugin-import-x": "^4.6.1",
"globals": "^16.0.0", "globals": "^16.0.0",
"typescript-eslint": "^8.32.0" "typescript-eslint": "^8.32.0"
}, },
"peerDependenciesMeta": {
"eslint": {
"optional": true
},
"eslint-plugin-promise": {
"optional": true
},
"eslint-plugin-unicorn": {
"optional": true
},
"eslint-plugin-import-x": {
"optional": true
},
"globals": {
"optional": true
},
"typescript-eslint": {
"optional": true
}
},
"devDependencies": { "devDependencies": {
"@types/node": "24.0.15", "@types/node": "24.3.1",
"globals": "16.3.0", "globals": "16.4.0",
"editorconfig-checker": "6.1.0", "editorconfig-checker": "6.1.0",
"oxlint": "1.7.0", "oxlint": "1.15.0",
"@oxlint/migrate": "1.7.0", "@oxlint/migrate": "1.15.0",
"eslint": "9.31.0", "eslint": "9.35.0",
"eslint-plugin-promise": "7.2.1", "eslint-plugin-promise": "7.2.1",
"eslint-plugin-unicorn": "60.0.0", "eslint-plugin-unicorn": "61.0.2",
"eslint-plugin-import-x": "4.16.1", "eslint-plugin-import-x": "4.16.1",
"typescript-eslint": "8.38.0", "typescript-eslint": "8.43.0",
"prettier": "3.6.2", "prettier": "3.6.2",
"semantic-release": "24.2.7", "semantic-release": "24.2.8",
"typescript": "5.8.3" "typescript": "5.9.2"
} }
} }