@josundt/eslint-config 4.3.3 → 4.6.1

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@josundt/eslint-config",
-  "version": "4.3.3",
+  "version": "4.6.1",
   "description": "ESLint ruleset with required plugins for josundt TypeScript projects",
-  "main": ".eslintrc.js",
+  "main": "index.js",
   "scripts": {
     "lint": "echo \"No linting for this project\"",
     "build": "echo \"No build for this project\"",
@@ -26,17 +26,17 @@
     "rules/**/*.js"
   ],
   "peerDependencies": {
-    "typescript": ">=4.3.2"
+    "typescript": ">=4.6.2"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "4.25.0",
-    "@typescript-eslint/parser": "4.25.0",
-    "eslint": "7.27.0",
-    "eslint-import-resolver-typescript": "2.4.0",
-    "eslint-plugin-deprecation": "1.2.1",
-    "eslint-plugin-import": "2.23.3",
-    "eslint-plugin-jasmine": "4.1.2",
-    "eslint-plugin-jsdoc": "35.0.0",
-    "eslint-plugin-unicorn": "32.0.1"
+    "@typescript-eslint/eslint-plugin": "5.14.0",
+    "@typescript-eslint/parser": "5.14.0",
+    "eslint": "8.10.0",
+    "eslint-import-resolver-typescript": "2.5.0",
+    "eslint-plugin-deprecation": "1.3.2",
+    "eslint-plugin-import": "2.25.4",
+    "eslint-plugin-jasmine": "4.1.3",
+    "eslint-plugin-jsdoc": "37.9.7",
+    "eslint-plugin-unicorn": "41.0.0"
   }
 }

package/rules/eslint.js

@@ -61,7 +61,7 @@ module.exports = {
         ],
         "guard-for-in": "error",
         "handle-callback-err": "error",
-        "id-blacklist": [
+        "id-denylist": [
             "error",
             "any",
             "Number",
@@ -86,7 +86,14 @@ module.exports = {
                 "FunctionExpression": {
                     "parameters": "first"
                 },
-                "SwitchCase": 1
+                "SwitchCase": 1,
+
+                // Fix to decorator indentation problem
+                "ignoredNodes": [
+                    "FunctionExpression > .params[decorators.length > 0]",
+                    "FunctionExpression > .params > :matches(Decorator, :not(:first-child))",
+                    "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
+                ]
             }
         ],
         "init-declarations": "off",
@@ -236,12 +243,17 @@ module.exports = {
             "never"
         ],
         "padding-line-between-statements": [
-            "off",
-            {
-                "blankLine": "always",
-                "prev": "*",
-                "next": "return"
-            }
+            "error",
+            { "blankLine": "always", "prev": ["directive", "import"],                 "next": "*" },
+            { "blankLine": "any",    "prev": ["directive", "import"],                 "next": ["directive", "import"] },
+
+            { "blankLine": "always", "prev": "*",                                     "next": ["export", "class", "function", "iife"] },
+            { "blankLine": "always", "prev": ["export", "class", "function", "iife"], "next": "*" },
+
+            // { "blankLine": "always", "prev": "*",                                     "next": "return" }, // Newline before return
+
+            // { "blankLine": "always", "prev": "*",                                     "next": "multiline-block-like" }, // Newline BEFORE multiline block
+            // { "blankLine": "always", "prev": "multiline-block-like",                  "next": "*" }                     // Newline AFTER  multiline block
         ],
         "prefer-arrow-callback": "error",
         "prefer-const": "error",
@@ -262,8 +274,12 @@ module.exports = {
             "error",
             "always"
         ],
+        "space-before-blocks": [
+            "error",
+            "always"
+        ],
         "space-before-function-paren": [
-            "warn",
+            "error",
             {
                 "anonymous": "always",
                 "asyncArrow": "always",

package/rules/typescript-eslint.js

@@ -2,8 +2,13 @@ const eslintRuleSet = require("./eslint");
 const eslintRules = eslintRuleSet.rules;
 
 // Map of all the typescript-eslint extensions.
-// If extension rule has additional properties compared to standard eslint rule,
-// the value of the map item has an object that will be merged with standard rule; otherwise null.
+// If extension rule has additional properties compared to standard eslint rule:
+// If the map value is an object:
+//     The object will be merged merged with standard rule (rule object 1);
+// If the map value is an array:
+//     The items of the array will be added as a new rule options object.
+// If the map value is a function:
+//     The standard eslint options object will be passed as parameters, the return statement will be added as options.
 const extensions = new Map([
     ["brace-style", null],
     ["comma-dangle", null],
@@ -31,19 +36,29 @@ const extensions = new Map([
     ["no-loop-func", null],
     ["no-loss-of-precision", null],
     ["no-magic-numbers", null],
-    ["no-shadow", {
-        "ignoreTypeValueShadow": true,
-        "ignoreFunctionTypeParameterNameValueShadow": true
+    ["no-shadow", v => {
+        const o = {
+            ...v,
+            "ignoreTypeValueShadow": true,
+            "ignoreFunctionTypeParameterNameValueShadow": true
+        };
+        delete o["ignoreOnInitialization"]; // Temporary bug in @typescript/eslint "no-shadow" extension rule - "ignoreOnInitialization" property considered invalid
+        return o;
     }],
     ["no-unused-expressions", null],
     ["no-unused-vars", null],
     ["no-use-before-define", null],
     ["no-useless-constructor", null],
     ["object-curly-spacing", null],
+    ["padding-line-between-statements", [
+        { "blankLine": "always", "prev": "*", "next": ["interface", "type"] },
+        { "blankLine": "always", "prev": ["interface", "type"], "next": "*" }
+    ]],
     ["quotes", null],
     ["require-await", null],
     ["return-await", null],
     ["semi", null],
+    ["space-before-blocks", null],
     ["space-before-function-paren", null],
     ["space-infix-ops", null]
 ]);
@@ -74,7 +89,13 @@ const extendedEslintRules = Object.entries(eslintRules).reduce((extRules, [key,
             // If extension rule has extended options, merge with standard eslint rule options:
             if (extension !== null) {
                 value = [...value];
-                value[value.length - 1] = { ...value[value.length - 1], ...extension }
+                if (Array.isArray(extension)) {
+                    value.push(...extension);
+                } else if (typeof extension === "object") {
+                    value[value.length - 1] = { ...value[value.length - 1], ...extension }
+                } else if (typeof extension === "function") {
+                    value[value.length - 1] = { ...extension(value[value.length - 1]) };
+                }
             }
             // Add extension rule value with the @typescript-eslint key prefix
             extRules[`@typescript-eslint/${key}`] = value;
@@ -132,6 +153,7 @@ module.exports = {
             "error",
             "interface"
         ],
+        "@typescript-eslint/consistent-type-exports": "error",
         "@typescript-eslint/consistent-type-imports": [
             "off",
             {
@@ -145,7 +167,8 @@ module.exports = {
                 "allowExpressions": true,
                 "allowTypedFunctionExpressions": true,
                 "allowHigherOrderFunctions": true,
-                "allowConciseArrowFunctionExpressionsStartingWithVoid": true
+                "allowConciseArrowFunctionExpressionsStartingWithVoid": true,
+                "allowedNames": []
             }
         ],
         "@typescript-eslint/explicit-member-accessibility": [
@@ -159,9 +182,9 @@ module.exports = {
             {
                 "allowArgumentsExplicitlyTypedAsAny": false,
                 "allowDirectConstAssertionInArrowFunctions": true,
-                "allowedNames": [],
                 "allowHigherOrderFunctions": true,
                 "allowTypedFunctionExpressions": true,
+                "allowedNames": []
             }
         ],
         "@typescript-eslint/member-delimiter-style": [
@@ -249,9 +272,23 @@ module.exports = {
                 "allowAsThisParameter": true
             }
         ],
+        "@typescript-eslint/no-meaningless-void-operator": "error",
         "@typescript-eslint/no-misused-new": "error",
-        "@typescript-eslint/no-misused-promises": "error",
+        "@typescript-eslint/no-misused-promises": [
+            "error",
+            {
+                checksConditionals: true,
+                checksVoidReturn: true // {
+                //     arguments: true, //Disables checking an asynchronous function passed as argument where the parameter type expects a function that returns void
+                //     attributes: true, //Disables checking an asynchronous function passed as a JSX attribute expected to be a function that returns void
+                //     properties: true, //Disables checking an asynchronous function passed as an object property expected to be a function that returns void
+                //     returns: true, //Disables checking an asynchronous function returned in a function whose return type is a function that returns void
+                //     variables: true //Disables checking an asynchronous function used as a variable whose return type is a function that returns void
+                // }
+            }
+        ],
         "@typescript-eslint/no-namespace": "off",
+        "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "error",
         "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
         "@typescript-eslint/no-non-null-assertion": "off",
         "@typescript-eslint/no-parameter-properties": [
@@ -260,9 +297,16 @@ module.exports = {
                 "allows": ["private readonly", "private", "protected readonly"]
             }
         ],
+        "@typescript-eslint/no-redundant-type-constituents": "error",
         "@typescript-eslint/no-require-imports": "error",
         "@typescript-eslint/no-this-alias": "error",
-        "@typescript-eslint/no-throw-literal": "error",
+        "@typescript-eslint/no-throw-literal": [
+            "error",
+            {
+                "allowThrowingAny": false, // Default is to allow throwing values of type any
+                "allowThrowingUnknown": true // Default is to allow throwing values of type unknown
+            }
+        ],
         "@typescript-eslint/no-type-alias": "off",
         "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
         "@typescript-eslint/no-unnecessary-condition": "off", // allow runtime null checks etc even if reported not necessary by type system
@@ -276,6 +320,7 @@ module.exports = {
         "@typescript-eslint/no-unsafe-member-access": "error",
         "@typescript-eslint/no-unsafe-return": "error",
         "@typescript-eslint/no-unused-vars-experimental": "off", // to strict with method params...
+        "@typescript-eslint/no-useless-empty-export": "error",
         "@typescript-eslint/no-var-requires": "error",
         "@typescript-eslint/non-nullable-type-assertion-style": "error",
         "@typescript-eslint/prefer-as-const": "error",
@@ -291,6 +336,7 @@ module.exports = {
         "@typescript-eslint/prefer-readonly-parameter-types": "off", // Could be useful but requires too much work and verbose notation
         "@typescript-eslint/prefer-reduce-type-parameter": "error",
         "@typescript-eslint/prefer-regexp-exec": "error",
+        "@typescript-eslint/prefer-return-this-type": "error",
         "@typescript-eslint/prefer-string-starts-ends-with": "error",
         "@typescript-eslint/prefer-ts-expect-error": "error",
         "@typescript-eslint/promise-function-async": "off",
@@ -298,10 +344,20 @@ module.exports = {
         "@typescript-eslint/restrict-plus-operands": [
             "error",
             {
-                "checkCompoundAssignments": true
+                "checkCompoundAssignments": true,
+                "allowAny": false
+            }
+        ],
+        "@typescript-eslint/restrict-template-expressions": [
+            "error",
+            {
+                "allowNumber": true,
+                "allowBoolean": false,
+                "allowAny": false,
+                "allowNullish": false,
+                "allowRegExp": false
             }
         ],
-        "@typescript-eslint/restrict-template-expressions": "error",
         "@typescript-eslint/sort-type-union-intersection-members": "off",
         "@typescript-eslint/strict-boolean-expressions": [
             "off",