mirror of
				https://github.com/theoludwig/eslint-config-conventions.git
				synced 2025-11-04 00:18:57 +01:00 
			
		
		
		
	Compare commits
	
		
			80 Commits
		
	
	
		
			v3.0.0
			...
			31b226ffa4
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						
						
							
						
						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
	
				 | 
					
					
						|||
| 
						
						
							
						
						d149fdd6ab
	
				 | 
					
					
						|||
| 
						
						
							
						
						6345bddd38
	
				 | 
					
					
						|||
| 
						
						
							
						
						4e99d69598
	
				 | 
					
					
						|||
| 
						
						
							
						
						adf01e1e8c
	
				 | 
					
					
						|||
| 
						
						
							
						
						8bfeaadf32
	
				 | 
					
					
						|||
| 
						
						
							
						
						807c201955
	
				 | 
					
					
						|||
| 
						
						
							
						
						381f5cb9cf
	
				 | 
					
					
						|||
| 
						
						
							
						
						c431a208e9
	
				 | 
					
					
						|||
| 
						
						
							
						
						f622982fdb
	
				 | 
					
					
						|||
| 
						
						
							
						
						d59b088bff
	
				 | 
					
					
						|||
| 
						
						
							
						
						2fd4edbf5b
	
				 | 
					
					
						|||
| 
						
						
							
						
						8837b8737b
	
				 | 
					
					
						|||
| 
						
						
							
						
						cbbb8dfe28
	
				 | 
					
					
						|||
| 
						
						
							
						
						2fcede3f0a
	
				 | 
					
					
						|||
| 
						
						
							
						
						80c00f5fa8
	
				 | 
					
					
						|||
| 
						
						
							
						
						7f7ab46896
	
				 | 
					
					
						|||
| 
						
						
							
						
						eab075e291
	
				 | 
					
					
						|||
| 
						
						
							
						
						244b74679a
	
				 | 
					
					
						|||
| 
						
						
							
						
						07595ccb56
	
				 | 
					
					
						|||
| 
						
						
							
						
						d0e9004ce3
	
				 | 
					
					
						|||
| 
						
						
							
						
						1e29cef968
	
				 | 
					
					
						|||
| 
						
						
							
						
						f89c4415cf
	
				 | 
					
					
						|||
| 
						
						
							
						
						34ec74cff7
	
				 | 
					
					
						|||
| 
						
						
							
						
						f5a69d69f5
	
				 | 
					
					
						|||
| 
						
						
							
						
						e071e917f6
	
				 | 
					
					
						|||
| 
						
						
							
						
						528a31316d
	
				 | 
					
					
						|||
| 
						 | 
					b1bd574d42 | ||
| 
						 | 
					ca9b1db4bd | ||
| 
						 | 
					3222d42e67 | ||
| 
						 | 
					08602b1c53 | ||
| 
						 | 
					1779517f5c | ||
| 
						 | 
					81b37b523c | ||
| 
						 | 
					a95ac7ec8b | ||
| 
						 | 
					32481c316f | ||
| 
						 | 
					c3ddbc73b7 | ||
| 
						 | 
					1934d3525a | ||
| 
						 | 
					4f625c3b88 | ||
| 
						 | 
					e24964a60a | ||
| 
						 | 
					fcc107bdec | ||
| 
						 | 
					666a3dee2d | ||
| 
						 | 
					0ce46310ed | ||
| 
						 | 
					e2b2c1c77f | ||
| 
						 | 
					846a25943d | ||
| 
						 | 
					e0f93343fe | ||
| 
						 | 
					c3b46debe6 | ||
| 
						 | 
					c0ec89ed0c | ||
| 
						 | 
					099a3388a1 | ||
| 
						 | 
					1f20fe89e8 | ||
| 
						 | 
					3f1d1921ba | ||
| 
						 | 
					b743c94430 | ||
| 
						 | 
					f138acaf53 | ||
| 
						 | 
					435d3e9e5f | 
@@ -4,10 +4,10 @@
 | 
			
		||||
  "env": {
 | 
			
		||||
    "browser": true,
 | 
			
		||||
    "node": true,
 | 
			
		||||
    "es2022": true
 | 
			
		||||
    "es2024": true
 | 
			
		||||
  },
 | 
			
		||||
  "parserOptions": {
 | 
			
		||||
    "ecmaVersion": 2022,
 | 
			
		||||
    "ecmaVersion": "latest",
 | 
			
		||||
    "sourceType": "module",
 | 
			
		||||
    "ecmaFeatures": {
 | 
			
		||||
      "jsx": true
 | 
			
		||||
@@ -22,6 +22,7 @@
 | 
			
		||||
    "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",
 | 
			
		||||
@@ -42,6 +43,7 @@
 | 
			
		||||
    "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",
 | 
			
		||||
@@ -49,6 +51,7 @@
 | 
			
		||||
    "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",
 | 
			
		||||
@@ -59,7 +62,7 @@
 | 
			
		||||
    "no-unsafe-negation": "error",
 | 
			
		||||
    "no-unsafe-optional-chaining": "error",
 | 
			
		||||
    "no-unused-private-class-members": "error",
 | 
			
		||||
    "no-unused-vars": "error",
 | 
			
		||||
    "no-unused-vars": ["error", { "varsIgnorePattern": "^_" }],
 | 
			
		||||
    "no-use-before-define": [
 | 
			
		||||
      "error",
 | 
			
		||||
      {
 | 
			
		||||
@@ -93,6 +96,7 @@
 | 
			
		||||
    "no-confusing-arrow": "error",
 | 
			
		||||
    "no-delete-var": "error",
 | 
			
		||||
    "no-empty": ["error", { "allowEmptyCatch": true }],
 | 
			
		||||
    "no-empty-static-block": "error",
 | 
			
		||||
    "no-eval": "error",
 | 
			
		||||
    "no-floating-decimal": "error",
 | 
			
		||||
    "no-global-assign": "error",
 | 
			
		||||
@@ -110,7 +114,7 @@
 | 
			
		||||
    ],
 | 
			
		||||
    "no-multi-str": "error",
 | 
			
		||||
    "no-new-func": "error",
 | 
			
		||||
    "no-new-object": "error",
 | 
			
		||||
    "no-object-constructor": "error",
 | 
			
		||||
    "no-octal": "error",
 | 
			
		||||
    "no-octal-escape": "error",
 | 
			
		||||
    "no-proto": "error",
 | 
			
		||||
@@ -128,11 +132,13 @@
 | 
			
		||||
      }
 | 
			
		||||
    ],
 | 
			
		||||
    "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",
 | 
			
		||||
    "no-with": "error",
 | 
			
		||||
@@ -145,6 +151,11 @@
 | 
			
		||||
    "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",
 | 
			
		||||
@@ -161,22 +172,41 @@
 | 
			
		||||
      }
 | 
			
		||||
    ],
 | 
			
		||||
    "import/no-named-default": "error",
 | 
			
		||||
    "import/no-empty-named-blocks": "error",
 | 
			
		||||
    "import/no-anonymous-default-export": "error",
 | 
			
		||||
 | 
			
		||||
    "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/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": [
 | 
			
		||||
    {
 | 
			
		||||
@@ -187,12 +217,13 @@
 | 
			
		||||
        "no-undef": "off",
 | 
			
		||||
        "no-dupe-class-members": "off",
 | 
			
		||||
        "@typescript-eslint/no-dupe-class-members": "error",
 | 
			
		||||
        "no-duplicate-imports": "off",
 | 
			
		||||
        "@typescript-eslint/no-duplicate-imports": "error",
 | 
			
		||||
        "no-loss-of-precision": "off",
 | 
			
		||||
        "@typescript-eslint/no-loss-of-precision": "error",
 | 
			
		||||
        "no-unused-vars": "off",
 | 
			
		||||
        "@typescript-eslint/no-unused-vars": "error",
 | 
			
		||||
        "@typescript-eslint/no-unused-vars": [
 | 
			
		||||
          "error",
 | 
			
		||||
          { "varsIgnorePattern": "^_" }
 | 
			
		||||
        ],
 | 
			
		||||
        "no-use-before-define": "off",
 | 
			
		||||
        "@typescript-eslint/no-use-before-define": [
 | 
			
		||||
          "error",
 | 
			
		||||
@@ -230,23 +261,20 @@
 | 
			
		||||
        ],
 | 
			
		||||
        "no-useless-constructor": "off",
 | 
			
		||||
        "@typescript-eslint/no-useless-constructor": "error",
 | 
			
		||||
        "@typescript-eslint/no-useless-template-literals": "error",
 | 
			
		||||
 | 
			
		||||
        "@typescript-eslint/adjacent-overload-signatures": "error",
 | 
			
		||||
        "@typescript-eslint/array-type": [
 | 
			
		||||
          "error",
 | 
			
		||||
          { "default": "array-simple" }
 | 
			
		||||
        ],
 | 
			
		||||
        "@typescript-eslint/consistent-type-assertions": [
 | 
			
		||||
          "error",
 | 
			
		||||
          {
 | 
			
		||||
            "assertionStyle": "as",
 | 
			
		||||
            "objectLiteralTypeAssertions": "never"
 | 
			
		||||
          }
 | 
			
		||||
        ],
 | 
			
		||||
        "@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",
 | 
			
		||||
          {
 | 
			
		||||
@@ -275,10 +303,6 @@
 | 
			
		||||
        ],
 | 
			
		||||
        "@typescript-eslint/no-base-to-string": "error",
 | 
			
		||||
        "@typescript-eslint/no-dynamic-delete": "error",
 | 
			
		||||
        "@typescript-eslint/no-empty-interface": [
 | 
			
		||||
          "error",
 | 
			
		||||
          { "allowSingleExtends": true }
 | 
			
		||||
        ],
 | 
			
		||||
        "@typescript-eslint/no-extra-non-null-assertion": "error",
 | 
			
		||||
        "@typescript-eslint/no-extraneous-class": [
 | 
			
		||||
          "error",
 | 
			
		||||
@@ -297,27 +321,34 @@
 | 
			
		||||
        "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
 | 
			
		||||
        "@typescript-eslint/no-unnecessary-type-assertion": "error",
 | 
			
		||||
        "@typescript-eslint/no-var-requires": "error",
 | 
			
		||||
        "@typescript-eslint/no-require-imports": "error",
 | 
			
		||||
        "@typescript-eslint/no-unsafe-unary-minus": "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-optional-chain": "error",
 | 
			
		||||
        "@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",
 | 
			
		||||
        "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",
 | 
			
		||||
          { "checkCompoundAssignments": true }
 | 
			
		||||
          { "skipCompoundAssignments": true }
 | 
			
		||||
        ],
 | 
			
		||||
        "@typescript-eslint/restrict-template-expressions": [
 | 
			
		||||
          "error",
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/BUG.md
									
									
									
									
										vendored
									
									
								
							@@ -1,8 +1,8 @@
 | 
			
		||||
---
 | 
			
		||||
name: '🐛 Bug Report'
 | 
			
		||||
about: 'Report an unexpected problem or unintended behavior.'
 | 
			
		||||
title: '[Bug]'
 | 
			
		||||
labels: 'bug'
 | 
			
		||||
name: "🐛 Bug Report"
 | 
			
		||||
about: "Report an unexpected problem or unintended behavior."
 | 
			
		||||
title: "[Bug]"
 | 
			
		||||
labels: "bug"
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
<!--
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										8
									
								
								.github/ISSUE_TEMPLATE/DOCUMENTATION.md
									
									
									
									
										vendored
									
									
								
							@@ -1,8 +1,8 @@
 | 
			
		||||
---
 | 
			
		||||
name: '📜 Documentation'
 | 
			
		||||
about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
 | 
			
		||||
title: '[Documentation]'
 | 
			
		||||
labels: 'documentation'
 | 
			
		||||
name: "📜 Documentation"
 | 
			
		||||
about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
 | 
			
		||||
title: "[Documentation]"
 | 
			
		||||
labels: "documentation"
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
<!-- 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'
 | 
			
		||||
about: 'Suggest a new feature idea.'
 | 
			
		||||
title: '[Feature]'
 | 
			
		||||
labels: 'feature request'
 | 
			
		||||
name: "✨ Feature Request"
 | 
			
		||||
about: "Suggest a new feature idea."
 | 
			
		||||
title: "[Feature]"
 | 
			
		||||
labels: "feature request"
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
<!-- 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'
 | 
			
		||||
about: 'Improve structure/format/performance/refactor/tests of the code.'
 | 
			
		||||
title: '[Improvement]'
 | 
			
		||||
labels: 'improvement'
 | 
			
		||||
name: "🔧 Improvement"
 | 
			
		||||
about: "Improve structure/format/performance/refactor/tests of the code."
 | 
			
		||||
title: "[Improvement]"
 | 
			
		||||
labels: "improvement"
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
<!-- 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'
 | 
			
		||||
about: 'Further information is requested.'
 | 
			
		||||
title: '[Question]'
 | 
			
		||||
labels: 'question'
 | 
			
		||||
name: "🙋 Question"
 | 
			
		||||
about: "Further information is requested."
 | 
			
		||||
title: "[Question]"
 | 
			
		||||
labels: "question"
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
### Question
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/PULL_REQUEST_TEMPLATE.md
									
									
									
									
										vendored
									
									
								
							@@ -1,6 +1,6 @@
 | 
			
		||||
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
 | 
			
		||||
 | 
			
		||||
## What changes this PR introduce?
 | 
			
		||||
# What changes this PR introduce?
 | 
			
		||||
 | 
			
		||||
## List any relevant issue numbers
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										28
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										28
									
								
								.github/workflows/lint.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,28 +1,28 @@
 | 
			
		||||
name: 'Lint'
 | 
			
		||||
name: "Lint"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [develop]
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches: [master, develop]
 | 
			
		||||
    branches: [main, develop]
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  lint:
 | 
			
		||||
    runs-on: 'ubuntu-latest'
 | 
			
		||||
    runs-on: "ubuntu-latest"
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: 'actions/checkout@v3.0.0'
 | 
			
		||||
      - uses: "actions/checkout@v4.1.1"
 | 
			
		||||
 | 
			
		||||
      - name: 'Use Node.js'
 | 
			
		||||
        uses: 'actions/setup-node@v3.1.0'
 | 
			
		||||
      - name: "Setup Node.js"
 | 
			
		||||
        uses: "actions/setup-node@v4.0.1"
 | 
			
		||||
        with:
 | 
			
		||||
          node-version: 'lts/*'
 | 
			
		||||
          cache: 'npm'
 | 
			
		||||
          node-version: "lts/*"
 | 
			
		||||
          cache: "npm"
 | 
			
		||||
 | 
			
		||||
      - name: 'Install'
 | 
			
		||||
        run: 'npm install'
 | 
			
		||||
      - name: "Install dependencies"
 | 
			
		||||
        run: "npm clean-install"
 | 
			
		||||
 | 
			
		||||
      - run: 'npm run lint:commit -- --to "${{ github.sha }}"'
 | 
			
		||||
      - run: 'npm run lint:editorconfig'
 | 
			
		||||
      - run: 'npm run lint:markdown'
 | 
			
		||||
      - run: 'npm run lint:javascript'
 | 
			
		||||
      - run: 'npm run lint:prettier'
 | 
			
		||||
      - run: "npm run lint:editorconfig"
 | 
			
		||||
      - run: "npm run lint:markdown"
 | 
			
		||||
      - run: "npm run lint:eslint"
 | 
			
		||||
      - run: "npm run lint:prettier"
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										32
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										32
									
								
								.github/workflows/release.yml
									
									
									
									
										vendored
									
									
								
							@@ -1,29 +1,37 @@
 | 
			
		||||
name: 'Release'
 | 
			
		||||
name: "Release"
 | 
			
		||||
 | 
			
		||||
on:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [master]
 | 
			
		||||
    branches: [main]
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  release:
 | 
			
		||||
    runs-on: 'ubuntu-latest'
 | 
			
		||||
    runs-on: "ubuntu-latest"
 | 
			
		||||
    permissions:
 | 
			
		||||
      contents: "write"
 | 
			
		||||
      issues: "write"
 | 
			
		||||
      pull-requests: "write"
 | 
			
		||||
      id-token: "write"
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: 'actions/checkout@v3.0.0'
 | 
			
		||||
      - uses: "actions/checkout@v4.1.1"
 | 
			
		||||
        with:
 | 
			
		||||
          fetch-depth: 0
 | 
			
		||||
          persist-credentials: false
 | 
			
		||||
 | 
			
		||||
      - name: 'Use Node.js'
 | 
			
		||||
        uses: 'actions/setup-node@v3.1.0'
 | 
			
		||||
      - name: "Setup Node.js"
 | 
			
		||||
        uses: "actions/setup-node@v4.0.1"
 | 
			
		||||
        with:
 | 
			
		||||
          node-version: 'lts/*'
 | 
			
		||||
          cache: 'npm'
 | 
			
		||||
          node-version: "lts/*"
 | 
			
		||||
          cache: "npm"
 | 
			
		||||
 | 
			
		||||
      - name: 'Install'
 | 
			
		||||
        run: 'npm install'
 | 
			
		||||
      - name: "Install dependencies"
 | 
			
		||||
        run: "npm clean-install"
 | 
			
		||||
 | 
			
		||||
      - name: 'Release'
 | 
			
		||||
        run: 'npm run release'
 | 
			
		||||
      - name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
 | 
			
		||||
        run: "npm audit signatures"
 | 
			
		||||
 | 
			
		||||
      - name: "Release"
 | 
			
		||||
        run: "npm run release"
 | 
			
		||||
        env:
 | 
			
		||||
          GITHUB_TOKEN: ${{ secrets.GITHUB_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:
 | 
			
		||||
  push:
 | 
			
		||||
    branches: [develop]
 | 
			
		||||
  pull_request:
 | 
			
		||||
    branches: [master, develop]
 | 
			
		||||
    branches: [main, develop]
 | 
			
		||||
 | 
			
		||||
jobs:
 | 
			
		||||
  test:
 | 
			
		||||
    runs-on: 'ubuntu-latest'
 | 
			
		||||
    runs-on: "ubuntu-latest"
 | 
			
		||||
    steps:
 | 
			
		||||
      - uses: 'actions/checkout@v3.0.0'
 | 
			
		||||
      - uses: "actions/checkout@v4.1.1"
 | 
			
		||||
 | 
			
		||||
      - name: 'Use Node.js'
 | 
			
		||||
        uses: 'actions/setup-node@v3.1.0'
 | 
			
		||||
      - name: "Setup Node.js"
 | 
			
		||||
        uses: "actions/setup-node@v4.0.1"
 | 
			
		||||
        with:
 | 
			
		||||
          node-version: 'lts/*'
 | 
			
		||||
          cache: 'npm'
 | 
			
		||||
          node-version: "lts/*"
 | 
			
		||||
          cache: "npm"
 | 
			
		||||
 | 
			
		||||
      - name: 'Install'
 | 
			
		||||
        run: 'npm install'
 | 
			
		||||
      - name: "Install dependencies"
 | 
			
		||||
        run: "npm clean-install"
 | 
			
		||||
 | 
			
		||||
      - name: 'Test'
 | 
			
		||||
        run: 'npm run test'
 | 
			
		||||
      - name: "Test"
 | 
			
		||||
        run: "npm run test"
 | 
			
		||||
 
 | 
			
		||||
@@ -1,4 +1,3 @@
 | 
			
		||||
#!/bin/sh
 | 
			
		||||
. "$(dirname "$0")/_/husky.sh"
 | 
			
		||||
#!/usr/bin/env sh
 | 
			
		||||
 | 
			
		||||
npm run lint:commit -- --edit
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,4 @@
 | 
			
		||||
#!/bin/sh
 | 
			
		||||
. "$(dirname "$0")/_/husky.sh"
 | 
			
		||||
#!/usr/bin/env sh
 | 
			
		||||
 | 
			
		||||
npm run lint:staged
 | 
			
		||||
npm run test
 | 
			
		||||
 
 | 
			
		||||
@@ -1,6 +1,7 @@
 | 
			
		||||
{
 | 
			
		||||
  "*": ["editorconfig-checker"],
 | 
			
		||||
  "*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
 | 
			
		||||
  "*.{json,jsonc,yml,yaml}": ["prettier --write"],
 | 
			
		||||
  "*.{md,mdx}": ["prettier --write", "markdownlint --dot --fix"]
 | 
			
		||||
  "**/*": ["editorconfig-checker", "prettier --write --ignore-unknown"],
 | 
			
		||||
  "**/*.md": ["markdownlint-cli2 --fix --no-globs"],
 | 
			
		||||
  "**/*.{js,jsx,ts,tsx}": [
 | 
			
		||||
    "eslint --fix --max-warnings 0 --report-unused-disable-directives"
 | 
			
		||||
  ]
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										11
									
								
								.markdownlint-cli2.jsonc
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								.markdownlint-cli2.jsonc
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,11 @@
 | 
			
		||||
{
 | 
			
		||||
  "config": {
 | 
			
		||||
    "extends": "markdownlint/style/prettier",
 | 
			
		||||
    "default": true,
 | 
			
		||||
    "relative-links": true,
 | 
			
		||||
    "no-inline-html": false,
 | 
			
		||||
  },
 | 
			
		||||
  "globs": ["**/*.md"],
 | 
			
		||||
  "ignores": ["**/node_modules"],
 | 
			
		||||
  "customRules": ["markdownlint-rule-relative-links"],
 | 
			
		||||
}
 | 
			
		||||
@@ -1,6 +0,0 @@
 | 
			
		||||
{
 | 
			
		||||
  "default": true,
 | 
			
		||||
  "MD013": false,
 | 
			
		||||
  "MD033": false,
 | 
			
		||||
  "MD041": false
 | 
			
		||||
}
 | 
			
		||||
@@ -1,6 +1,3 @@
 | 
			
		||||
{
 | 
			
		||||
  "singleQuote": true,
 | 
			
		||||
  "jsxSingleQuote": true,
 | 
			
		||||
  "semi": false,
 | 
			
		||||
  "trailingComma": "none"
 | 
			
		||||
  "semi": false
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,5 +1,5 @@
 | 
			
		||||
{
 | 
			
		||||
  "branches": ["master"],
 | 
			
		||||
  "branches": ["main"],
 | 
			
		||||
  "plugins": [
 | 
			
		||||
    [
 | 
			
		||||
      "@semantic-release/commit-analyzer",
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										8
									
								
								.taprc
									
									
									
									
									
								
							
							
						
						
									
										8
									
								
								.taprc
									
									
									
									
									
								
							@@ -1,8 +0,0 @@
 | 
			
		||||
ts: false
 | 
			
		||||
jsx: false
 | 
			
		||||
flow: false
 | 
			
		||||
check-coverage: true
 | 
			
		||||
coverage: true
 | 
			
		||||
 | 
			
		||||
test-ignore:
 | 
			
		||||
  - 'test/fixtures'
 | 
			
		||||
							
								
								
									
										2
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.vscode/settings.json
									
									
									
									
										vendored
									
									
								
							@@ -5,6 +5,6 @@
 | 
			
		||||
  "prettier.configPath": ".prettierrc.json",
 | 
			
		||||
  "editor.formatOnSave": true,
 | 
			
		||||
  "editor.codeActionsOnSave": {
 | 
			
		||||
    "source.fixAll": true
 | 
			
		||||
    "source.fixAll": "explicit"
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -60,7 +60,7 @@ representative at an online or offline event.
 | 
			
		||||
 | 
			
		||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
 | 
			
		||||
reported to the community leaders responsible for enforcement at
 | 
			
		||||
contact@divlo.fr.
 | 
			
		||||
<contact@theoludwig.fr>.
 | 
			
		||||
All complaints will be reviewed and investigated promptly and fairly.
 | 
			
		||||
 | 
			
		||||
All community leaders are obligated to respect the privacy and security of the
 | 
			
		||||
 
 | 
			
		||||
@@ -2,6 +2,14 @@
 | 
			
		||||
 | 
			
		||||
Thanks a lot for your interest in contributing to **eslint-config-conventions**! 🎉
 | 
			
		||||
 | 
			
		||||
## Code of Conduct
 | 
			
		||||
 | 
			
		||||
**eslint-config-conventions** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
 | 
			
		||||
 | 
			
		||||
## Open Development
 | 
			
		||||
 | 
			
		||||
All work on **eslint-config-conventions** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
 | 
			
		||||
 | 
			
		||||
## Types of contributions
 | 
			
		||||
 | 
			
		||||
- Reporting a bug.
 | 
			
		||||
@@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **eslint-config-conventions**!
 | 
			
		||||
 | 
			
		||||
## Pull Requests
 | 
			
		||||
 | 
			
		||||
- **Please first discuss** the change you wish to make via [issue](https://github.com/Divlo/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
 | 
			
		||||
- **Please first discuss** the change you wish to make via [issue](https://github.com/theoludwig/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
 | 
			
		||||
 | 
			
		||||
- Ensure your code respect linting.
 | 
			
		||||
 | 
			
		||||
@@ -21,26 +29,4 @@ If you're adding new features to **eslint-config-conventions**, please include t
 | 
			
		||||
 | 
			
		||||
## Commits
 | 
			
		||||
 | 
			
		||||
The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
 | 
			
		||||
 | 
			
		||||
### Types
 | 
			
		||||
 | 
			
		||||
Types define which kind of changes you made to the project.
 | 
			
		||||
 | 
			
		||||
| Types    | Description                                                                                                  |
 | 
			
		||||
| -------- | ------------------------------------------------------------------------------------------------------------ |
 | 
			
		||||
| feat     | A new feature.                                                                                               |
 | 
			
		||||
| fix      | A bug fix.                                                                                                   |
 | 
			
		||||
| docs     | Documentation only changes.                                                                                  |
 | 
			
		||||
| style    | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).      |
 | 
			
		||||
| refactor | A code change that neither fixes a bug nor adds a feature.                                                   |
 | 
			
		||||
| perf     | A code change that improves performance.                                                                     |
 | 
			
		||||
| test     | Adding missing tests or correcting existing tests.                                                           |
 | 
			
		||||
| build    | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm).         |
 | 
			
		||||
| ci       | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
 | 
			
		||||
| chore    | Other changes that don't modify src or test files.                                                           |
 | 
			
		||||
| revert   | Reverts a previous commit.                                                                                   |
 | 
			
		||||
 | 
			
		||||
### Scopes
 | 
			
		||||
 | 
			
		||||
Scopes define what part of the code changed.
 | 
			
		||||
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										4
									
								
								LICENSE
									
									
									
									
									
								
							
							
						
						
									
										4
									
								
								LICENSE
									
									
									
									
									
								
							@@ -1,6 +1,6 @@
 | 
			
		||||
MIT License
 | 
			
		||||
# MIT License
 | 
			
		||||
 | 
			
		||||
Copyright (c) Divlo
 | 
			
		||||
Copyright (c) Théo LUDWIG <contact@theoludwig.fr>
 | 
			
		||||
 | 
			
		||||
Permission is hereby granted, free of charge, to any person obtaining a copy
 | 
			
		||||
of this software and associated documentation files (the "Software"), to deal
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										50
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										50
									
								
								README.md
									
									
									
									
									
								
							@@ -7,12 +7,12 @@
 | 
			
		||||
</p>
 | 
			
		||||
 | 
			
		||||
<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="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
 | 
			
		||||
  <br />
 | 
			
		||||
  <a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
 | 
			
		||||
  <a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.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" alt="test action" /></a>
 | 
			
		||||
  <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://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,9 +21,9 @@
 | 
			
		||||
 | 
			
		||||
## 📜 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 is highly inspired from [eslint-config-standard-with-typescript](https://github.com/mightyiam/eslint-config-standard-with-typescript) but it is **stricter** and with **no formatting rules**, **only code-quality rules**. It supports both **JavaScript** and **TypeScript**.
 | 
			
		||||
 | 
			
		||||
This configuration is mostly **for catching bugs** and **code-quality** so it is recommanded 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.
 | 
			
		||||
 | 
			
		||||
More information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html).
 | 
			
		||||
 | 
			
		||||
@@ -31,24 +31,19 @@ More information about **formatting rules** vs **code-quality rules** can be fou
 | 
			
		||||
 | 
			
		||||
### Prerequisites
 | 
			
		||||
 | 
			
		||||
- [Node.js](https://nodejs.org/) >= 16.0.0
 | 
			
		||||
[Node.js](https://nodejs.org/) >= 18.0.0
 | 
			
		||||
 | 
			
		||||
### Installation
 | 
			
		||||
 | 
			
		||||
`npm@<7` does not automatically install `peerDependencies`, so if that's what you're using, install them manually.
 | 
			
		||||
Here is an example, but use it only for reference, because your decisions regarding version ranges and range specifiers may vary.
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
npm install --save-dev \
 | 
			
		||||
  eslint@^8.9.0 \
 | 
			
		||||
  eslint-plugin-import@^2.26.0 \
 | 
			
		||||
  eslint-plugin-promise@^6.0.0 \
 | 
			
		||||
  eslint-plugin-unicorn@^43.0.0 \
 | 
			
		||||
  eslint@^8.56.0 \
 | 
			
		||||
  eslint-plugin-import@^2.29.1 \
 | 
			
		||||
  eslint-plugin-promise@^6.1.1 \
 | 
			
		||||
  eslint-plugin-unicorn@^51.0.1 \
 | 
			
		||||
  eslint-config-conventions@latest
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Yes, this is a large number of packages. This is due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
 | 
			
		||||
 | 
			
		||||
This list of dependencies are:
 | 
			
		||||
 | 
			
		||||
- [ESLint](https://github.com/eslint/eslint)
 | 
			
		||||
@@ -62,16 +57,16 @@ If you want to use **TypeScript**, you also need to install:
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
npm install --save-dev \
 | 
			
		||||
  typescript@^4.6.0 \
 | 
			
		||||
  @typescript-eslint/eslint-plugin@^5.18.0 \
 | 
			
		||||
  @typescript-eslint/parser@^5.18.0
 | 
			
		||||
  "typescript@^5.3.3" \
 | 
			
		||||
  "@typescript-eslint/eslint-plugin@>=6.21.0" \
 | 
			
		||||
  "@typescript-eslint/parser@>=6.21.0"
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
Dependencies are:
 | 
			
		||||
 | 
			
		||||
- [TypeScript](https://github.com/Microsoft/TypeScript)
 | 
			
		||||
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint); ESLint rules for TypeScript.
 | 
			
		||||
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint); ESLint parser for TypeScript.
 | 
			
		||||
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript.
 | 
			
		||||
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript.
 | 
			
		||||
 | 
			
		||||
### Configuration with [Prettier](https://prettier.io/) (recommended)
 | 
			
		||||
 | 
			
		||||
@@ -82,7 +77,7 @@ npm install --save-dev prettier eslint-config-prettier eslint-plugin-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
 | 
			
		||||
echo {}> .prettierrc.json
 | 
			
		||||
echo "{}" > .prettierrc.json
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
#### `.eslintrc.json`
 | 
			
		||||
@@ -91,6 +86,7 @@ echo {}> .prettierrc.json
 | 
			
		||||
{
 | 
			
		||||
  "extends": ["conventions", "prettier"],
 | 
			
		||||
  "plugins": ["prettier"],
 | 
			
		||||
  "parser": "@typescript-eslint/parser",
 | 
			
		||||
  "parserOptions": {
 | 
			
		||||
    "project": "./tsconfig.json"
 | 
			
		||||
  },
 | 
			
		||||
@@ -100,17 +96,17 @@ echo {}> .prettierrc.json
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
**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).
 | 
			
		||||
**Note:** Please read some important instructions regarding the `project` option [here](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/README.md#configuration).
 | 
			
		||||
 | 
			
		||||
`"parserOptions.project"` is only required if you use **TypeScript**.
 | 
			
		||||
 | 
			
		||||
#### `package.json`
 | 
			
		||||
 | 
			
		||||
```jsonc
 | 
			
		||||
```json
 | 
			
		||||
{
 | 
			
		||||
  "scripts": {
 | 
			
		||||
    "lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
 | 
			
		||||
    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\""
 | 
			
		||||
    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
 | 
			
		||||
    "lint:prettier": "prettier . --check"
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
@@ -118,9 +114,9 @@ echo {}> .prettierrc.json
 | 
			
		||||
### Usage
 | 
			
		||||
 | 
			
		||||
```sh
 | 
			
		||||
npm run lint:typescript
 | 
			
		||||
npm run lint:eslint
 | 
			
		||||
# or to apply automatic fixes to code
 | 
			
		||||
npm run lint:typescript -- --fix
 | 
			
		||||
npm run lint:eslint -- --fix
 | 
			
		||||
 | 
			
		||||
# Validate code formatting in all supported languages by Prettier
 | 
			
		||||
npm run lint:prettier
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								index.js
									
									
									
									
									
								
							
							
						
						
									
										2
									
								
								index.js
									
									
									
									
									
								
							@@ -1 +1 @@
 | 
			
		||||
module.exports = require('./.eslintrc.json')
 | 
			
		||||
module.exports = require("./.eslintrc.json")
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										20683
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										20683
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							
							
								
								
									
										75
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										75
									
								
								package.json
									
									
									
									
									
								
							@@ -3,16 +3,16 @@
 | 
			
		||||
  "version": "0.0.0-development",
 | 
			
		||||
  "public": true,
 | 
			
		||||
  "description": "ESLint shareable config to enforce strict conventions and good code quality.",
 | 
			
		||||
  "author": "Divlo <contact@divlo.fr>",
 | 
			
		||||
  "author": "Théo LUDWIG <contact@theoludwig.fr>",
 | 
			
		||||
  "license": "MIT",
 | 
			
		||||
  "repository": {
 | 
			
		||||
    "type": "git",
 | 
			
		||||
    "url": "https://github.com/Divlo/eslint-config-conventions.git"
 | 
			
		||||
    "url": "https://github.com/theoludwig/eslint-config-conventions.git"
 | 
			
		||||
  },
 | 
			
		||||
  "bugs": {
 | 
			
		||||
    "url": "https://github.com/Divlo/eslint-config-conventions/issues"
 | 
			
		||||
    "url": "https://github.com/theoludwig/eslint-config-conventions/issues"
 | 
			
		||||
  },
 | 
			
		||||
  "homepage": "https://github.com/Divlo/eslint-config-conventions#readme",
 | 
			
		||||
  "homepage": "https://github.com/theoludwig/eslint-config-conventions#readme",
 | 
			
		||||
  "keywords": [
 | 
			
		||||
    "eslintconfig",
 | 
			
		||||
    "eslint",
 | 
			
		||||
@@ -23,48 +23,57 @@
 | 
			
		||||
    "conventions"
 | 
			
		||||
  ],
 | 
			
		||||
  "main": "index.js",
 | 
			
		||||
  "files": [
 | 
			
		||||
    "index.js",
 | 
			
		||||
    ".eslintrc.json"
 | 
			
		||||
  ],
 | 
			
		||||
  "publishConfig": {
 | 
			
		||||
    "access": "public",
 | 
			
		||||
    "provenance": true
 | 
			
		||||
  },
 | 
			
		||||
  "engines": {
 | 
			
		||||
    "node": ">=16.0.0",
 | 
			
		||||
    "npm": ">=8.0.0"
 | 
			
		||||
    "node": ">=18.0.0",
 | 
			
		||||
    "npm": ">=10.0.0"
 | 
			
		||||
  },
 | 
			
		||||
  "scripts": {
 | 
			
		||||
    "lint:commit": "commitlint",
 | 
			
		||||
    "lint:editorconfig": "editorconfig-checker",
 | 
			
		||||
    "lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
 | 
			
		||||
    "lint:javascript": "eslint \"**/*.{js,jsx,ts,tsx}\" -c \"eslintrc.json\"",
 | 
			
		||||
    "lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
 | 
			
		||||
    "lint:markdown": "markdownlint-cli2",
 | 
			
		||||
    "lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
 | 
			
		||||
    "lint:prettier": "prettier . --check",
 | 
			
		||||
    "lint:staged": "lint-staged",
 | 
			
		||||
    "test": "tap",
 | 
			
		||||
    "test": "node --test",
 | 
			
		||||
    "release": "semantic-release",
 | 
			
		||||
    "postinstall": "husky install",
 | 
			
		||||
    "postinstall": "husky",
 | 
			
		||||
    "prepublishOnly": "pinst --disable",
 | 
			
		||||
    "postpublish": "pinst --enable"
 | 
			
		||||
  },
 | 
			
		||||
  "peerDependencies": {
 | 
			
		||||
    "eslint": "^8.9.0",
 | 
			
		||||
    "eslint-plugin-import": "^2.26.0",
 | 
			
		||||
    "eslint-plugin-promise": "^6.0.0",
 | 
			
		||||
    "eslint-plugin-unicorn": "^43.0.0"
 | 
			
		||||
    "eslint": "^8.56.0",
 | 
			
		||||
    "eslint-plugin-import": "^2.29.1",
 | 
			
		||||
    "eslint-plugin-promise": "^6.1.1",
 | 
			
		||||
    "eslint-plugin-unicorn": "^51.0.1"
 | 
			
		||||
  },
 | 
			
		||||
  "devDependencies": {
 | 
			
		||||
    "@commitlint/cli": "17.0.3",
 | 
			
		||||
    "@commitlint/config-conventional": "17.0.3",
 | 
			
		||||
    "@types/eslint": "8.4.5",
 | 
			
		||||
    "@types/tap": "15.0.7",
 | 
			
		||||
    "@typescript-eslint/eslint-plugin": "5.30.6",
 | 
			
		||||
    "@typescript-eslint/parser": "5.30.6",
 | 
			
		||||
    "editorconfig-checker": "4.0.2",
 | 
			
		||||
    "eslint": "8.19.0",
 | 
			
		||||
    "eslint-plugin-import": "2.26.0",
 | 
			
		||||
    "eslint-plugin-promise": "6.0.0",
 | 
			
		||||
    "eslint-plugin-unicorn": "43.0.1",
 | 
			
		||||
    "husky": "8.0.1",
 | 
			
		||||
    "lint-staged": "13.0.3",
 | 
			
		||||
    "markdownlint-cli": "0.31.1",
 | 
			
		||||
    "@commitlint/cli": "18.6.1",
 | 
			
		||||
    "@commitlint/config-conventional": "18.6.2",
 | 
			
		||||
    "@tsconfig/strictest": "2.0.3",
 | 
			
		||||
    "@types/eslint": "8.56.2",
 | 
			
		||||
    "@types/node": "20.11.19",
 | 
			
		||||
    "@typescript-eslint/eslint-plugin": "7.0.1",
 | 
			
		||||
    "@typescript-eslint/parser": "7.0.1",
 | 
			
		||||
    "editorconfig-checker": "5.1.4",
 | 
			
		||||
    "eslint": "8.56.0",
 | 
			
		||||
    "eslint-plugin-import": "2.29.1",
 | 
			
		||||
    "eslint-plugin-promise": "6.1.1",
 | 
			
		||||
    "eslint-plugin-unicorn": "51.0.1",
 | 
			
		||||
    "husky": "9.0.11",
 | 
			
		||||
    "lint-staged": "15.2.2",
 | 
			
		||||
    "markdownlint-cli2": "0.12.1",
 | 
			
		||||
    "markdownlint-rule-relative-links": "2.3.1",
 | 
			
		||||
    "pinst": "3.0.0",
 | 
			
		||||
    "prettier": "2.7.1",
 | 
			
		||||
    "semantic-release": "19.0.3",
 | 
			
		||||
    "tap": "16.3.0",
 | 
			
		||||
    "typescript": "4.7.4"
 | 
			
		||||
    "prettier": "3.2.5",
 | 
			
		||||
    "semantic-release": "23.0.2",
 | 
			
		||||
    "typescript": "5.3.3"
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,14 +1,20 @@
 | 
			
		||||
const tap = require('tap')
 | 
			
		||||
const test = require("node:test")
 | 
			
		||||
const assert = require("node:assert/strict")
 | 
			
		||||
 | 
			
		||||
const config = require('../index.js')
 | 
			
		||||
const config = require("../index.js")
 | 
			
		||||
 | 
			
		||||
tap.test('test basic properties of config', async (t) => {
 | 
			
		||||
  t.ok(isObject(config.parserOptions))
 | 
			
		||||
  t.ok(isObject(config.env))
 | 
			
		||||
  t.ok(isObject(config.rules))
 | 
			
		||||
  t.ok(isObject(config.overrides))
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
function isObject(object) {
 | 
			
		||||
  return typeof object === 'object' && object !== null
 | 
			
		||||
/**
 | 
			
		||||
 * @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"
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								test/fixtures/top-level-await.mjs
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								test/fixtures/top-level-await.mjs
									
									
									
									
										vendored
									
									
								
							@@ -1,3 +1,3 @@
 | 
			
		||||
const foo = await 1
 | 
			
		||||
const bar = function () {}
 | 
			
		||||
const bar = () => {}
 | 
			
		||||
await bar(foo)
 | 
			
		||||
 
 | 
			
		||||
@@ -1,37 +1,39 @@
 | 
			
		||||
const { ESLint } = require('eslint')
 | 
			
		||||
const tap = require('tap')
 | 
			
		||||
const test = require("node:test")
 | 
			
		||||
const assert = require("node:assert/strict")
 | 
			
		||||
 | 
			
		||||
const { ESLint } = require("eslint")
 | 
			
		||||
 | 
			
		||||
const eslint = new ESLint({
 | 
			
		||||
  ignore: false,
 | 
			
		||||
  useEslintrc: false,
 | 
			
		||||
  overrideConfigFile: 'eslintrc.json'
 | 
			
		||||
  overrideConfigFile: "eslintrc.json",
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
tap.test('ensure we validate correctly JavaScript files', async (t) => {
 | 
			
		||||
test("ensure we validate correctly JavaScript files", async () => {
 | 
			
		||||
  const [noErrors] = await eslint.lintFiles(
 | 
			
		||||
    'test/fixtures/javascript-no-errors.js'
 | 
			
		||||
    "test/fixtures/javascript-no-errors.js",
 | 
			
		||||
  )
 | 
			
		||||
  const [withErrors] = await eslint.lintFiles(
 | 
			
		||||
    'test/fixtures/javascript-with-errors.js'
 | 
			
		||||
    "test/fixtures/javascript-with-errors.js",
 | 
			
		||||
  )
 | 
			
		||||
  t.equal(noErrors.errorCount, 0)
 | 
			
		||||
  t.equal(withErrors.errorCount, 3)
 | 
			
		||||
  assert.strictEqual(noErrors?.errorCount, 0)
 | 
			
		||||
  assert.strictEqual(withErrors?.errorCount, 3)
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
tap.test('ensure we validate correctly TypeScript files', async (t) => {
 | 
			
		||||
test("ensure we validate correctly TypeScript files", async () => {
 | 
			
		||||
  const [noErrors] = await eslint.lintFiles(
 | 
			
		||||
    'test/fixtures/typescript-no-errors.ts'
 | 
			
		||||
    "test/fixtures/typescript-no-errors.ts",
 | 
			
		||||
  )
 | 
			
		||||
  const [withErrors] = await eslint.lintFiles(
 | 
			
		||||
    'test/fixtures/javascript-with-errors.js'
 | 
			
		||||
    "test/fixtures/javascript-with-errors.js",
 | 
			
		||||
  )
 | 
			
		||||
  t.equal(noErrors.errorCount, 0)
 | 
			
		||||
  t.equal(withErrors.errorCount, 3)
 | 
			
		||||
  assert.strictEqual(noErrors?.errorCount, 0)
 | 
			
		||||
  assert.strictEqual(withErrors?.errorCount, 3)
 | 
			
		||||
})
 | 
			
		||||
 | 
			
		||||
tap.test('ensure we allow top-level await', async (t) => {
 | 
			
		||||
test("ensure we allow top-level await", async () => {
 | 
			
		||||
  const [lintResult] = await eslint.lintFiles(
 | 
			
		||||
    'test/fixtures/top-level-await.mjs'
 | 
			
		||||
    "test/fixtures/top-level-await.mjs",
 | 
			
		||||
  )
 | 
			
		||||
  t.equal(lintResult.errorCount, 0)
 | 
			
		||||
  assert.strictEqual(lintResult?.errorCount, 0)
 | 
			
		||||
})
 | 
			
		||||
 
 | 
			
		||||
@@ -1,12 +1,11 @@
 | 
			
		||||
{
 | 
			
		||||
  "extends": "@tsconfig/strictest/tsconfig.json",
 | 
			
		||||
  "compilerOptions": {
 | 
			
		||||
    "resolveJsonModule": true,
 | 
			
		||||
    "target": "ESNext",
 | 
			
		||||
    "module": "commonjs",
 | 
			
		||||
    "lib": ["ESNext"],
 | 
			
		||||
    "moduleResolution": "node",
 | 
			
		||||
    "rootDir": "./",
 | 
			
		||||
    "strict": true,
 | 
			
		||||
    "skipLibCheck": true,
 | 
			
		||||
    "esModuleInterop": true
 | 
			
		||||
    "rootDir": "./"
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user