mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-09-11 23:09:27 +02:00
Compare commits
7 Commits
Author | SHA1 | Date | |
---|---|---|---|
929978af36
|
|||
6f42dbcdbe
|
|||
6cd0334469
|
|||
a014deeed6
|
|||
91b66d24cd
|
|||
6a11f2dbf6
|
|||
2876f22947
|
7
.github/workflows/lint.yml
vendored
7
.github/workflows/lint.yml
vendored
@@ -24,10 +24,3 @@ jobs:
|
||||
- run: "node --run lint:editorconfig"
|
||||
- run: "node --run lint:eslint"
|
||||
- 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"
|
||||
|
116
.oxlintrc.json
116
.oxlintrc.json
@@ -1,18 +1,19 @@
|
||||
{
|
||||
"$schema": "./node_modules/oxlint/configuration_schema.json",
|
||||
"plugins": ["promise", "unicorn", "import"],
|
||||
"plugins": ["typescript", "unicorn", "react", "oxc", "promise"],
|
||||
"categories": {
|
||||
"correctness": "off"
|
||||
"correctness": "error",
|
||||
"perf": "error",
|
||||
"suspicious": "error"
|
||||
},
|
||||
"env": {
|
||||
"builtin": true,
|
||||
"es2025": true,
|
||||
"browser": true,
|
||||
"commonjs": true,
|
||||
"node": true,
|
||||
"shared-node-browser": true
|
||||
},
|
||||
"rules": {
|
||||
"no-await-in-loop": "off",
|
||||
"for-direction": "error",
|
||||
"no-async-promise-executor": "error",
|
||||
"no-class-assign": "error",
|
||||
@@ -159,6 +160,7 @@
|
||||
"yoda": ["error", "never"],
|
||||
"curly": ["error", "all"],
|
||||
"func-style": ["error", "expression"],
|
||||
"arrow-body-style": ["error", "always"],
|
||||
"promise/param-names": "error",
|
||||
"promise/no-new-statics": "error",
|
||||
"promise/no-nesting": "error",
|
||||
@@ -190,19 +192,61 @@
|
||||
"unicorn/no-unnecessary-array-flat-depth": "error",
|
||||
"unicorn/consistent-assert": "error",
|
||||
"unicorn/no-accessor-recursion": "error",
|
||||
"import-x/no-absolute-path": "error",
|
||||
"import-x/no-webpack-loader-syntax": "error",
|
||||
"import-x/no-self-import": "error",
|
||||
"import-x/no-duplicates": "error",
|
||||
"import-x/no-named-default": "error",
|
||||
"import-x/no-empty-named-blocks": "error",
|
||||
"import-x/no-anonymous-default-export": "error",
|
||||
"import-x/consistent-type-specifier-style": ["error", "prefer-top-level"]
|
||||
"react/no-array-index-key": "off",
|
||||
"react-hooks/rules-of-hooks": "error",
|
||||
"react-hooks/exhaustive-deps": "error",
|
||||
"react/jsx-key": "error",
|
||||
"react/jsx-no-comment-textnodes": "error",
|
||||
"react/jsx-no-duplicate-props": "error",
|
||||
"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": [
|
||||
{
|
||||
"files": ["**/*.ts", "**/*.tsx"],
|
||||
"rules": {
|
||||
"@typescript-eslint/no-unnecessary-type-arguments": "off",
|
||||
"no-unused-vars": [
|
||||
"error",
|
||||
{
|
||||
@@ -215,6 +259,7 @@
|
||||
"ignoreRestSiblings": true
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/no-implied-eval": "error",
|
||||
"no-redeclare": [
|
||||
"error",
|
||||
{
|
||||
@@ -222,6 +267,7 @@
|
||||
}
|
||||
],
|
||||
"no-throw-literal": "off",
|
||||
"@typescript-eslint/only-throw-error": "error",
|
||||
"no-unused-expressions": [
|
||||
"error",
|
||||
{
|
||||
@@ -230,6 +276,7 @@
|
||||
"allowTaggedTemplates": true
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/no-unnecessary-template-expression": "error",
|
||||
"@typescript-eslint/adjacent-overload-signatures": "error",
|
||||
"@typescript-eslint/no-unsafe-function-type": "error",
|
||||
"@typescript-eslint/no-wrapper-object-types": "error",
|
||||
@@ -248,14 +295,29 @@
|
||||
"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-redundant-type-constituents": "error",
|
||||
"@typescript-eslint/no-extraneous-class": [
|
||||
"error",
|
||||
{
|
||||
"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-non-null-asserted-optional-chain": "error",
|
||||
"@typescript-eslint/no-non-null-assertion": "error",
|
||||
@@ -265,11 +327,37 @@
|
||||
"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",
|
||||
"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"]
|
||||
}
|
||||
|
@@ -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
|
||||
|
||||
|
19
README.md
19
README.md
@@ -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>
|
||||
</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**.
|
||||
|
||||
@@ -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).
|
||||
|
||||
## ⚙️ Getting Started
|
||||
## Getting Started
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -37,7 +37,7 @@ More information about **formatting rules** vs **code-quality rules** can be fou
|
||||
npm install --save-dev \
|
||||
eslint@^9.21.0 \
|
||||
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 \
|
||||
globals@^16.0.0 \
|
||||
typescript@^5.8.3 \
|
||||
@@ -113,12 +113,21 @@ node --run lint:eslint -- --fix
|
||||
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.
|
||||
|
||||
The steps to contribute can be found in the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
|
||||
|
||||
## 📄 License
|
||||
## License
|
||||
|
||||
[MIT](./LICENSE)
|
||||
|
@@ -403,7 +403,7 @@ export default typescriptESLint.config(
|
||||
allowForKnownSafeCalls: [
|
||||
{
|
||||
from: "package",
|
||||
name: ["it", "describe"],
|
||||
name: ["test", "it", "suite", "describe"],
|
||||
package: "node:test",
|
||||
},
|
||||
],
|
||||
|
1673
package-lock.json
generated
1673
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
48
package.json
48
package.json
@@ -41,7 +41,7 @@
|
||||
"lint:editorconfig": "editorconfig-checker",
|
||||
"lint:eslint": "eslint . --max-warnings 0 --config eslint.config.mjs",
|
||||
"lint:prettier": "prettier . --check",
|
||||
"oxlint:migrate": "npx @oxlint/migrate",
|
||||
"oxlint:migrate": "npx @oxlint/migrate@latest eslint.config.js --type-aware",
|
||||
"inspect": "eslint --inspect-config",
|
||||
"test": "node --test",
|
||||
"release": "semantic-release"
|
||||
@@ -49,24 +49,44 @@
|
||||
"peerDependencies": {
|
||||
"eslint": "^9.21.0",
|
||||
"eslint-plugin-promise": "^7.2.1",
|
||||
"eslint-plugin-unicorn": "^59.0.0",
|
||||
"eslint-plugin-unicorn": "^59.0.0 || ^60.0.0 || ^61.0.0",
|
||||
"eslint-plugin-import-x": "^4.6.1",
|
||||
"globals": "^16.0.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": {
|
||||
"@types/node": "24.0.0",
|
||||
"globals": "16.2.0",
|
||||
"editorconfig-checker": "6.0.1",
|
||||
"oxlint": "1.0.0",
|
||||
"@oxlint/migrate": "1.0.0",
|
||||
"eslint": "9.28.0",
|
||||
"@types/node": "24.3.1",
|
||||
"globals": "16.3.0",
|
||||
"editorconfig-checker": "6.1.0",
|
||||
"oxlint": "1.14.0",
|
||||
"@oxlint/migrate": "1.14.0",
|
||||
"eslint": "9.35.0",
|
||||
"eslint-plugin-promise": "7.2.1",
|
||||
"eslint-plugin-unicorn": "59.0.1",
|
||||
"eslint-plugin-import-x": "4.15.1",
|
||||
"typescript-eslint": "8.34.0",
|
||||
"prettier": "3.5.3",
|
||||
"semantic-release": "24.2.5",
|
||||
"typescript": "5.8.3"
|
||||
"eslint-plugin-unicorn": "61.0.1",
|
||||
"eslint-plugin-import-x": "4.16.1",
|
||||
"typescript-eslint": "8.42.0",
|
||||
"prettier": "3.6.2",
|
||||
"semantic-release": "24.2.7",
|
||||
"typescript": "5.9.2"
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user