@prowise/eslint-config-linting-rules 2.0.1 → 2.0.3

package/backend.js

@@ -1,5 +1,6 @@
+import base from "./base.js";
 import node from "./rules/plugin-node-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 [node, typescript, vitest];
+export default [base, node, typescript, vitest];

package/eslint.config.js

@@ -1,4 +1,9 @@
 import base from "./base.js";
 import node from "./rules/plugin-node-rules.js";
 
-export default [base, node];
+export default [base, node, {
+    rules: {
+        "import/no-named-as-default-member": "off",
+        "import/no-named-as-default": "off",
+    },
+}];

package/index.js

@@ -0,0 +1,3 @@
+import base from "./base.js";
+
+export default [base];

package/package.json

@@ -1 +1 @@
-{"name":"@prowise/eslint-config-linting-rules","version":"2.0.1","description":"Default Prowise linting rules for npm packages.","main":"index.js","type":"module","exports":{"./base":"./base.js","./typescript":"./typescript.js","./backend":"./backend.js","./frontend-vite":"./frontend-vite.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","@typescript-eslint/eslint-plugin":"^8.7.0","@typescript-eslint/parser":"^8.7.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","object.assign":"^4.1.5"},"devDependencies":{"@eslint/config-inspector":"^0.5.4"}}
+{"name":"@prowise/eslint-config-linting-rules","version":"2.0.3","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-import-rules.js

@@ -204,13 +204,13 @@ export default {
          * Do not allow a default import name to match a named export
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default.md.
          */
-        // "import/no-named-as-default": "error",
+        "import/no-named-as-default": "error",
 
         /**
          * Warn on accessing default export property names that are also named exports
          * https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-named-as-default-member.md.
          */
-        // "import/no-named-as-default-member": "error",
+        "import/no-named-as-default-member": "error",
 
         /**
          * Prevent importing the default as if it were named

package/rules/plugin-jest-rules.js

@@ -26,6 +26,12 @@ export default {
          */
         "jest/no-deprecated-functions": "error",
 
+        /**
+         * Disallow using a callback in asynchronous tests and hooks ✅
+         * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-done-callback.md
+         */
+        "jest/no-done-callback": "warn",
+
         /**
          * Disallow using exports in files containing tests ✅
          * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-export.md

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/eslint-plugin";
-import * as baseRules from "./baseSettings.js";
+import typescriptPlugin from "typescript-eslint";
+import baseRules from "./baseSettings.js";
+import importRules from "./plugin-import-rules.js";
 
 export default {
     /*
@@ -11,12 +12,13 @@ export default {
      * 💭 requires type information
      */
 
-    plugins: { "@typescript-eslint": typescriptPlugin },
+    files: ["**/*.ts", "**/*.tsx"],
+
+    plugins: { "@typescript-eslint": typescriptPlugin.plugin },
     languageOptions: {
+        parser: typescriptPlugin.parser,
         parserOptions: {
             project: true,
-            projectService: true,
-            tsconfigRootDir: import.meta.dirname,
         },
     },
 
@@ -50,7 +52,7 @@ export default {
                 "ts-ignore": "allow-with-description",
                 "ts-nocheck": "allow-with-description",
                 "ts-check": "allow-with-description",
-                minimumDescriptionLength: 3,
+                "minimumDescriptionLength": 3,
             },
         ],
 
@@ -175,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)
@@ -252,10 +254,13 @@ export default {
         "@typescript-eslint/no-empty-function": baseRules.rules["no-empty-function"],
 
         /**
-         * Disallow the declaration of empty interfaces ✅  🔧 💡
-         * https://typescript-eslint.io/rules/no-empty-interface.
+         * Disallow accidentally using the "empty object" type ✅  🔧 💡
+         * https://typescript-eslint.io/rules/no-empty-object-type.
          */
-        "@typescript-eslint/no-empty-interface": ["error", { allowSingleExtends: false }],
+        "@typescript-eslint/no-empty-object-type": ["error", {
+            allowInterfaces: "always",
+            allowObjectTypes: "always",
+        }],
 
         /**
          * Disallow the any type ✅ 🔧 💡
@@ -322,13 +327,6 @@ export default {
         "no-loop-func": "off",
         "@typescript-eslint/no-loop-func": baseRules.rules["no-loop-func"],
 
-        /**
-         * Disallow literal numbers that lose precision. ✅
-         * https://typescript-eslint.io/rules/no-loss-of-precision.
-         */
-        "no-loss-of-precision": "off",
-        "@typescript-eslint/no-loss-of-precision": baseRules.rules["no-loss-of-precision"],
-
         /**
          * Disallow magic numbers.
          * Https://typescript-eslint.io/rules/no-magic-numbers.
@@ -392,16 +390,15 @@ export default {
         "@typescript-eslint/no-redundant-type-constituents": "warn",
 
         /**
-         * Disallow invocation of require()
+         * Disallow invocation of require()  ✅
          * https://typescript-eslint.io/rules/no-require-imports.
          */
-        "@typescript-eslint/no-require-imports": "warn",
+        "@typescript-eslint/no-require-imports": "error",
 
         /**
          * Disallow unnecessary return await
          * https://typescript-eslint.io/rules/return-await.
          */
-        "no-return-await": "off",
         "@typescript-eslint/return-await": "warn",
 
         /**
@@ -424,12 +421,6 @@ export default {
          */
         "@typescript-eslint/no-this-alias": "error",
 
-        /**
-         * Disallow type aliases
-         * https://typescript-eslint.io/rules/no-type-alias.
-         */
-        "@typescript-eslint/no-type-alias": "off",
-
         /**
          * Disallow unnecessary equality comparisons against boolean literals 🔒 🔧 💭
          * https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare.
@@ -533,12 +524,6 @@ export default {
          */
         "@typescript-eslint/no-useless-empty-export": "warn",
 
-        /**
-         * Disallow require statements except in import statements ✅
-         * https://typescript-eslint.io/rules/no-var-requires.
-         */
-        "@typescript-eslint/no-var-requires": "error",
-
         /**
          * Enforce non-null assertions over explicit type casts 🔒 🔧 💭
          * https://typescript-eslint.io/rules/non-nullable-type-assertion-style.
@@ -648,12 +633,6 @@ export default {
          */
         "@typescript-eslint/prefer-string-starts-ends-with": "warn",
 
-        /**
-         * Enforce using @ts-expect-error over @ts-ignore 🔒 🔧
-         * https://typescript-eslint.io/rules/prefer-ts-expect-error.
-         */
-        "@typescript-eslint/prefer-ts-expect-error": "warn",
-
         /**
          * Require any function or method that returns a Promise to be marked async 🔧 💭
          * https://typescript-eslint.io/rules/promise-function-async.
@@ -736,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];
+                    },
+                ),
+            },
+        ],
     },
 };

package/rules/test-rules.js

@@ -72,13 +72,6 @@ const rules = {
      */
     "no-disabled-tests": "warn",
 
-    /**
-     * Disallow using a callback in asynchronous tests and hooks ✅
-     * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-done-callback.md
-     * Vitest: https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-done-callback.md
-     */
-    "no-done-callback": "warn",
-
     /**
      * Disallow duplicate setup and teardown hooks
      * Jest:   https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-duplicate-hooks.md