mirror of
				https://github.com/theoludwig/eslint-config-conventions.git
				synced 2025-10-21 07:35:11 +02:00 
			
		
		
		
	Compare commits
	
		
			72 Commits
		
	
	
		
			v11.0.1
			...
			8efe22c23e
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 8efe22c23e | |||
| 57f419c44a | |||
| a578bb80ba | |||
| e32847fa3d | |||
| 1719cd18b3 | |||
| 55a46104da | |||
| 66044cc8eb | |||
| d9536865d8 | |||
| f258d5ab41 | |||
| 424235bd4f | |||
| 7486e3aab6 | |||
| 12f37d01b3 | |||
| 6af4b4f6ac | |||
| b4f1c0b8dd | |||
| 116c3c600a | |||
| 4115843cc1 | |||
| 14d3e0ba30 | |||
| 921aacdc9b | |||
| a03e2bd109 | |||
| 2db017e805 | |||
| 19f74fc6a2 | |||
| bcd9fe10d3 | |||
| c2147dbc7a | |||
| e6a222d01f | |||
| eac273c076 | |||
| 0df1b867a4 | |||
| 92e6e56884 | |||
| 305df380aa | |||
| 8b3d9109d7 | |||
| d0fa4e3688 | |||
| 9fa86e2133 | |||
| 6cb7af3a05 | |||
| b4de437548 | |||
| c751162403 | |||
| 152ccba986 | |||
| 10b5a0d8df | |||
| 815518c613 | |||
| 860873aa4b | |||
| 5eacace152 | |||
| 0dcde0af51 | |||
| b0fa907559 | |||
| d15df84a73 | |||
| aa4da3f6e8 | |||
| b180eae455 | |||
| 31b226ffa4 | |||
| 8403ef4254 | |||
| dbe252f3b4 | |||
| 6e6a8d7aa1 | |||
| 256a5024d6 | |||
| 3d2e708e96 | |||
| b0f6ef585f | |||
| 7abcc179e5 | |||
| b72745bdbe | |||
| 89c012cac2 | |||
| 00b7a2a89b | |||
| a5036c8381 | |||
| c9365be768 | |||
| c1a524e31b | |||
| 8585574a70 | |||
| fce826e24a | |||
| 17e90bcc35 | |||
| dab4433431 | |||
| b671018a00 | |||
| 17dea937eb | |||
| 7f3c152e61 | |||
| f243013173 | |||
| d3d71f9a78 | |||
| 6a064c227e | |||
| 113a469ac5 | |||
| 0e2b2ae89d | |||
| d91b2a2538 | |||
| d8b3ef6646 | 
| @@ -1 +0,0 @@ | |||||||
| { "extends": ["@commitlint/config-conventional"] } |  | ||||||
| @@ -1,2 +0,0 @@ | |||||||
| node_modules |  | ||||||
| test/fixtures |  | ||||||
							
								
								
									
										360
									
								
								.eslintrc.json
									
									
									
									
									
								
							
							
						
						
									
										360
									
								
								.eslintrc.json
									
									
									
									
									
								
							| @@ -1,360 +0,0 @@ | |||||||
| { |  | ||||||
|   "root": true, |  | ||||||
|   "plugins": ["import", "promise", "unicorn"], |  | ||||||
|   "env": { |  | ||||||
|     "browser": true, |  | ||||||
|     "node": true, |  | ||||||
|     "es2024": true |  | ||||||
|   }, |  | ||||||
|   "parserOptions": { |  | ||||||
|     "ecmaVersion": "latest", |  | ||||||
|     "sourceType": "module", |  | ||||||
|     "ecmaFeatures": { |  | ||||||
|       "jsx": true |  | ||||||
|     } |  | ||||||
|   }, |  | ||||||
|   "rules": { |  | ||||||
|     "constructor-super": "error", |  | ||||||
|     "for-direction": "error", |  | ||||||
|     "getter-return": "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-condition": "error", |  | ||||||
|     "no-constructor-return": "error", |  | ||||||
|     "no-control-regex": "error", |  | ||||||
|     "no-debugger": "error", |  | ||||||
|     "no-dupe-args": "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-empty-static-block": "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-misleading-character-class": "error", |  | ||||||
|     "no-new-native-nonconstructor": "error", |  | ||||||
|     "no-new-symbol": "error", |  | ||||||
|     "no-obj-calls": "error", |  | ||||||
|     "no-promise-executor-return": "error", |  | ||||||
|     "no-prototype-builtins": "error", |  | ||||||
|     "no-self-assign": "error", |  | ||||||
|     "no-self-compare": "error", |  | ||||||
|     "no-setter-return": "error", |  | ||||||
|     "no-this-before-super": "error", |  | ||||||
|     "no-undef": "error", |  | ||||||
|     "no-unexpected-multiline": "error", |  | ||||||
|     "no-unmodified-loop-condition": "error", |  | ||||||
|     "no-unreachable": "error", |  | ||||||
|     "no-unreachable-loop": "error", |  | ||||||
|     "no-unsafe-finally": "error", |  | ||||||
|     "no-unsafe-negation": "error", |  | ||||||
|     "no-unsafe-optional-chaining": "error", |  | ||||||
|     "no-unused-private-class-members": "error", |  | ||||||
|     "no-unused-vars": ["error", { "varsIgnorePattern": "^_" }], |  | ||||||
|     "no-use-before-define": [ |  | ||||||
|       "error", |  | ||||||
|       { |  | ||||||
|         "functions": false, |  | ||||||
|         "classes": false, |  | ||||||
|         "variables": false |  | ||||||
|       } |  | ||||||
|     ], |  | ||||||
|     "no-useless-backreference": "error", |  | ||||||
|     "use-isnan": [ |  | ||||||
|       "error", |  | ||||||
|       { |  | ||||||
|         "enforceForSwitchCase": true, |  | ||||||
|         "enforceForIndexOf": true |  | ||||||
|       } |  | ||||||
|     ], |  | ||||||
|     "valid-typeof": ["error", { "requireStringLiterals": true }], |  | ||||||
|  |  | ||||||
|     "consistent-this": "error", |  | ||||||
|     "default-param-last": "error", |  | ||||||
|     "default-case-last": "error", |  | ||||||
|     "dot-notation": ["error", { "allowKeywords": true }], |  | ||||||
|     "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-confusing-arrow": "error", |  | ||||||
|     "no-delete-var": "error", |  | ||||||
|     "no-empty": ["error", { "allowEmptyCatch": true }], |  | ||||||
|     "no-eval": "error", |  | ||||||
|     "no-floating-decimal": "error", |  | ||||||
|     "no-global-assign": "error", |  | ||||||
|     "no-implied-eval": "error", |  | ||||||
|     "no-mixed-operators": [ |  | ||||||
|       "error", |  | ||||||
|       { |  | ||||||
|         "groups": [ |  | ||||||
|           ["==", "!=", "===", "!==", ">", ">=", "<", "<="], |  | ||||||
|           ["&&", "||"], |  | ||||||
|           ["in", "instanceof"] |  | ||||||
|         ], |  | ||||||
|         "allowSamePrecedence": true |  | ||||||
|       } |  | ||||||
|     ], |  | ||||||
|     "no-multi-str": "error", |  | ||||||
|     "no-new-func": "error", |  | ||||||
|     "no-new-object": "error", |  | ||||||
|     "no-octal": "error", |  | ||||||
|     "no-octal-escape": "error", |  | ||||||
|     "no-proto": "error", |  | ||||||
|     "no-redeclare": ["error", { "builtinGlobals": false }], |  | ||||||
|     "no-regex-spaces": "error", |  | ||||||
|     "no-shadow-restricted-names": "error", |  | ||||||
|     "no-throw-literal": "error", |  | ||||||
|     "no-undef-init": "error", |  | ||||||
|     "no-unused-expressions": [ |  | ||||||
|       "error", |  | ||||||
|       { |  | ||||||
|         "allowShortCircuit": true, |  | ||||||
|         "allowTernary": true, |  | ||||||
|         "allowTaggedTemplates": true |  | ||||||
|       } |  | ||||||
|     ], |  | ||||||
|     "no-useless-call": "error", |  | ||||||
|     "no-useless-computed-key": "error", |  | ||||||
|     "no-useless-constructor": "error", |  | ||||||
|     "no-useless-escape": "error", |  | ||||||
|     "no-useless-rename": "error", |  | ||||||
|     "no-useless-return": "error", |  | ||||||
|     "no-var": "error", |  | ||||||
|     "no-void": "error", |  | ||||||
|     "no-with": "error", |  | ||||||
|     "object-shorthand": ["error", "properties"], |  | ||||||
|     "one-var": ["error", { "initialized": "never" }], |  | ||||||
|     "prefer-const": ["error", { "destructuring": "all" }], |  | ||||||
|     "prefer-object-has-own": "error", |  | ||||||
|     "prefer-promise-reject-errors": "error", |  | ||||||
|     "prefer-regex-literals": ["error", { "disallowRedundantWrapping": true }], |  | ||||||
|     "quote-props": ["error", "as-needed"], |  | ||||||
|     "radix": "error", |  | ||||||
|     "yoda": ["error", "never"], |  | ||||||
|     "curly": ["error", "all"], |  | ||||||
|     "func-style": ["error", "expression"], |  | ||||||
|     "prefer-arrow-callback": "error", |  | ||||||
|     "arrow-parens": ["error", "always"], |  | ||||||
|     "arrow-body-style": ["error", "always"], |  | ||||||
|  |  | ||||||
|     "import/no-absolute-path": "error", |  | ||||||
|     "import/no-webpack-loader-syntax": "error", |  | ||||||
|     "import/no-self-import": "error", |  | ||||||
|     "import/no-useless-path-segments": "error", |  | ||||||
|     "import/export": "error", |  | ||||||
|     "import/first": "error", |  | ||||||
|     "import/no-duplicates": "error", |  | ||||||
|     "import/order": [ |  | ||||||
|       "error", |  | ||||||
|       { |  | ||||||
|         "groups": ["builtin", "external", "internal"], |  | ||||||
|         "newlines-between": "always" |  | ||||||
|       } |  | ||||||
|     ], |  | ||||||
|     "import/no-named-default": "error", |  | ||||||
|     "import/no-empty-named-blocks": "error", |  | ||||||
|  |  | ||||||
|     "promise/param-names": "error", |  | ||||||
|     "promise/no-new-statics": "error", |  | ||||||
|  |  | ||||||
|     "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", |  | ||||||
|     "unicorn/explicit-length-check": "error", |  | ||||||
|     "unicorn/new-for-builtins": "error", |  | ||||||
|     "unicorn/no-array-callback-reference": "error", |  | ||||||
|     "unicorn/no-array-for-each": "error", |  | ||||||
|     "unicorn/no-array-method-this-argument": "error", |  | ||||||
|     "unicorn/no-array-push-push": "error", |  | ||||||
|     "unicorn/no-document-cookie": "error", |  | ||||||
|     "unicorn/no-empty-file": "error", |  | ||||||
|     "unicorn/no-hex-escape": "error", |  | ||||||
|     "unicorn/no-instanceof-array": "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/template-indent": "error" |  | ||||||
|   }, |  | ||||||
|   "overrides": [ |  | ||||||
|     { |  | ||||||
|       "files": ["*.ts", "*.tsx"], |  | ||||||
|       "parser": "@typescript-eslint/parser", |  | ||||||
|       "plugins": ["@typescript-eslint"], |  | ||||||
|       "rules": { |  | ||||||
|         "no-undef": "off", |  | ||||||
|         "no-dupe-class-members": "off", |  | ||||||
|         "@typescript-eslint/no-dupe-class-members": "error", |  | ||||||
|         "no-loss-of-precision": "off", |  | ||||||
|         "@typescript-eslint/no-loss-of-precision": "error", |  | ||||||
|         "no-unused-vars": "off", |  | ||||||
|         "@typescript-eslint/no-unused-vars": [ |  | ||||||
|           "error", |  | ||||||
|           { "varsIgnorePattern": "^_" } |  | ||||||
|         ], |  | ||||||
|         "no-use-before-define": "off", |  | ||||||
|         "@typescript-eslint/no-use-before-define": [ |  | ||||||
|           "error", |  | ||||||
|           { |  | ||||||
|             "functions": false, |  | ||||||
|             "classes": false, |  | ||||||
|             "enums": false, |  | ||||||
|             "variables": false, |  | ||||||
|             "typedefs": false |  | ||||||
|           } |  | ||||||
|         ], |  | ||||||
|         "default-param-last": "off", |  | ||||||
|         "@typescript-eslint/default-param-last": "error", |  | ||||||
|         "dot-notation": "off", |  | ||||||
|         "@typescript-eslint/dot-notation": ["error", { "allowKeywords": true }], |  | ||||||
|         "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", |  | ||||||
|           { "builtinGlobals": false } |  | ||||||
|         ], |  | ||||||
|         "no-throw-literal": "off", |  | ||||||
|         "@typescript-eslint/no-throw-literal": "error", |  | ||||||
|         "no-unused-expressions": "off", |  | ||||||
|         "@typescript-eslint/no-unused-expressions": [ |  | ||||||
|           "error", |  | ||||||
|           { |  | ||||||
|             "allowShortCircuit": true, |  | ||||||
|             "allowTernary": true, |  | ||||||
|             "allowTaggedTemplates": true |  | ||||||
|           } |  | ||||||
|         ], |  | ||||||
|         "no-useless-constructor": "off", |  | ||||||
|         "@typescript-eslint/no-useless-constructor": "error", |  | ||||||
|  |  | ||||||
|         "@typescript-eslint/adjacent-overload-signatures": "error", |  | ||||||
|         "@typescript-eslint/array-type": [ |  | ||||||
|           "error", |  | ||||||
|           { "default": "array-simple" } |  | ||||||
|         ], |  | ||||||
|         "@typescript-eslint/ban-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/member-delimiter-style": [ |  | ||||||
|           "error", |  | ||||||
|           { |  | ||||||
|             "multiline": { "delimiter": "none" }, |  | ||||||
|             "singleline": { "delimiter": "comma", "requireLast": false } |  | ||||||
|           } |  | ||||||
|         ], |  | ||||||
|         "@typescript-eslint/method-signature-style": "error", |  | ||||||
|         "@typescript-eslint/naming-convention": [ |  | ||||||
|           "error", |  | ||||||
|           { |  | ||||||
|             "selector": "variableLike", |  | ||||||
|             "leadingUnderscore": "allow", |  | ||||||
|             "trailingUnderscore": "allow", |  | ||||||
|             "format": ["camelCase", "PascalCase", "UPPER_CASE"] |  | ||||||
|           } |  | ||||||
|         ], |  | ||||||
|         "@typescript-eslint/no-base-to-string": "error", |  | ||||||
|         "@typescript-eslint/no-dynamic-delete": "error", |  | ||||||
|         "@typescript-eslint/no-extra-non-null-assertion": "error", |  | ||||||
|         "@typescript-eslint/no-extraneous-class": [ |  | ||||||
|           "error", |  | ||||||
|           { "allowWithDecorator": true } |  | ||||||
|         ], |  | ||||||
|         "@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", |  | ||||||
|         "@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-var-requires": "error", |  | ||||||
|         "@typescript-eslint/prefer-function-type": "error", |  | ||||||
|         "@typescript-eslint/prefer-includes": "error", |  | ||||||
|         "@typescript-eslint/prefer-nullish-coalescing": [ |  | ||||||
|           "error", |  | ||||||
|           { |  | ||||||
|             "ignoreTernaryTests": true, |  | ||||||
|             "ignoreConditionalTests": false, |  | ||||||
|             "ignoreMixedLogicalExpressions": false |  | ||||||
|           } |  | ||||||
|         ], |  | ||||||
|         "@typescript-eslint/prefer-readonly": "error", |  | ||||||
|         "@typescript-eslint/prefer-reduce-type-parameter": "error", |  | ||||||
|         "@typescript-eslint/prefer-ts-expect-error": "error", |  | ||||||
|         "@typescript-eslint/promise-function-async": "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 } |  | ||||||
|         ], |  | ||||||
|         "@typescript-eslint/return-await": ["error", "always"], |  | ||||||
|         "@typescript-eslint/strict-boolean-expressions": [ |  | ||||||
|           "error", |  | ||||||
|           { |  | ||||||
|             "allowString": false, |  | ||||||
|             "allowNumber": false, |  | ||||||
|             "allowNullableObject": false, |  | ||||||
|             "allowNullableBoolean": false, |  | ||||||
|             "allowNullableString": false, |  | ||||||
|             "allowNullableNumber": false, |  | ||||||
|             "allowAny": false |  | ||||||
|           } |  | ||||||
|         ], |  | ||||||
|         "@typescript-eslint/type-annotation-spacing": "error" |  | ||||||
|       } |  | ||||||
|     } |  | ||||||
|   ] |  | ||||||
| } |  | ||||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | |||||||
| --- | --- | ||||||
| name: '🐛 Bug Report' | name: "🐛 Bug Report" | ||||||
| about: 'Report an unexpected problem or unintended behavior.' | about: "Report an unexpected problem or unintended behavior." | ||||||
| title: '[Bug]' | title: "[Bug]" | ||||||
| labels: 'bug' | labels: "bug" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- | <!-- | ||||||
|   | |||||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | |||||||
| --- | --- | ||||||
| name: '📜 Documentation' | name: "📜 Documentation" | ||||||
| about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).' | about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)." | ||||||
| title: '[Documentation]' | title: "[Documentation]" | ||||||
| labels: 'documentation' | labels: "documentation" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- Please make sure your issue has not already been fixed. --> | <!-- Please make sure your issue has not already been fixed. --> | ||||||
|   | |||||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | |||||||
| --- | --- | ||||||
| name: '✨ Feature Request' | name: "✨ Feature Request" | ||||||
| about: 'Suggest a new feature idea.' | about: "Suggest a new feature idea." | ||||||
| title: '[Feature]' | title: "[Feature]" | ||||||
| labels: 'feature request' | labels: "feature request" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- Please make sure your issue has not already been fixed. --> | <!-- Please make sure your issue has not already been fixed. --> | ||||||
|   | |||||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/IMPROVEMENT.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/IMPROVEMENT.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | |||||||
| --- | --- | ||||||
| name: '🔧 Improvement' | name: "🔧 Improvement" | ||||||
| about: 'Improve structure/format/performance/refactor/tests of the code.' | about: "Improve structure/format/performance/refactor/tests of the code." | ||||||
| title: '[Improvement]' | title: "[Improvement]" | ||||||
| labels: 'improvement' | labels: "improvement" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| <!-- Please make sure your issue has not already been fixed. --> | <!-- Please make sure your issue has not already been fixed. --> | ||||||
|   | |||||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/QUESTION.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/QUESTION.md
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +1,8 @@ | |||||||
| --- | --- | ||||||
| name: '🙋 Question' | name: "🙋 Question" | ||||||
| about: 'Further information is requested.' | about: "Further information is requested." | ||||||
| title: '[Question]' | title: "[Question]" | ||||||
| labels: 'question' | labels: "question" | ||||||
| --- | --- | ||||||
|  |  | ||||||
| ### Question | ### Question | ||||||
|   | |||||||
							
								
								
									
										35
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										35
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,28 +1,33 @@ | |||||||
| name: 'Lint' | name: "Lint" | ||||||
|  |  | ||||||
| on: | on: | ||||||
|   push: |   push: | ||||||
|     branches: [develop] |     branches: [develop] | ||||||
|   pull_request: |   pull_request: | ||||||
|     branches: [master, develop] |     branches: [main, develop] | ||||||
|  |  | ||||||
| jobs: | jobs: | ||||||
|   lint: |   lint: | ||||||
|     runs-on: 'ubuntu-latest' |     runs-on: "ubuntu-latest" | ||||||
|     steps: |     steps: | ||||||
|       - uses: 'actions/checkout@v3.5.3' |       - uses: "actions/checkout@v4.2.0" | ||||||
|  |  | ||||||
|       - name: 'Setup Node.js' |       - name: "Setup Node.js" | ||||||
|         uses: 'actions/setup-node@v3.6.0' |         uses: "actions/setup-node@v4.0.4" | ||||||
|         with: |         with: | ||||||
|           node-version: 'lts/*' |           node-version: "22.x" | ||||||
|           cache: 'npm' |           cache: "npm" | ||||||
|  |  | ||||||
|       - name: 'Install dependencies' |       - name: "Install dependencies" | ||||||
|         run: 'npm clean-install' |         run: "npm clean-install" | ||||||
|  |  | ||||||
|       - run: 'npm run lint:commit -- --to "${{ github.sha }}"' |       - run: "node --run lint:editorconfig" | ||||||
|       - run: 'npm run lint:editorconfig' |       - run: "node --run lint:eslint" | ||||||
|       - run: 'npm run lint:markdown' |       - run: "node --run lint:prettier" | ||||||
|       - run: 'npm run lint:eslint' |  | ||||||
|       - run: 'npm run lint:prettier' |   commitlint: | ||||||
|  |     runs-on: "ubuntu-latest" | ||||||
|  |     steps: | ||||||
|  |       - uses: "actions/checkout@v4.2.0" | ||||||
|  |  | ||||||
|  |       - uses: "wagoid/commitlint-github-action@v6.1.2" | ||||||
|   | |||||||
							
								
								
									
										36
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										36
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,37 +1,37 @@ | |||||||
| name: 'Release' | name: "Release" | ||||||
|  |  | ||||||
| on: | on: | ||||||
|   push: |   push: | ||||||
|     branches: [master] |     branches: [main, beta] | ||||||
|  |  | ||||||
| jobs: | jobs: | ||||||
|   release: |   release: | ||||||
|     runs-on: 'ubuntu-latest' |     runs-on: "ubuntu-latest" | ||||||
|     permissions: |     permissions: | ||||||
|       contents: 'write' |       contents: "write" | ||||||
|       issues: 'write' |       issues: "write" | ||||||
|       pull-requests: 'write' |       pull-requests: "write" | ||||||
|       id-token: 'write' |       id-token: "write" | ||||||
|     steps: |     steps: | ||||||
|       - uses: 'actions/checkout@v3.5.3' |       - uses: "actions/checkout@v4.2.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@v3.6.0' |         uses: "actions/setup-node@v4.0.4" | ||||||
|         with: |         with: | ||||||
|           node-version: 'lts/*' |           node-version: "22.x" | ||||||
|           cache: 'npm' |           cache: "npm" | ||||||
|  |  | ||||||
|       - name: 'Install dependencies' |       - name: "Install dependencies" | ||||||
|         run: 'npm clean-install' |         run: "npm clean-install" | ||||||
|  |  | ||||||
|       - name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies' |       - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies" | ||||||
|         run: 'npm audit signatures' |         run: "npm audit signatures" | ||||||
|  |  | ||||||
|       - name: 'Release' |       - name: "Release" | ||||||
|         run: 'npm run release' |         run: "node --run release" | ||||||
|         env: |         env: | ||||||
|           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||||||
|           NPM_TOKEN: ${{ secrets.NPM_TOKEN }} |           NPM_TOKEN: ${{ secrets.NPM_TOKEN }} | ||||||
|   | |||||||
							
								
								
									
										24
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										24
									
								
								.github/workflows/test.yml
									
									
									
									
										vendored
									
									
								
							| @@ -1,25 +1,25 @@ | |||||||
| name: 'Test' | name: "Test" | ||||||
|  |  | ||||||
| on: | on: | ||||||
|   push: |   push: | ||||||
|     branches: [develop] |     branches: [develop] | ||||||
|   pull_request: |   pull_request: | ||||||
|     branches: [master, develop] |     branches: [main, develop] | ||||||
|  |  | ||||||
| jobs: | jobs: | ||||||
|   test: |   test: | ||||||
|     runs-on: 'ubuntu-latest' |     runs-on: "ubuntu-latest" | ||||||
|     steps: |     steps: | ||||||
|       - uses: 'actions/checkout@v3.5.3' |       - uses: "actions/checkout@v4.2.0" | ||||||
|  |  | ||||||
|       - name: 'Setup Node.js' |       - name: "Setup Node.js" | ||||||
|         uses: 'actions/setup-node@v3.6.0' |         uses: "actions/setup-node@v4.0.4" | ||||||
|         with: |         with: | ||||||
|           node-version: 'lts/*' |           node-version: "22.x" | ||||||
|           cache: 'npm' |           cache: "npm" | ||||||
|  |  | ||||||
|       - name: 'Install dependencies' |       - name: "Install dependencies" | ||||||
|         run: 'npm clean-install' |         run: "npm clean-install" | ||||||
|  |  | ||||||
|       - name: 'Test' |       - name: "Test" | ||||||
|         run: 'npm run test' |         run: "node --run test" | ||||||
|   | |||||||
| @@ -1,4 +0,0 @@ | |||||||
| #!/bin/sh |  | ||||||
| . "$(dirname "$0")/_/husky.sh" |  | ||||||
|  |  | ||||||
| npm run lint:commit -- --edit |  | ||||||
| @@ -1,5 +0,0 @@ | |||||||
| #!/bin/sh |  | ||||||
| . "$(dirname "$0")/_/husky.sh" |  | ||||||
|  |  | ||||||
| npm run lint:staged |  | ||||||
| npm run test |  | ||||||
| @@ -1,6 +0,0 @@ | |||||||
| { |  | ||||||
|   "*": ["editorconfig-checker"], |  | ||||||
|   "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"], |  | ||||||
|   "*.{json,jsonc,yml,yaml}": ["prettier --write"], |  | ||||||
|   "*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"] |  | ||||||
| } |  | ||||||
| @@ -1,11 +0,0 @@ | |||||||
| { |  | ||||||
|   "config": { |  | ||||||
|     "extends": "markdownlint/style/prettier", |  | ||||||
|     "relative-links": true, |  | ||||||
|     "default": true, |  | ||||||
|     "MD033": false |  | ||||||
|   }, |  | ||||||
|   "globs": ["**/*.{md,mdx}"], |  | ||||||
|   "ignores": ["**/node_modules"], |  | ||||||
|   "customRules": ["markdownlint-rule-relative-links"] |  | ||||||
| } |  | ||||||
							
								
								
									
										4
									
								
								.npmrc
									
									
									
									
									
								
							
							
						
						
									
										4
									
								
								.npmrc
									
									
									
									
									
								
							| @@ -1,2 +1,2 @@ | |||||||
| save-exact=true | save-exact = true | ||||||
| provenance=true | provenance = true | ||||||
|   | |||||||
| @@ -1,6 +1,3 @@ | |||||||
| { | { | ||||||
|   "singleQuote": true, |   "semi": false | ||||||
|   "jsxSingleQuote": true, |  | ||||||
|   "semi": false, |  | ||||||
|   "trailingComma": "none" |  | ||||||
| } | } | ||||||
|   | |||||||
| @@ -1,18 +1,8 @@ | |||||||
| { | { | ||||||
|   "branches": ["master"], |   "branches": ["main", { "name": "beta", "prerelease": true }], | ||||||
|   "plugins": [ |   "plugins": [ | ||||||
|     [ |     "@semantic-release/commit-analyzer", | ||||||
|       "@semantic-release/commit-analyzer", |     "@semantic-release/release-notes-generator", | ||||||
|       { |  | ||||||
|         "preset": "conventionalcommits" |  | ||||||
|       } |  | ||||||
|     ], |  | ||||||
|     [ |  | ||||||
|       "@semantic-release/release-notes-generator", |  | ||||||
|       { |  | ||||||
|         "preset": "conventionalcommits" |  | ||||||
|       } |  | ||||||
|     ], |  | ||||||
|     "@semantic-release/npm", |     "@semantic-release/npm", | ||||||
|     "@semantic-release/github" |     "@semantic-release/github" | ||||||
|   ] |   ] | ||||||
|   | |||||||
							
								
								
									
										8
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.vscode/extensions.json
									
									
									
									
										vendored
									
									
								
							| @@ -1,8 +0,0 @@ | |||||||
| { |  | ||||||
|   "recommendations": [ |  | ||||||
|     "editorconfig.editorconfig", |  | ||||||
|     "esbenp.prettier-vscode", |  | ||||||
|     "dbaeumer.vscode-eslint", |  | ||||||
|     "davidanson.vscode-markdownlint" |  | ||||||
|   ] |  | ||||||
| } |  | ||||||
							
								
								
									
										10
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										10
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							| @@ -1,10 +0,0 @@ | |||||||
| { |  | ||||||
|   "typescript.tsdk": "node_modules/typescript/lib", |  | ||||||
|   "typescript.preferences.importModuleSpecifierEnding": "js", |  | ||||||
|   "editor.defaultFormatter": "esbenp.prettier-vscode", |  | ||||||
|   "prettier.configPath": ".prettierrc.json", |  | ||||||
|   "editor.formatOnSave": true, |  | ||||||
|   "editor.codeActionsOnSave": { |  | ||||||
|     "source.fixAll": true |  | ||||||
|   } |  | ||||||
| } |  | ||||||
							
								
								
									
										4
									
								
								LICENSE
									
									
									
									
									
								
							
							
						
						
									
										4
									
								
								LICENSE
									
									
									
									
									
								
							| @@ -1,6 +1,6 @@ | |||||||
| MIT License | # MIT License | ||||||
|  |  | ||||||
| Copyright (c) Théo LUDWIG | Copyright (c) Théo LUDWIG <contact@theoludwig.fr> | ||||||
|  |  | ||||||
| Permission is hereby granted, free of charge, to any person obtaining a copy | Permission is hereby granted, free of charge, to any person obtaining a copy | ||||||
| of this software and associated documentation files (the "Software"), to deal | of this software and associated documentation files (the "Software"), to deal | ||||||
|   | |||||||
							
								
								
									
										98
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										98
									
								
								README.md
									
									
									
									
									
								
							| @@ -4,15 +4,13 @@ | |||||||
|   <strong><a href="https://eslint.org/docs/developer-guide/shareable-configs">ESLint shareable config</a> to enforce strict conventions and good code quality.</strong> |   <strong><a href="https://eslint.org/docs/developer-guide/shareable-configs">ESLint shareable config</a> to enforce strict conventions and good code quality.</strong> | ||||||
| </p> | </p> | ||||||
|  |  | ||||||
| </p> |  | ||||||
|  |  | ||||||
| <p align="center"> | <p align="center"> | ||||||
|   <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a> |   <a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="CONTRIBUTING" /></a> | ||||||
|   <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a> |   <a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a> | ||||||
|   <a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a> |   <a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a> | ||||||
|   <br /> |   <br /> | ||||||
|   <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" /></a> |   <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" alt="lint action" /></a> | ||||||
|   <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" /></a> |   <a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" alt="test action" /></a> | ||||||
|   <br /> |   <br /> | ||||||
|   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a> |   <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a> | ||||||
|   <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a> |   <a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a> | ||||||
| @@ -21,7 +19,7 @@ | |||||||
|  |  | ||||||
| ## 📜 About | ## 📜 About | ||||||
|  |  | ||||||
| **eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality, it is highly inspired from [eslint-config-standard-with-typescript](https://github.com/standard/eslint-config-standard-with-typescript) but it is **stricter** and with **no formatting rules**, **only code-quality rules**. 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**. | ||||||
|  |  | ||||||
| This configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration. | This configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration. | ||||||
|  |  | ||||||
| @@ -31,81 +29,67 @@ More information about **formatting rules** vs **code-quality rules** can be fou | |||||||
|  |  | ||||||
| ### Prerequisites | ### Prerequisites | ||||||
|  |  | ||||||
| - [Node.js](https://nodejs.org/) >= 16.0.0 | [Node.js](https://nodejs.org/) >= 20.11.0 | ||||||
|  |  | ||||||
| ### Installation | ### Installation | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| npm install --save-dev \ | npm install --save-dev \ | ||||||
|   eslint@^8.44.0 \ |   eslint@^9.12.0 \ | ||||||
|   eslint-plugin-import@^2.27.5 \ |   eslint-plugin-promise@^7.1.0 \ | ||||||
|   eslint-plugin-promise@^6.1.1 \ |   eslint-plugin-unicorn@^56.0.0 \ | ||||||
|   eslint-plugin-unicorn@^48.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 |   eslint-config-conventions@latest | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| This list of dependencies are: |  | ||||||
|  |  | ||||||
| - [ESLint](https://github.com/eslint/eslint) |  | ||||||
| - 3 [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins) |  | ||||||
|   - [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import) |  | ||||||
|   - [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise) |  | ||||||
|   - [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) |  | ||||||
| - This package: `eslint-config-conventions` |  | ||||||
|  |  | ||||||
| If you want to use **TypeScript**, you also need to install: |  | ||||||
|  |  | ||||||
| ```sh |  | ||||||
| npm install --save-dev \ |  | ||||||
|   typescript@^5.1.6 \ |  | ||||||
|   @typescript-eslint/eslint-plugin@^6.1.0 \ |  | ||||||
|   @typescript-eslint/parser@^6.1.0 |  | ||||||
| ``` |  | ||||||
|  |  | ||||||
| Dependencies are: | Dependencies are: | ||||||
|  |  | ||||||
|  | - [ESLint](https://github.com/eslint/eslint) | ||||||
|  | - [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins) | ||||||
|  |   - [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise) | ||||||
|  |   - [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn) | ||||||
|  |   - [eslint-plugin-import-x](https://github.com/un-ts/eslint-plugin-import-x) | ||||||
|  | - [globals](https://github.com/sindresorhus/globals) | ||||||
| - [TypeScript](https://github.com/Microsoft/TypeScript) | - [TypeScript](https://github.com/Microsoft/TypeScript) | ||||||
| - [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript. | - [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint): tooling which enables ESLint to support TypeScript. | ||||||
| - [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript. | - This package: `eslint-config-conventions` | ||||||
|  |  | ||||||
| ### Configuration with [Prettier](https://prettier.io/) (recommended) | ### Configuration | ||||||
|  |  | ||||||
| You will need to install some dependencies in addition to those required: | #### `eslint.config.js` (JavaScript and TypeScript) | ||||||
|  |  | ||||||
|  | ```js | ||||||
|  | // @ts-check | ||||||
|  |  | ||||||
|  | import typescriptESLint from "typescript-eslint" | ||||||
|  | import configConventions from "eslint-config-conventions" | ||||||
|  |  | ||||||
|  | export default typescriptESLint.config(...configConventions) | ||||||
|  | ``` | ||||||
|  |  | ||||||
|  | #### Configuration with [Prettier](https://prettier.io/) (recommended) | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier | npm install --save-dev prettier | ||||||
|  |  | ||||||
| # Create an empty config file to let editors and other tools know you are using Prettier | # Create an empty config file to let editors and other tools know you are using Prettier | ||||||
| # You can personalize it with your own rules | # You can personalize it with your own rules | ||||||
| echo "{}" > .prettierrc.json | echo "{}" > .prettierrc.json | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| #### `.eslintrc.json` | That's all! No need to update the `eslint.config.js` configuration. | ||||||
|  |  | ||||||
| ```json | We discourage usage of [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), as `eslint-config-conventions` doesn't include any stylistic rules, and including these packages has several drawbacks (listed in [Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html)) and brings no benefits for this configuration. | ||||||
| { |  | ||||||
|   "extends": ["conventions", "prettier"], |  | ||||||
|   "plugins": ["prettier"], |  | ||||||
|   "parser": "@typescript-eslint/parser", |  | ||||||
|   "parserOptions": { |  | ||||||
|     "project": "./tsconfig.json" |  | ||||||
|   }, |  | ||||||
|   "rules": { |  | ||||||
|     "prettier/prettier": "error" |  | ||||||
|   } |  | ||||||
| } |  | ||||||
| ``` |  | ||||||
|  |  | ||||||
| **Note:** Please read some important instructions regarding the `project` option [here](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#configuration). |  | ||||||
|  |  | ||||||
| `"parserOptions.project"` is only required if you use **TypeScript**. |  | ||||||
|  |  | ||||||
| #### `package.json` | #### `package.json` | ||||||
|  |  | ||||||
| ```jsonc | ```json | ||||||
| { | { | ||||||
|   "scripts": { |   "scripts": { | ||||||
|     "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore", |     "lint:eslint": "eslint . --max-warnings 0", | ||||||
|     "lint:prettier": "prettier . --check" |     "lint:prettier": "prettier . --check" | ||||||
|   } |   } | ||||||
| } | } | ||||||
| @@ -114,12 +98,12 @@ echo "{}" > .prettierrc.json | |||||||
| ### Usage | ### Usage | ||||||
|  |  | ||||||
| ```sh | ```sh | ||||||
| npm run lint:eslint | node --run lint:eslint | ||||||
| # or to apply automatic fixes to code | # or to apply automatic fixes to code | ||||||
| npm run lint:eslint -- --fix | node --run lint:eslint -- --fix | ||||||
|  |  | ||||||
| # Validate code formatting in all supported languages by Prettier | # Validate code formatting in all supported languages by Prettier | ||||||
| npm run lint:prettier | node --run lint:prettier | ||||||
| ``` | ``` | ||||||
|  |  | ||||||
| ## 💡 Contributing | ## 💡 Contributing | ||||||
|   | |||||||
							
								
								
									
										461
									
								
								eslint.config.js
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										461
									
								
								eslint.config.js
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,461 @@ | |||||||
|  | // @ts-check | ||||||
|  |  | ||||||
|  | import promise from "eslint-plugin-promise" | ||||||
|  | import unicorn from "eslint-plugin-unicorn" | ||||||
|  | import importX from "eslint-plugin-import-x" | ||||||
|  | import globals from "globals" | ||||||
|  | import typescriptESLint from "typescript-eslint" | ||||||
|  |  | ||||||
|  | export default typescriptESLint.config( | ||||||
|  |   { | ||||||
|  |     name: "eslint-config-conventions", | ||||||
|  |     plugins: { | ||||||
|  |       promise, | ||||||
|  |       unicorn, | ||||||
|  |       "import-x": importX, | ||||||
|  |     }, | ||||||
|  |     linterOptions: { | ||||||
|  |       reportUnusedDisableDirectives: "error", | ||||||
|  |     }, | ||||||
|  |     languageOptions: { | ||||||
|  |       globals: { | ||||||
|  |         ...globals.browser, | ||||||
|  |         ...globals.node, | ||||||
|  |       }, | ||||||
|  |       ecmaVersion: "latest", | ||||||
|  |       sourceType: "module", | ||||||
|  |       parserOptions: { | ||||||
|  |         ecmaFeatures: { | ||||||
|  |           jsx: true, | ||||||
|  |         }, | ||||||
|  |       }, | ||||||
|  |     }, | ||||||
|  |     rules: { | ||||||
|  |       "constructor-super": "error", | ||||||
|  |       "for-direction": "error", | ||||||
|  |       "getter-return": "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-args": "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-misleading-character-class": "error", | ||||||
|  |       "no-new-native-nonconstructor": "error", | ||||||
|  |       "no-obj-calls": "error", | ||||||
|  |       "no-promise-executor-return": "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-undef": "error", | ||||||
|  |       "no-unexpected-multiline": "error", | ||||||
|  |       "no-unmodified-loop-condition": "error", | ||||||
|  |       "no-unreachable": "error", | ||||||
|  |       "no-unreachable-loop": "error", | ||||||
|  |       "no-unsafe-finally": "error", | ||||||
|  |       "no-unsafe-negation": "error", | ||||||
|  |       "no-unsafe-optional-chaining": "error", | ||||||
|  |       "no-unused-private-class-members": "error", | ||||||
|  |       "no-unused-vars": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           varsIgnorePattern: "^_", | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "no-use-before-define": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           functions: false, | ||||||
|  |           classes: false, | ||||||
|  |           variables: false, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "no-useless-backreference": "error", | ||||||
|  |       "use-isnan": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           enforceForSwitchCase: true, | ||||||
|  |           enforceForIndexOf: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "valid-typeof": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           requireStringLiterals: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "consistent-this": "error", | ||||||
|  |       "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-empty": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           allowEmptyCatch: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "no-empty-static-block": "error", | ||||||
|  |       "no-eval": "error", | ||||||
|  |       "no-global-assign": "error", | ||||||
|  |       "no-implied-eval": "error", | ||||||
|  |       "no-multi-str": "error", | ||||||
|  |       "no-new-func": "error", | ||||||
|  |       "no-object-constructor": "error", | ||||||
|  |       "no-octal": "error", | ||||||
|  |       "no-octal-escape": "error", | ||||||
|  |       "no-proto": "error", | ||||||
|  |       "no-redeclare": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           builtinGlobals: false, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "no-regex-spaces": "error", | ||||||
|  |       "no-shadow-restricted-names": "error", | ||||||
|  |       "no-throw-literal": "error", | ||||||
|  |       "no-undef-init": "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-useless-return": "error", | ||||||
|  |       "no-else-return": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           allowElseIf: false, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "no-var": "error", | ||||||
|  |       "no-void": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           allowAsStatement: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "no-with": "error", | ||||||
|  |       "object-shorthand": ["error", "properties"], | ||||||
|  |       "one-var": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           initialized: "never", | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "prefer-const": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           destructuring: "all", | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       "prefer-object-has-own": "error", | ||||||
|  |       "prefer-promise-reject-errors": "error", | ||||||
|  |       "prefer-regex-literals": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           disallowRedundantWrapping: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |       radix: "error", | ||||||
|  |       yoda: ["error", "never"], | ||||||
|  |       curly: ["error", "all"], | ||||||
|  |       "func-style": ["error", "expression"], | ||||||
|  |       "prefer-arrow-callback": "error", | ||||||
|  |       "arrow-body-style": ["error", "always"], | ||||||
|  |  | ||||||
|  |       "promise/param-names": "error", | ||||||
|  |       "promise/no-new-statics": "error", | ||||||
|  |       "promise/no-multiple-resolved": "error", | ||||||
|  |       "promise/no-nesting": "error", | ||||||
|  |  | ||||||
|  |       "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", | ||||||
|  |       "unicorn/explicit-length-check": "error", | ||||||
|  |       "unicorn/new-for-builtins": "error", | ||||||
|  |       "unicorn/no-array-callback-reference": "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-array": "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/template-indent": "error", | ||||||
|  |  | ||||||
|  |       "import-x/no-absolute-path": "error", | ||||||
|  |       "import-x/no-webpack-loader-syntax": "error", | ||||||
|  |       "import-x/no-self-import": "error", | ||||||
|  |       "import-x/no-useless-path-segments": "error", | ||||||
|  |       "import-x/export": "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"], | ||||||
|  |     }, | ||||||
|  |   }, | ||||||
|  |   { | ||||||
|  |     name: "eslint-config-conventions/typescript", | ||||||
|  |     files: ["**/*.ts", "**/*.tsx"], | ||||||
|  |  | ||||||
|  |     plugins: { | ||||||
|  |       "@typescript-eslint": typescriptESLint.plugin, | ||||||
|  |     }, | ||||||
|  |  | ||||||
|  |     languageOptions: { | ||||||
|  |       parser: typescriptESLint.parser, | ||||||
|  |       parserOptions: { | ||||||
|  |         projectService: true, | ||||||
|  |         tsconfigRootDir: import.meta.dirname, | ||||||
|  |       }, | ||||||
|  |     }, | ||||||
|  |  | ||||||
|  |     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", | ||||||
|  |         { | ||||||
|  |           varsIgnorePattern: "^_", | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "no-use-before-define": "off", | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/no-use-before-define": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           functions: false, | ||||||
|  |           classes: false, | ||||||
|  |           enums: false, | ||||||
|  |           variables: false, | ||||||
|  |           typedefs: false, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "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", | ||||||
|  |         { | ||||||
|  |           builtinGlobals: false, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "no-throw-literal": "off", | ||||||
|  |       "@typescript-eslint/only-throw-error": "error", | ||||||
|  |       "no-unused-expressions": "off", | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/no-unused-expressions": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           allowShortCircuit: true, | ||||||
|  |           allowTernary: true, | ||||||
|  |           allowTaggedTemplates: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "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-function-return-type": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           allowExpressions: true, | ||||||
|  |           allowHigherOrderFunctions: true, | ||||||
|  |           allowTypedFunctionExpressions: true, | ||||||
|  |           allowDirectConstAssertionInArrowFunctions: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/method-signature-style": "error", | ||||||
|  |       "@typescript-eslint/unbound-method": "error", | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/naming-convention": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           selector: "variableLike", | ||||||
|  |           leadingUnderscore: "allow", | ||||||
|  |           trailingUnderscore: "allow", | ||||||
|  |           format: ["camelCase", "PascalCase", "UPPER_CASE"], | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "@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", | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/no-extraneous-class": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           allowWithDecorator: true, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "@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", | ||||||
|  |       "@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-find": "error", | ||||||
|  |       "@typescript-eslint/prefer-includes": "error", | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/prefer-nullish-coalescing": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           ignoreTernaryTests: true, | ||||||
|  |           ignoreConditionalTests: false, | ||||||
|  |           ignoreMixedLogicalExpressions: false, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/prefer-readonly": "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, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |  | ||||||
|  |       "@typescript-eslint/strict-boolean-expressions": [ | ||||||
|  |         "error", | ||||||
|  |         { | ||||||
|  |           allowString: false, | ||||||
|  |           allowNumber: false, | ||||||
|  |           allowNullableObject: false, | ||||||
|  |           allowNullableBoolean: false, | ||||||
|  |           allowNullableString: false, | ||||||
|  |           allowNullableNumber: false, | ||||||
|  |           allowAny: false, | ||||||
|  |         }, | ||||||
|  |       ], | ||||||
|  |     }, | ||||||
|  |   }, | ||||||
|  | ) | ||||||
							
								
								
									
										8
									
								
								eslint.config.mjs
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										8
									
								
								eslint.config.mjs
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,8 @@ | |||||||
|  | // @ts-check | ||||||
|  |  | ||||||
|  | import typescriptESLint from "typescript-eslint" | ||||||
|  | import configConventions from "./eslint.config.js" | ||||||
|  |  | ||||||
|  | export default typescriptESLint.config(...configConventions, { | ||||||
|  |   ignores: ["test/fixtures/*"], | ||||||
|  | }) | ||||||
| @@ -1,6 +0,0 @@ | |||||||
| { |  | ||||||
|   "extends": "./index.js", |  | ||||||
|   "parserOptions": { |  | ||||||
|     "project": "./tsconfig.json" |  | ||||||
|   } |  | ||||||
| } |  | ||||||
							
								
								
									
										7
									
								
								index.d.ts
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										7
									
								
								index.d.ts
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,7 @@ | |||||||
|  | import type typescriptESLint from "typescript-eslint" | ||||||
|  |  | ||||||
|  | declare const eslintConfigConventions: ReturnType< | ||||||
|  |   typeof typescriptESLint.config | ||||||
|  | > | ||||||
|  |  | ||||||
|  | export default eslintConfigConventions | ||||||
							
								
								
									
										9447
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										9447
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										66
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										66
									
								
								package.json
									
									
									
									
									
								
							| @@ -22,58 +22,48 @@ | |||||||
|     "code quality", |     "code quality", | ||||||
|     "conventions" |     "conventions" | ||||||
|   ], |   ], | ||||||
|   "main": "index.js", |   "main": "eslint.config.js", | ||||||
|  |   "types": "index.d.ts", | ||||||
|  |   "type": "module", | ||||||
|   "files": [ |   "files": [ | ||||||
|     "index.js", |     "eslint.config.js", | ||||||
|     ".eslintrc.json" |     "index.d.ts" | ||||||
|   ], |   ], | ||||||
|   "publishConfig": { |   "publishConfig": { | ||||||
|     "access": "public", |     "access": "public", | ||||||
|     "provenance": true |     "provenance": true | ||||||
|   }, |   }, | ||||||
|   "engines": { |   "engines": { | ||||||
|     "node": ">=16.0.0", |     "node": ">=20.11.0" | ||||||
|     "npm": ">=9.0.0" |  | ||||||
|   }, |   }, | ||||||
|   "scripts": { |   "scripts": { | ||||||
|     "lint:commit": "commitlint", |  | ||||||
|     "lint:editorconfig": "editorconfig-checker", |     "lint:editorconfig": "editorconfig-checker", | ||||||
|     "lint:markdown": "markdownlint-cli2", |     "lint:eslint": "eslint . --max-warnings 0 --config eslint.config.mjs", | ||||||
|     "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json", |  | ||||||
|     "lint:prettier": "prettier . --check", |     "lint:prettier": "prettier . --check", | ||||||
|     "lint:staged": "lint-staged", |     "inspect": "eslint --inspect-config", | ||||||
|     "test": "node --test test/", |     "test": "node --test", | ||||||
|     "release": "semantic-release", |     "release": "semantic-release" | ||||||
|     "postinstall": "husky install", |  | ||||||
|     "prepublishOnly": "pinst --disable", |  | ||||||
|     "postpublish": "pinst --enable" |  | ||||||
|   }, |   }, | ||||||
|   "peerDependencies": { |   "peerDependencies": { | ||||||
|     "eslint": "^8.44.0", |     "eslint": "^9.12.0", | ||||||
|     "eslint-plugin-import": "^2.27.5", |     "eslint-plugin-promise": "^7.1.0", | ||||||
|     "eslint-plugin-promise": "^6.1.1", |     "eslint-plugin-unicorn": "^56.0.0", | ||||||
|     "eslint-plugin-unicorn": "^48.0.0" |     "eslint-plugin-import-x": "^4.3.1", | ||||||
|  |     "globals": "^15.10.0", | ||||||
|  |     "typescript-eslint": "^8.8.0" | ||||||
|   }, |   }, | ||||||
|   "devDependencies": { |   "devDependencies": { | ||||||
|     "@commitlint/cli": "17.6.6", |     "@types/eslint__js": "8.42.3", | ||||||
|     "@commitlint/config-conventional": "17.6.6", |     "@types/node": "22.7.8", | ||||||
|     "@tsconfig/strictest": "2.0.1", |     "globals": "15.11.0", | ||||||
|     "@types/eslint": "8.44.0", |     "editorconfig-checker": "6.0.0", | ||||||
|     "@types/node": "20.4.2", |     "eslint": "9.13.0", | ||||||
|     "@typescript-eslint/eslint-plugin": "6.1.0", |     "eslint-plugin-promise": "7.1.0", | ||||||
|     "@typescript-eslint/parser": "6.1.0", |     "eslint-plugin-unicorn": "56.0.0", | ||||||
|     "editorconfig-checker": "5.1.1", |     "eslint-plugin-import-x": "4.3.1", | ||||||
|     "eslint": "8.45.0", |     "typescript-eslint": "8.11.0", | ||||||
|     "eslint-plugin-import": "2.27.5", |     "prettier": "3.3.3", | ||||||
|     "eslint-plugin-promise": "6.1.1", |     "semantic-release": "23.1.1", | ||||||
|     "eslint-plugin-unicorn": "48.0.0", |     "typescript": "5.6.3" | ||||||
|     "husky": "8.0.3", |  | ||||||
|     "lint-staged": "13.2.3", |  | ||||||
|     "markdownlint-cli2": "0.8.1", |  | ||||||
|     "markdownlint-rule-relative-links": "2.1.0", |  | ||||||
|     "pinst": "3.0.0", |  | ||||||
|     "prettier": "3.0.0", |  | ||||||
|     "semantic-release": "21.0.7", |  | ||||||
|     "typescript": "5.1.6" |  | ||||||
|   } |   } | ||||||
| } | } | ||||||
|   | |||||||
| @@ -1,20 +0,0 @@ | |||||||
| const test = require('node:test') |  | ||||||
| const assert = require('node:assert/strict') |  | ||||||
|  |  | ||||||
| const config = require('../index.js') |  | ||||||
|  |  | ||||||
| /** |  | ||||||
|  * @param {unknown} object |  | ||||||
|  * @returns {boolean} |  | ||||||
|  */ |  | ||||||
| const isObject = (object) => { |  | ||||||
|   return typeof object === 'object' && object !== null |  | ||||||
| } |  | ||||||
|  |  | ||||||
| test('test basic properties of config', async () => { |  | ||||||
|   assert.ok(isObject(config)) |  | ||||||
|   assert.ok(isObject(config.parserOptions)) |  | ||||||
|   assert.ok(isObject(config.env)) |  | ||||||
|   assert.ok(isObject(config.rules)) |  | ||||||
|   assert.ok(isObject(config.overrides)) |  | ||||||
| }) |  | ||||||
							
								
								
									
										2
									
								
								test/fixtures/javascript-with-errors.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								test/fixtures/javascript-with-errors.js
									
									
									
									
										vendored
									
									
								
							| @@ -1 +1 @@ | |||||||
| 'invalid eqeqeq' == 'invalid eqeqeq' | "invalid eqeqeq" == "invalid eqeqeq" | ||||||
|   | |||||||
							
								
								
									
										3
									
								
								test/fixtures/typescript-no-errors-ignore-promise.ts
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										3
									
								
								test/fixtures/typescript-no-errors-ignore-promise.ts
									
									
									
									
										vendored
									
									
										Normal file
									
								
							| @@ -0,0 +1,3 @@ | |||||||
|  | const returnsPromise = async (): Promise<void> => {} | ||||||
|  |  | ||||||
|  | void returnsPromise() | ||||||
| @@ -1,39 +1,77 @@ | |||||||
| const test = require('node:test') | import test from "node:test" | ||||||
| const assert = require('node:assert/strict') | import assert from "node:assert/strict" | ||||||
|  |  | ||||||
| const { ESLint } = require('eslint') | import { ESLint } from "eslint" | ||||||
|  |  | ||||||
| const eslint = new ESLint({ | const eslint = new ESLint() | ||||||
|   ignore: false, |  | ||||||
|   useEslintrc: false, |  | ||||||
|   overrideConfigFile: 'eslintrc.json' |  | ||||||
| }) |  | ||||||
|  |  | ||||||
| test('ensure we validate correctly JavaScript files', async () => { | test("ensure we validate correctly JavaScript files", async () => { | ||||||
|   const [noErrors] = await eslint.lintFiles( |   const [noErrors] = await eslint.lintFiles( | ||||||
|     'test/fixtures/javascript-no-errors.js' |     "test/fixtures/javascript-no-errors.js", | ||||||
|   ) |   ) | ||||||
|   const [withErrors] = await eslint.lintFiles( |   const [withErrors] = await eslint.lintFiles( | ||||||
|     'test/fixtures/javascript-with-errors.js' |     "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), | ||||||
|   ) |   ) | ||||||
|   assert.strictEqual(noErrors?.errorCount, 0) |  | ||||||
|   assert.strictEqual(withErrors?.errorCount, 3) |  | ||||||
| }) | }) | ||||||
|  |  | ||||||
| test('ensure we validate correctly TypeScript files', async () => { | 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( |   const [noErrors] = await eslint.lintFiles( | ||||||
|     'test/fixtures/typescript-no-errors.ts' |     "test/fixtures/typescript-no-errors.ts", | ||||||
|   ) |   ) | ||||||
|   const [withErrors] = await eslint.lintFiles( |   const [withErrors] = await eslint.lintFiles( | ||||||
|     'test/fixtures/javascript-with-errors.js' |     "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), | ||||||
|   ) |   ) | ||||||
|   assert.strictEqual(noErrors?.errorCount, 0) |  | ||||||
|   assert.strictEqual(withErrors?.errorCount, 3) |  | ||||||
| }) | }) | ||||||
|  |  | ||||||
| test('ensure we allow top-level await', async () => { | test("ensure we allow top-level await", async () => { | ||||||
|   const [lintResult] = await eslint.lintFiles( |   const [lintResult] = await eslint.lintFiles( | ||||||
|     'test/fixtures/top-level-await.mjs' |     "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), | ||||||
|   ) |   ) | ||||||
|   assert.strictEqual(lintResult?.errorCount, 0) |  | ||||||
| }) | }) | ||||||
|   | |||||||
| @@ -1,7 +1,7 @@ | |||||||
| { | { | ||||||
|   "extends": "@tsconfig/strictest/tsconfig.json", |  | ||||||
|   "compilerOptions": { |   "compilerOptions": { | ||||||
|     "resolveJsonModule": true, |     "resolveJsonModule": true, | ||||||
|  |     "strict": true, | ||||||
|     "target": "ESNext", |     "target": "ESNext", | ||||||
|     "module": "commonjs", |     "module": "commonjs", | ||||||
|     "lib": ["ESNext"], |     "lib": ["ESNext"], | ||||||
|   | |||||||
		Reference in New Issue
	
	Block a user