@prowise/eslint-config-linting-rules 2.0.2 → 2.0.4

package/front-react.js

@@ -1,9 +1,11 @@
 import globals from "globals";
+import base from "./base.js";
 import react from "./rules/plugin-react-rules.js";
+import typescript from "./rules/plugin-typescript-rules.js";
 import vitest from "./rules/plugin-vitest-rules.js";
-import typescript from "./typescript.js";
 
 export default [
+    base,
     typescript,
     react,
     vitest,

package/front-solid.js

@@ -1,9 +1,11 @@
 import globals from "globals";
+import base from "./base.js";
 import solid from "./rules/plugin-solid-rules.js";
+import typescript from "./rules/plugin-typescript-rules.js";
 import vitest from "./rules/plugin-vitest-rules.js";
-import typescript from "./typescript.js";
 
 export default [
+    base,
     typescript,
     solid,
     vitest,

package/package.json

@@ -1 +1 @@
-{"name":"@prowise/eslint-config-linting-rules","version":"2.0.2","description":"Default Prowise linting rules for npm packages.","main":"index.js","type":"module","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./front-react":"./front-react.js","./front-solid":"./front-solid.js"},"scripts":{"lint":"eslint","inspect":"eslint --inspect-config"},"repository":{"type":"git","url":"git+ssh://git@bitbucket.org/prowise/npm-linting-rules.git"},"author":"Prowise B.V.","license":"UNLICENSED","homepage":"https://bitbucket.org/prowise/npm-linting-rules#readme","dependencies":{"@stylistic/eslint-plugin":"^2.8.0","confusing-browser-globals":"^1.0.11","eslint":"^9.11.1","eslint-import-resolver-typescript":"^3.6.3","eslint-plugin-import-x":"^4.3.0","eslint-plugin-jest":"^28.8.3","eslint-plugin-jsdoc":"^50.2.4","eslint-plugin-jsx-a11y":"^6.10.0","eslint-plugin-n":"^17.10.3","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-react":"^7.36.1","eslint-plugin-solid":"^0.14.3","eslint-plugin-vitest":"^0.5.4","globals":"^15.9.0","typescript-eslint":"^8.7.0"},"devDependencies":{"@eslint/config-inspector":"^0.5.4"}}
+{"name":"@prowise/eslint-config-linting-rules","version":"2.0.4","description":"Default Prowise linting rules for npm packages.","main":"index.js","type":"module","exports":{"./typescript":"./typescript.js","./backend":"./backend.js","./front-react":"./front-react.js","./front-solid":"./front-solid.js"},"scripts":{"lint":"eslint","inspect":"eslint --inspect-config"},"repository":{"type":"git","url":"git+ssh://git@bitbucket.org/prowise/npm-linting-rules.git"},"author":"Prowise B.V.","license":"UNLICENSED","homepage":"https://bitbucket.org/prowise/npm-linting-rules#readme","dependencies":{"@stylistic/eslint-plugin":"^2.8.0","confusing-browser-globals":"^1.0.11","eslint":"^9.11.1","eslint-import-resolver-typescript":"^3.6.3","eslint-plugin-import-x":"^4.3.0","eslint-plugin-jest":"^28.8.3","eslint-plugin-jsdoc":"^50.2.4","eslint-plugin-jsx-a11y":"^6.10.0","eslint-plugin-n":"^17.10.3","eslint-plugin-prefer-arrow":"^1.2.3","eslint-plugin-react":"^7.36.1","eslint-plugin-solid":"^0.14.3","eslint-plugin-vitest":"^0.5.4","globals":"^15.9.0","typescript-eslint":"^8.7.0"},"devDependencies":{"@eslint/config-inspector":"^0.5.4"}}

package/rules/baseSettings.js

@@ -327,7 +327,7 @@ export default {
          * Disallow declaration of variables that are not used in the code ✅
          * https://eslint.org/docs/latest/rules/no-unused-vars.
          */
-        "no-unused-vars": ["error", { vars: "all", args: "after-used", ignoreRestSiblings: true }],
+        "no-unused-vars": ["error", { vars: "all", args: "after-used", caughtErrors: "none", ignoreRestSiblings: true }],
 
         /**
          * Disallow use of variables before they are defined
@@ -384,7 +384,7 @@ export default {
          * Require camel case names
          * https://eslint.org/docs/latest/rules/camelcase.
          */
-        camelcase: ["error", { properties: "never", ignoreDestructuring: false }],
+        "camelcase": ["error", { properties: "never", ignoreDestructuring: false }],
 
         /**
          * Enforce or disallow capitalization of the first letter of a comment 🔧
@@ -439,7 +439,7 @@ export default {
          * Specify the maximum cyclomatic complexity allowed in a program
          * https://eslint.org/docs/latest/rules/complexity.
          */
-        complexity: ["off", 20],
+        "complexity": ["off", 20],
 
         /**
          * Require return statements to either always or never specify values
@@ -457,7 +457,7 @@ export default {
          * Specify curly brace conventions for all control statements 🔧
          * https://eslint.org/docs/latest/rules/curly.
          */
-        curly: ["error", "multi-line", "consistent"],
+        "curly": ["error", "multi-line", "consistent"],
 
         /**
          * Require default case in switch statements
@@ -487,7 +487,7 @@ export default {
          * Require the use of === and !== 🔧
          * https://eslint.org/docs/latest/rules/eqeqeq.
          */
-        eqeqeq: ["error", "always", { null: "ignore" }],
+        "eqeqeq": ["error", "always", { null: "ignore" }],
 
         /**
          * Requires function names to match the name of the variable or property to which they are assigned
@@ -1311,7 +1311,7 @@ export default {
          * Require use of the second argument for parseInt()
          * https://eslint.org/docs/latest/rules/radix.
          */
-        radix: ["error", "as-needed"],
+        "radix": ["error", "as-needed"],
 
         /**
          * Require `await` in `async function` (note: this is a horrible rule that should never be used)
@@ -1361,7 +1361,7 @@ export default {
          * Require or disallow strict mode directives 🔧
          * https://eslint.org/docs/latest/rules/strict.
          */
-        strict: ["error", "never"],
+        "strict": ["error", "never"],
 
         /**
          * Require a Symbol description
@@ -1385,6 +1385,6 @@ export default {
          * Require or disallow Yoda conditions 🔧
          * https://eslint.org/docs/latest/rules/yoda.
          */
-        yoda: "error",
+        "yoda": "error",
     },
 };

package/rules/plugin-jsx-a11y-rules.js

@@ -27,10 +27,10 @@ export default {
         "jsx-a11y/alt-text": [
             "error",
             {
-                elements: ["img", "object", "area", "input[type='image']"],
-                img: [],
-                object: [],
-                area: [],
+                "elements": ["img", "object", "area", "input[type='image']"],
+                "img": [],
+                "object": [],
+                "area": [],
                 "input[type='image']": [],
             },
         ],

package/rules/plugin-node-rules.js

@@ -1,4 +1,5 @@
 import nodePlugin from "eslint-plugin-n";
+import globals from "globals";
 
 export default {
     /*
@@ -9,6 +10,12 @@ export default {
      * 💭 requires type information
      */
 
+    languageOptions: {
+        globals: {
+            ...globals.node,
+        },
+    },
+
     plugins: {
         node: nodePlugin,
     },

package/rules/plugin-stylistic-rules.js

@@ -217,7 +217,7 @@ export default {
                 code: 120,
                 tabWidth: 4,
                 ignoreUrls: true,
-                ignoreComments: false,
+                ignoreComments: true,
                 ignoreRegExpLiterals: true,
                 ignoreStrings: true,
                 ignoreTemplateLiterals: true,
@@ -424,7 +424,7 @@ export default {
          * Require quotes around object literal property names 🔧
          * https://eslint.org/docs/latest/rules/quote-props.
          */
-        "style/quote-props": ["error", "as-needed", { keywords: false, unnecessary: true, numbers: false }],
+        "style/quote-props": ["error", "consistent-as-needed", { keywords: false, unnecessary: true, numbers: false }],
 
         /**
          * Enforce spacing between object rest-spread 🔧

package/rules/plugin-typescript-rules.js

@@ -1,6 +1,7 @@
 // eslint-disable-next-line import/no-unresolved
 import typescriptPlugin from "typescript-eslint";
 import baseRules from "./baseSettings.js";
+import importRules from "./plugin-import-rules.js";
 
 export default {
     /*
@@ -11,6 +12,8 @@ export default {
      * 💭 requires type information
      */
 
+    files: ["**/*.ts", "**/*.tsx"],
+
     plugins: { "@typescript-eslint": typescriptPlugin.plugin },
     languageOptions: {
         parser: typescriptPlugin.parser,
@@ -49,7 +52,7 @@ export default {
                 "ts-ignore": "allow-with-description",
                 "ts-nocheck": "allow-with-description",
                 "ts-check": "allow-with-description",
-                minimumDescriptionLength: 3,
+                "minimumDescriptionLength": 3,
             },
         ],
 
@@ -174,7 +177,7 @@ export default {
          * Enforce naming conventions for everything across a codebase 💭
          * https://typescript-eslint.io/rules/naming-convention.
          */
-        camelcase: "off", // The `@typescript-eslint/naming-convention` rule allows `leadingUnderscore` and `trailingUnderscore` settings. However, the existing `no-underscore-dangle` rule already takes care of this.
+        "camelcase": "off", // The `@typescript-eslint/naming-convention` rule allows `leadingUnderscore` and `trailingUnderscore` settings. However, the existing `no-underscore-dangle` rule already takes care of this.
         "@typescript-eslint/naming-convention": [
             "error",
             // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables (23.10)
@@ -254,7 +257,10 @@ export default {
          * Disallow accidentally using the "empty object" type ✅  🔧 💡
          * https://typescript-eslint.io/rules/no-empty-object-type.
          */
-        "@typescript-eslint/no-empty-object-type": "error",
+        "@typescript-eslint/no-empty-object-type": ["error", {
+            allowInterfaces: "always",
+            allowObjectTypes: "always",
+        }],
 
         /**
          * Disallow the any type ✅ 🔧 💡
@@ -709,32 +715,39 @@ export default {
          */
         "@typescript-eslint/unified-signatures": "error",
 
-        // TODO: fix this rule!
-        // Append "ts" and "tsx" to Airbnb "import/extensions" rule
-        // "import/extensions": [
-        //     importRules.rules["import/extensions"][0],
-        //     importRules.rules["import/extensions"][1],
-        //     {
-        //         ...importRules.rules["import/extensions"][2],
-        //         ts: "never",
-        //         tsx: "never",
-        //     },
-        // ],
-
-        // TODO: fix this rule!
-        // "import/no-extraneous-dependencies": [
-        //     importRules.rules["import/no-extraneous-dependencies"][0],
-        //     {
-        //         ...importRules.rules["import/no-extraneous-dependencies"][1],
-        //         devDependencies: importRules.rules["import/no-extraneous-dependencies"][1].devDependencies.reduce(
-        //             (result, devDep) => {
-        //                 const toAppend = [devDep];
-        //                 const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, "ts$1");
-        //                 if (devDepWithTs !== devDep) toAppend.push(devDepWithTs);
-        //                 return [...result, ...toAppend];
-        //             },
-        //         ),
-        //     },
-        // ],
+        /**
+         * See https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/named.md# why it is turned off
+         */
+        "import/named": "off",
+
+        /**
+         * Turned off because extension *.ts can not be resolved to the required *.js extension in node!
+         */
+        "import/no-unresolved": "off",
+
+        "import/extensions": [
+            importRules.rules["import/extensions"][0],
+            importRules.rules["import/extensions"][1],
+            {
+                ...importRules.rules["import/extensions"][2],
+                ts: "never",
+                tsx: "never",
+            },
+        ],
+
+        "import/no-extraneous-dependencies": [
+            importRules.rules["import/no-extraneous-dependencies"][0],
+            {
+                ...importRules.rules["import/no-extraneous-dependencies"][1],
+                devDependencies: importRules.rules["import/no-extraneous-dependencies"][1].devDependencies.reduce(
+                    (result, devDep) => {
+                        const toAppend = [devDep];
+                        const devDepWithTs = devDep.replace(/\bjs(x?)\b/g, "ts$1");
+                        if (devDepWithTs !== devDep) toAppend.push(devDepWithTs);
+                        return [...result, ...toAppend];
+                    },
+                ),
+            },
+        ],
     },
 };