mirror of
				https://github.com/theoludwig/eslint-config-conventions.git
				synced 2025-10-21 07:35:11 +02:00 
			
		
		
		
	Compare commits
	
		
			39 Commits
		
	
	
		
			v18.0.0
			...
			1b70b62de1
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 1b70b62de1 | |||
| 09493ef433 | |||
| a13aeadda8 | |||
| 5817503919 | |||
| 23bb31949d | |||
| 911fadcf02 | |||
| 2d8260472a | |||
| 929978af36 | |||
| 6f42dbcdbe | |||
| 6cd0334469 | |||
| a014deeed6 | |||
| 91b66d24cd | |||
| 6a11f2dbf6 | |||
| 2876f22947 | |||
| 910050f30d | |||
| 8953d875b5 | |||
| f45ab1dcbb | |||
| 7bbac61906 | |||
| 3aacbbeec4 | |||
| c4340efc6f | |||
| 851c468748 | |||
| 892a3f8302 | |||
| 620f6ce442 | |||
| 1000c38cb2 | |||
| 517778ac50 | |||
| af99632f51 | |||
| 029a8d1757 | |||
| 20f48f93aa | |||
| d5903f0e22 | |||
| 1ce9bcb87e | |||
| 51c17a84d4 | |||
| 657b9a4bad | |||
| 31ab3e70a8 | |||
| ec16bb6eec | |||
| fe7fddca13 | |||
| 42ae3ffe33 | |||
| 8951ecc027 | |||
| 33c0f840ea | |||
| d9733dc1c8 | 
							
								
								
									
										11
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										11
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							| @@ -10,10 +10,10 @@ jobs: | ||||
|   lint: | ||||
|     runs-on: "ubuntu-latest" | ||||
|     steps: | ||||
|       - uses: "actions/checkout@v4.2.2" | ||||
|       - uses: "actions/checkout@v5.0.0" | ||||
|  | ||||
|       - name: "Setup Node.js" | ||||
|         uses: "actions/setup-node@v4.1.0" | ||||
|         uses: "actions/setup-node@v5.0.0" | ||||
|         with: | ||||
|           node-version: "lts/*" | ||||
|           cache: "npm" | ||||
| @@ -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" | ||||
|   | ||||
							
								
								
									
										4
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							| @@ -13,13 +13,13 @@ jobs: | ||||
|       pull-requests: "write" | ||||
|       id-token: "write" | ||||
|     steps: | ||||
|       - uses: "actions/checkout@v4.2.2" | ||||
|       - uses: "actions/checkout@v5.0.0" | ||||
|         with: | ||||
|           fetch-depth: 0 | ||||
|           persist-credentials: false | ||||
|  | ||||
|       - name: "Setup Node.js" | ||||
|         uses: "actions/setup-node@v4.1.0" | ||||
|         uses: "actions/setup-node@v5.0.0" | ||||
|         with: | ||||
|           node-version: "lts/*" | ||||
|           cache: "npm" | ||||
|   | ||||
							
								
								
									
										4
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										4
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							| @@ -10,10 +10,10 @@ jobs: | ||||
|   test: | ||||
|     runs-on: "ubuntu-latest" | ||||
|     steps: | ||||
|       - uses: "actions/checkout@v4.2.2" | ||||
|       - uses: "actions/checkout@v5.0.0" | ||||
|  | ||||
|       - name: "Setup Node.js" | ||||
|         uses: "actions/setup-node@v4.1.0" | ||||
|         uses: "actions/setup-node@v5.0.0" | ||||
|         with: | ||||
|           node-version: "lts/*" | ||||
|           cache: "npm" | ||||
|   | ||||
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							| @@ -27,3 +27,4 @@ npm-debug.log* | ||||
|  | ||||
| # misc | ||||
| .DS_Store | ||||
| *.bak | ||||
|   | ||||
							
								
								
									
										377
									
								
								.oxlintrc.json
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										377
									
								
								.oxlintrc.json
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,377 @@ | ||||
| { | ||||
|   "$schema": "./node_modules/oxlint/configuration_schema.json", | ||||
|   "plugins": ["typescript", "unicorn", "react", "oxc", "import", "promise"], | ||||
|   "categories": { | ||||
|     "correctness": "error", | ||||
|     "perf": "error", | ||||
|     "suspicious": "error" | ||||
|   }, | ||||
|   "env": { | ||||
|     "builtin": true, | ||||
|     "browser": 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", | ||||
|     "no-compare-neg-zero": "error", | ||||
|     "no-cond-assign": "error", | ||||
|     "no-const-assign": "error", | ||||
|     "no-constant-binary-expression": "error", | ||||
|     "no-constant-condition": "error", | ||||
|     "no-constructor-return": "error", | ||||
|     "no-control-regex": "error", | ||||
|     "no-debugger": "error", | ||||
|     "no-dupe-class-members": "error", | ||||
|     "no-dupe-else-if": "error", | ||||
|     "no-dupe-keys": "error", | ||||
|     "no-duplicate-case": "error", | ||||
|     "no-duplicate-imports": "error", | ||||
|     "no-empty-character-class": "error", | ||||
|     "no-empty-pattern": "error", | ||||
|     "no-ex-assign": "error", | ||||
|     "no-fallthrough": "error", | ||||
|     "no-func-assign": "error", | ||||
|     "no-import-assign": "error", | ||||
|     "no-invalid-regexp": "error", | ||||
|     "no-irregular-whitespace": "error", | ||||
|     "no-loss-of-precision": "error", | ||||
|     "no-new-native-nonconstructor": "error", | ||||
|     "no-obj-calls": "error", | ||||
|     "no-prototype-builtins": "error", | ||||
|     "no-self-assign": "error", | ||||
|     "no-self-compare": "error", | ||||
|     "no-setter-return": "error", | ||||
|     "no-sparse-arrays": "error", | ||||
|     "no-this-before-super": "error", | ||||
|     "no-unexpected-multiline": "error", | ||||
|     "no-unsafe-finally": "error", | ||||
|     "no-unsafe-negation": "error", | ||||
|     "no-unsafe-optional-chaining": "error", | ||||
|     "no-unused-private-class-members": "error", | ||||
|     "no-unused-vars": [ | ||||
|       "error", | ||||
|       { | ||||
|         "args": "all", | ||||
|         "argsIgnorePattern": "^_", | ||||
|         "caughtErrors": "all", | ||||
|         "caughtErrorsIgnorePattern": "^_", | ||||
|         "destructuredArrayIgnorePattern": "^_", | ||||
|         "varsIgnorePattern": "^_", | ||||
|         "ignoreRestSiblings": true | ||||
|       } | ||||
|     ], | ||||
|     "no-useless-backreference": "error", | ||||
|     "use-isnan": [ | ||||
|       "error", | ||||
|       { | ||||
|         "enforceForSwitchCase": true, | ||||
|         "enforceForIndexOf": true | ||||
|       } | ||||
|     ], | ||||
|     "valid-typeof": [ | ||||
|       "error", | ||||
|       { | ||||
|         "requireStringLiterals": true | ||||
|       } | ||||
|     ], | ||||
|     "default-param-last": "error", | ||||
|     "default-case-last": "error", | ||||
|     "eqeqeq": [ | ||||
|       "error", | ||||
|       "always", | ||||
|       { | ||||
|         "null": "ignore" | ||||
|       } | ||||
|     ], | ||||
|     "grouped-accessor-pairs": "error", | ||||
|     "new-cap": [ | ||||
|       "error", | ||||
|       { | ||||
|         "newIsCap": true, | ||||
|         "capIsNew": false, | ||||
|         "properties": true | ||||
|       } | ||||
|     ], | ||||
|     "no-array-constructor": "error", | ||||
|     "no-caller": "error", | ||||
|     "no-delete-var": "error", | ||||
|     "no-extra-boolean-cast": [ | ||||
|       "error", | ||||
|       { | ||||
|         "enforceForInnerExpressions": true | ||||
|       } | ||||
|     ], | ||||
|     "no-empty": [ | ||||
|       "error", | ||||
|       { | ||||
|         "allowEmptyCatch": true | ||||
|       } | ||||
|     ], | ||||
|     "no-empty-static-block": "error", | ||||
|     "no-eval": "error", | ||||
|     "no-global-assign": "error", | ||||
|     "no-multi-str": "error", | ||||
|     "no-new-func": "error", | ||||
|     "no-object-constructor": "error", | ||||
|     "no-proto": "error", | ||||
|     "no-redeclare": [ | ||||
|       "error", | ||||
|       { | ||||
|         "builtinGlobals": false | ||||
|       } | ||||
|     ], | ||||
|     "no-regex-spaces": "error", | ||||
|     "no-shadow-restricted-names": "error", | ||||
|     "no-throw-literal": "error", | ||||
|     "no-unused-expressions": [ | ||||
|       "error", | ||||
|       { | ||||
|         "allowShortCircuit": true, | ||||
|         "allowTernary": true, | ||||
|         "allowTaggedTemplates": true | ||||
|       } | ||||
|     ], | ||||
|     "no-useless-call": "error", | ||||
|     "no-useless-concat": "error", | ||||
|     "no-useless-computed-key": "error", | ||||
|     "no-useless-constructor": "error", | ||||
|     "no-useless-escape": "error", | ||||
|     "no-useless-rename": "error", | ||||
|     "no-else-return": [ | ||||
|       "error", | ||||
|       { | ||||
|         "allowElseIf": false | ||||
|       } | ||||
|     ], | ||||
|     "no-var": "error", | ||||
|     "no-void": [ | ||||
|       "error", | ||||
|       { | ||||
|         "allowAsStatement": true | ||||
|       } | ||||
|     ], | ||||
|     "no-with": "error", | ||||
|     "prefer-object-has-own": "error", | ||||
|     "prefer-promise-reject-errors": "error", | ||||
|     "radix": "error", | ||||
|     "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", | ||||
|     "unicorn/catch-error-name": "error", | ||||
|     "unicorn/consistent-date-clone": "error", | ||||
|     "unicorn/error-message": "error", | ||||
|     "unicorn/escape-case": "error", | ||||
|     "unicorn/explicit-length-check": "error", | ||||
|     "unicorn/new-for-builtins": "error", | ||||
|     "unicorn/no-array-for-each": "error", | ||||
|     "unicorn/no-array-method-this-argument": "error", | ||||
|     "unicorn/no-document-cookie": "error", | ||||
|     "unicorn/no-empty-file": "error", | ||||
|     "unicorn/no-hex-escape": "error", | ||||
|     "unicorn/no-instanceof-builtins": "error", | ||||
|     "unicorn/no-new-array": "error", | ||||
|     "unicorn/no-new-buffer": "error", | ||||
|     "unicorn/no-this-assignment": "error", | ||||
|     "unicorn/no-zero-fractions": "error", | ||||
|     "unicorn/number-literal-case": "error", | ||||
|     "unicorn/prefer-node-protocol": "error", | ||||
|     "unicorn/throw-new-error": "error", | ||||
|     "unicorn/no-typeof-undefined": "error", | ||||
|     "unicorn/require-array-join-separator": "error", | ||||
|     "unicorn/prefer-number-properties": "error", | ||||
|     "unicorn/prefer-modern-math-apis": "error", | ||||
|     "unicorn/prefer-structured-clone": "error", | ||||
|     "unicorn/consistent-existence-index-check": "error", | ||||
|     "unicorn/no-unnecessary-array-flat-depth": "error", | ||||
|     "unicorn/consistent-assert": "error", | ||||
|     "unicorn/no-accessor-recursion": "error", | ||||
|     "unicorn/no-array-reverse": "off", | ||||
|     "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", | ||||
|     "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"], | ||||
|     "import-x/no-unassigned-import": "off" | ||||
|   }, | ||||
|   "overrides": [ | ||||
|     { | ||||
|       "files": ["**/*.ts", "**/*.tsx"], | ||||
|       "rules": { | ||||
|         "@typescript-eslint/no-unnecessary-type-arguments": "off", | ||||
|         "@typescript-eslint/no-unsafe-type-assertion": "off", | ||||
|         "no-unused-vars": [ | ||||
|           "error", | ||||
|           { | ||||
|             "args": "all", | ||||
|             "argsIgnorePattern": "^_", | ||||
|             "caughtErrors": "all", | ||||
|             "caughtErrorsIgnorePattern": "^_", | ||||
|             "destructuredArrayIgnorePattern": "^_", | ||||
|             "varsIgnorePattern": "^_", | ||||
|             "ignoreRestSiblings": true | ||||
|           } | ||||
|         ], | ||||
|         "@typescript-eslint/no-implied-eval": "error", | ||||
|         "no-redeclare": [ | ||||
|           "error", | ||||
|           { | ||||
|             "builtinGlobals": false | ||||
|           } | ||||
|         ], | ||||
|         "no-throw-literal": "off", | ||||
|         "@typescript-eslint/only-throw-error": "error", | ||||
|         "no-unused-expressions": [ | ||||
|           "error", | ||||
|           { | ||||
|             "allowShortCircuit": true, | ||||
|             "allowTernary": true, | ||||
|             "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", | ||||
|         "@typescript-eslint/consistent-type-definitions": [ | ||||
|           "error", | ||||
|           "interface" | ||||
|         ], | ||||
|         "no-duplicate-imports": "off", | ||||
|         "@typescript-eslint/consistent-type-imports": "error", | ||||
|         "@typescript-eslint/explicit-function-return-type": [ | ||||
|           "error", | ||||
|           { | ||||
|             "allowExpressions": true, | ||||
|             "allowHigherOrderFunctions": true, | ||||
|             "allowTypedFunctionExpressions": true, | ||||
|             "allowDirectConstAssertionInArrowFunctions": true | ||||
|           } | ||||
|         ], | ||||
|         "@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", | ||||
|         "@typescript-eslint/no-this-alias": [ | ||||
|           "error", | ||||
|           { | ||||
|             "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", | ||||
|         "@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 | ||||
|  | ||||
|   | ||||
							
								
								
									
										35
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										35
									
								
								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 | ||||
|  | ||||
| @@ -35,13 +35,13 @@ More information about **formatting rules** vs **code-quality rules** can be fou | ||||
|  | ||||
| ```sh | ||||
| npm install --save-dev \ | ||||
|   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@^9.22.0 \ | ||||
|   eslint-plugin-promise@^7.2.1 \ | ||||
|   eslint-plugin-unicorn@^61.0.0 \ | ||||
|   eslint-plugin-import-x@^4.6.1 \ | ||||
|   globals@^16.0.0 \ | ||||
|   typescript@^5.8.3 \ | ||||
|   typescript-eslint@^8.32.0 \ | ||||
|   eslint-config-conventions@latest | ||||
| ``` | ||||
|  | ||||
| @@ -62,10 +62,10 @@ Dependencies are: | ||||
| #### `eslint.config.js` | ||||
|  | ||||
| ```js | ||||
| import typescriptESLint from "typescript-eslint" | ||||
| import { defineConfig } from "eslint/config" | ||||
| import configConventions from "eslint-config-conventions" | ||||
|  | ||||
| export default typescriptESLint.config(...configConventions, { | ||||
| export default defineConfig(...configConventions, { | ||||
|   files: ["**/*.ts", "**/*.tsx"], | ||||
|   languageOptions: { | ||||
|     parser: typescriptESLint.parser, | ||||
| @@ -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) | ||||
|   | ||||
| @@ -1,16 +1,17 @@ | ||||
| import importXPlugin from "eslint-plugin-import-x" | ||||
| import promise from "eslint-plugin-promise" | ||||
| import unicorn from "eslint-plugin-unicorn" | ||||
| import importX from "eslint-plugin-import-x" | ||||
| import { defineConfig } from "eslint/config" | ||||
| import globals from "globals" | ||||
| import typescriptESLint from "typescript-eslint" | ||||
|  | ||||
| export default typescriptESLint.config( | ||||
| export default defineConfig( | ||||
|   { | ||||
|     name: "eslint-config-conventions", | ||||
|     plugins: { | ||||
|       promise, | ||||
|       unicorn, | ||||
|       "import-x": importX, | ||||
|       "import-x": importXPlugin, | ||||
|     }, | ||||
|     linterOptions: { | ||||
|       reportUnusedDisableDirectives: "error", | ||||
| @@ -132,6 +133,8 @@ 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", | ||||
|         { | ||||
| @@ -223,6 +226,7 @@ export default typescriptESLint.config( | ||||
|       "unicorn/better-regex": "error", | ||||
|       "unicorn/catch-error-name": "error", | ||||
|       "unicorn/custom-error-definition": "error", | ||||
|       "unicorn/consistent-date-clone": "error", | ||||
|       "unicorn/error-message": "error", | ||||
|       "unicorn/escape-case": "error", | ||||
|       "unicorn/explicit-length-check": "error", | ||||
| @@ -231,9 +235,10 @@ 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-array": "error", | ||||
|       "unicorn/no-instanceof-builtins": "error", | ||||
|       "unicorn/no-new-array": "error", | ||||
|       "unicorn/no-new-buffer": "error", | ||||
|       "unicorn/no-this-assignment": "error", | ||||
| @@ -247,6 +252,10 @@ 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", | ||||
|       "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", | ||||
| @@ -363,7 +372,6 @@ export default typescriptESLint.config( | ||||
|       ], | ||||
|  | ||||
|       "@typescript-eslint/method-signature-style": "error", | ||||
|       "@typescript-eslint/unbound-method": "error", | ||||
|  | ||||
|       "@typescript-eslint/naming-convention": [ | ||||
|         "error", | ||||
| @@ -377,7 +385,6 @@ export default typescriptESLint.config( | ||||
|  | ||||
|       "@typescript-eslint/no-base-to-string": "error", | ||||
|       "@typescript-eslint/no-deprecated": "error", | ||||
|       "@typescript-eslint/no-dynamic-delete": "error", | ||||
|       "@typescript-eslint/no-extra-non-null-assertion": "error", | ||||
|       "@typescript-eslint/no-redundant-type-constituents": "error", | ||||
|  | ||||
| @@ -388,7 +395,19 @@ export default typescriptESLint.config( | ||||
|         }, | ||||
|       ], | ||||
|  | ||||
|       "@typescript-eslint/no-floating-promises": "error", | ||||
|       "@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-invalid-void-type": "error", | ||||
|       "@typescript-eslint/no-misused-new": "error", | ||||
|   | ||||
| @@ -1,6 +1,6 @@ | ||||
| import typescriptESLint from "typescript-eslint" | ||||
| import { defineConfig } from "eslint/config" | ||||
| import configConventions from "./eslint.config.js" | ||||
|  | ||||
| export default typescriptESLint.config(...configConventions, { | ||||
| export default defineConfig(...configConventions, { | ||||
|   ignores: ["test/fixtures/*"], | ||||
| }) | ||||
|   | ||||
							
								
								
									
										8
									
								
								index.d.ts
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								index.d.ts
									
									
									
									
										vendored
									
									
								
							| @@ -1,7 +1,5 @@ | ||||
| import type typescriptESLint from "typescript-eslint" | ||||
| import type { defineConfig } from "eslint/config" | ||||
|  | ||||
| declare const eslintConfigConventions: ReturnType< | ||||
|   typeof typescriptESLint.config | ||||
| > | ||||
| declare const eslintConfig: ReturnType<typeof defineConfig> | ||||
|  | ||||
| export default eslintConfigConventions | ||||
| export default eslintConfig | ||||
|   | ||||
							
								
								
									
										3198
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										3198
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										59
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										59
									
								
								package.json
									
									
									
									
									
								
							| @@ -27,7 +27,8 @@ | ||||
|   "type": "module", | ||||
|   "files": [ | ||||
|     "eslint.config.js", | ||||
|     "index.d.ts" | ||||
|     "index.d.ts", | ||||
|     ".oxlintrc.json" | ||||
|   ], | ||||
|   "publishConfig": { | ||||
|     "access": "public", | ||||
| @@ -40,30 +41,52 @@ | ||||
|     "lint:editorconfig": "editorconfig-checker", | ||||
|     "lint:eslint": "eslint . --max-warnings 0 --config eslint.config.mjs", | ||||
|     "lint:prettier": "prettier . --check", | ||||
|     "oxlint:migrate": "npx @oxlint/migrate@latest eslint.config.js --type-aware", | ||||
|     "inspect": "eslint --inspect-config", | ||||
|     "test": "node --test", | ||||
|     "release": "semantic-release" | ||||
|   }, | ||||
|   "peerDependencies": { | ||||
|     "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" | ||||
|     "eslint": "^9.22.0", | ||||
|     "eslint-plugin-promise": "^7.2.1", | ||||
|     "eslint-plugin-unicorn": "^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/eslint__js": "8.42.3", | ||||
|     "@types/node": "22.10.2", | ||||
|     "globals": "15.13.0", | ||||
|     "editorconfig-checker": "6.0.0", | ||||
|     "eslint": "9.17.0", | ||||
|     "@types/node": "24.5.2", | ||||
|     "globals": "16.4.0", | ||||
|     "editorconfig-checker": "6.1.0", | ||||
|     "oxlint": "1.18.0", | ||||
|     "@oxlint/migrate": "1.18.0", | ||||
|     "eslint": "9.36.0", | ||||
|     "eslint-plugin-promise": "7.2.1", | ||||
|     "eslint-plugin-unicorn": "56.0.1", | ||||
|     "eslint-plugin-import-x": "4.5.0", | ||||
|     "typescript-eslint": "8.18.0", | ||||
|     "prettier": "3.4.2", | ||||
|     "semantic-release": "24.2.0", | ||||
|     "typescript": "5.7.2" | ||||
|     "eslint-plugin-unicorn": "61.0.2", | ||||
|     "eslint-plugin-import-x": "4.16.1", | ||||
|     "typescript-eslint": "8.44.1", | ||||
|     "prettier": "3.6.2", | ||||
|     "semantic-release": "24.2.9", | ||||
|     "typescript": "5.9.2" | ||||
|   } | ||||
| } | ||||
|   | ||||
| @@ -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