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

package/rules/plugin-typescript-rules.js

@@ -1,7 +1,8 @@
-const { rules: baseRules } = require("./base-rules");
-const { rules: baseImportsRules } = require("./plugin-import-rules");
+// eslint-disable-next-line import/no-unresolved
+import typescriptPlugin from "typescript-eslint";
+import baseRules from "./baseSettings.js";
 
-module.exports = {
+export default {
     /*
      * ✅ recommended
      * 🔒 strict
@@ -10,25 +11,12 @@ module.exports = {
      * 💭 requires type information
      */
 
-    plugins: ["@typescript-eslint"],
-    parser: "@typescript-eslint/parser",
-
-    settings: {
-        // Apply special parsing for TypeScript files
-        "import/parsers": {
-            "@typescript-eslint/parser": [".ts", ".tsx", ".d.ts"],
-        },
-
-        // Append "ts" extensions to Airbnb "import/resolver" setting
-        "import/resolver": {
-            node: { extensions: [".mjs", ".js", ".json", ".ts", ".d.ts"] },
+    plugins: { "@typescript-eslint": typescriptPlugin.plugin },
+    languageOptions: {
+        parser: typescriptPlugin.parser,
+        parserOptions: {
+            project: true,
         },
-
-        // Append "ts" extensions to Airbnb "import/extensions" setting
-        "import/extensions": [".js", ".mjs", ".jsx", ".ts", ".tsx", ".d.ts"],
-
-        // Resolve type definition packages
-        "import/external-module-folders": ["node_modules", "node_modules/@types"],
     },
 
     rules: {
@@ -71,58 +59,12 @@ module.exports = {
          */
         "@typescript-eslint/ban-tslint-comment": "warn",
 
-        /**
-         * Disallow certain types ✅ 🔧
-         * https://typescript-eslint.io/rules/ban-types.
-         */
-        "@typescript-eslint/ban-types": [
-            "error",
-            {
-                types: {
-                    Object: {
-                        message: "Avoid using the `Object` type. Did you mean `object`?",
-                    },
-                    Function: {
-                        message: "Avoid using the `Function` type. Prefer a specific function type, like `() => void`.",
-                    },
-                    Boolean: {
-                        message: "Avoid using the `Boolean` type. Did you mean `boolean`?",
-                    },
-                    Number: {
-                        message: "Avoid using the `Number` type. Did you mean `number`?",
-                    },
-                    String: {
-                        message: "Avoid using the `String` type. Did you mean `string`?",
-                    },
-                    Symbol: {
-                        message: "Avoid using the `Symbol` type. Did you mean `symbol`?",
-                    },
-                    "{}": false,
-                },
-            },
-        ],
-
         /**
          * Enforce that literals on classes are exposed in a consistent style 🔒 🔧
          * https://typescript-eslint.io/rules/class-litiral-property-style.
          */
         "@typescript-eslint/class-literal-property-style": "warn",
 
-        /**
-         * Require or disallow trailing commas.🔧
-         * https://typescript-eslint.io/rules/comma-dangle.
-         */
-        "comma-dangle": "off",
-        "@typescript-eslint/comma-dangle": [
-            baseRules["comma-dangle"][0],
-            {
-                ...baseRules["comma-dangle"][1],
-                enums: baseRules["comma-dangle"][1].arrays,
-                generics: baseRules["comma-dangle"][1].arrays,
-                tuples: baseRules["comma-dangle"][1].arrays,
-            },
-        ],
-
         /**
          * Enforce specifying generic type arguments on type annotation or constructor name of a constructor call 🔒 🔧
          * https://typescript-eslint.io/rules/consistent-generic-constructors.
@@ -166,14 +108,14 @@ module.exports = {
          * Https://typescript-eslint.io/rules/default-param-last.
          */
         "default-param-last": "off",
-        "@typescript-eslint/default-param-last": baseRules["default-param-last"],
+        "@typescript-eslint/default-param-last": baseRules.rules["default-param-last"],
 
         /**
          * Enforce dot notation whenever possible.
          * Https://typescript-eslint.io/rules/dot-notation.
          */
         "dot-notation": "off",
-        "@typescript-eslint/dot-notation": baseRules["dot-notation"],
+        "@typescript-eslint/dot-notation": baseRules.rules["dot-notation"],
 
         /**
          * Require explicit return types on functions and class methods.
@@ -214,13 +156,7 @@ module.exports = {
          * https://typescript-eslint.io/rules/init-declarations.
          */
         "init-declarations": "off",
-        "@typescript-eslint/init-declarations": baseRules["init-declarations"],
-
-        /**
-         * Require a specific member delimiter style for interfaces and type literals 🔧
-         * https://typescript-eslint.io/rules/member-delimiter-style.
-         */
-        "@typescript-eslint/member-delimiter-style": "warn",
+        "@typescript-eslint/init-declarations": baseRules.rules["init-declarations"],
 
         /**
          * Require a consistent member declaration order
@@ -265,7 +201,7 @@ module.exports = {
          * https://typescript-eslint.io/rules/no-array-constructor.
          */
         "no-array-constructor": "off",
-        "@typescript-eslint/no-array-constructor": baseRules["no-array-constructor"],
+        "@typescript-eslint/no-array-constructor": baseRules.rules["no-array-constructor"],
 
         /**
          * Require .toString() to only be called on objects which provide useful information when stringified 🔒 💭
@@ -293,7 +229,7 @@ module.exports = {
          * Https://typescript-eslint.io/rules/no-dupe-class-members.
          */
         "no-dupe-class-members": "off",
-        "@typescript-eslint/no-dupe-class-members": baseRules["no-dupe-class-members"],
+        "@typescript-eslint/no-dupe-class-members": baseRules.rules["no-dupe-class-members"],
 
         /**
          * Disallow duplicate enum member values 🔒
@@ -312,13 +248,13 @@ module.exports = {
          * https://typescript-eslint.io/rules/no-empty-function.
          */
         "no-empty-function": "off",
-        "@typescript-eslint/no-empty-function": baseRules["no-empty-function"],
+        "@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",
 
         /**
          * Disallow the any type ✅ 🔧 💡
@@ -332,20 +268,6 @@ module.exports = {
          */
         "@typescript-eslint/no-extra-non-null-assertion": "error",
 
-        /**
-         * Disallow unnecessary parentheses.🔧
-         * https://typescript-eslint.io/rules/no-extra-parens.
-         */
-        "no-extra-parens": "off",
-        "@typescript-eslint/no-extra-parens": baseRules["no-extra-parens"],
-
-        /**
-         * Disallow unnecessary semicolons.✅ 🔧
-         * https://typescript-eslint.io/rules/no-extra-semi.
-         */
-        "no-extra-semi": "off",
-        "@typescript-eslint/no-extra-semi": baseRules["no-extra-semi"],
-
         /**
          * Disallow classes used as namespaces 🔒
          * https://typescript-eslint.io/rules/no-extraneous-class.
@@ -370,7 +292,7 @@ module.exports = {
          */
         "no-implied-eval": "off",
         "no-new-function": "off",
-        "@typescript-eslint/no-implied-eval": baseRules["no-implied-eval"],
+        "@typescript-eslint/no-implied-eval": baseRules.rules["no-implied-eval"],
 
         /**
          * Disallow explicit type declarations for variables or parameters initialized to a number,
@@ -384,7 +306,7 @@ module.exports = {
          * Https://typescript-eslint.io/rules/no-invalid-this.
          */
         "no-invalid-this": "off",
-        "@typescript-eslint/no-invalid-this": baseRules["no-invalid-this"],
+        "@typescript-eslint/no-invalid-this": baseRules.rules["no-invalid-this"],
 
         /**
          * Disallow void type outside of generic or return types 🔒
@@ -397,21 +319,14 @@ module.exports = {
          * Https://typescript-eslint.io/rules/no-loop-func.
          */
         "no-loop-func": "off",
-        "@typescript-eslint/no-loop-func": baseRules["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["no-loss-of-precision"],
+        "@typescript-eslint/no-loop-func": baseRules.rules["no-loop-func"],
 
         /**
          * Disallow magic numbers.
          * Https://typescript-eslint.io/rules/no-magic-numbers.
          */
         "no-magic-numbers": "off",
-        "@typescript-eslint/no-magic-numbers": baseRules["no-magic-numbers"],
+        "@typescript-eslint/no-magic-numbers": baseRules.rules["no-magic-numbers"],
 
         /**
          * Disallow the void operator except when used to discard a value 🔒 🔧 💡 💭
@@ -460,7 +375,7 @@ module.exports = {
          * Https://typescript-eslint.io/rules/no-redeclare.
          */
         "no-redeclare": "off",
-        "@typescript-eslint/no-redeclare": baseRules["no-redeclare"],
+        "@typescript-eslint/no-redeclare": baseRules.rules["no-redeclare"],
 
         /**
          * Disallow members of unions and intersections that do nothing or override type information 💭
@@ -469,16 +384,15 @@ module.exports = {
         "@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",
 
         /**
@@ -486,14 +400,14 @@ module.exports = {
          * Https://typescript-eslint.io/rules/no-restricted-imports.
          */
         "no-restricted-imports": "off",
-        "@typescript-eslint/no-restricted-imports": baseRules["no-restricted-imports"],
+        "@typescript-eslint/no-restricted-imports": baseRules.rules["no-restricted-imports"],
 
         /**
          * Disallow variable declarations from shadowing variables declared in the outer scope
          * https://typescript-eslint.io/rules/no-shadow.
          */
         "no-shadow": "off",
-        "@typescript-eslint/no-shadow": baseRules["no-shadow"],
+        "@typescript-eslint/no-shadow": baseRules.rules["no-shadow"],
 
         /**
          * Disallow aliasing this ✅
@@ -501,19 +415,6 @@ module.exports = {
          */
         "@typescript-eslint/no-this-alias": "error",
 
-        /**
-         * Disallow throwing literals as exceptions
-         * https://typescript-eslint.io/rules/no-throw-literal.
-         */
-        "no-throw-literal": "off",
-        "@typescript-eslint/no-throw-literal": "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.
@@ -588,28 +489,28 @@ module.exports = {
          * https://typescript-eslint.io/rules/no-unused-expressions.
          */
         "no-unused-expressions": "off",
-        "@typescript-eslint/no-unused-expressions": baseRules["no-unused-expressions"],
+        "@typescript-eslint/no-unused-expressions": baseRules.rules["no-unused-expressions"],
 
         /**
          * Disallow unused variables
          * https://typescript-eslint.io/rules/no-unused-vars.
          */
         "no-unused-vars": "off",
-        "@typescript-eslint/no-unused-vars": baseRules["no-unused-vars"],
+        "@typescript-eslint/no-unused-vars": baseRules.rules["no-unused-vars"],
 
         /**
          * Disallow the use of variables before they are defined
          * https://typescript-eslint.io/rules/no-use-before-define.
          */
         "no-use-before-define": "off",
-        "@typescript-eslint/no-use-before-define": baseRules["no-use-before-define"],
+        "@typescript-eslint/no-use-before-define": baseRules.rules["no-use-before-define"],
 
         /**
          * Disallow unnecessary constructors
          * https://typescript-eslint.io/rules/no-useless-constructor.
          */
         "no-useless-constructor": "off",
-        "@typescript-eslint/no-useless-constructor": baseRules["no-useless-constructor"],
+        "@typescript-eslint/no-useless-constructor": baseRules.rules["no-useless-constructor"],
 
         /**
          * Disallow empty exports that don"t change anything in a module file 🔧
@@ -617,12 +518,6 @@ module.exports = {
          */
         "@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.
@@ -732,25 +627,12 @@ module.exports = {
          */
         "@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.
          */
         "@typescript-eslint/promise-function-async": "error",
 
-        /**
-         * Enforce the consistent use of double quotes
-         * https://typescript-eslint.io/rules/quotes.
-         */
-        quotes: "off",
-        "@typescript-eslint/quotes": baseRules.quotes,
-
         /**
          * Require Array#sort calls to always provide a compareFunction 💭
          * https://typescript-eslint.io/rules/require-array-sort-compare.
@@ -761,8 +643,8 @@ module.exports = {
          * Disallow async functions which have no await expression
          * https://typescript-eslint.io/rules/require-await.
          */
-        "require-await": "off",
-        "@typescript-eslint/require-await": baseRules["require-await"],
+        // "require-await": "off",
+        // "@typescript-eslint/require-await": baseRules.rules["require-await"],
 
         /**
          * Require both operands of addition to have type number or string ✅ 💭
@@ -777,13 +659,6 @@ module.exports = {
          */
         "@typescript-eslint/restrict-template-expressions": "error",
 
-        /**
-         * Require or disallow semicolons instead of ASI.
-         * Https://typescript-eslint.io/rules/semi.
-         */
-        semi: "off",
-        "@typescript-eslint/semi": baseRules.semi,
-
         /**
          * Enforce members of a type union/intersection to be sorted alphabetically 🔧 💡
          * https://typescript-eslint.io/rules/sort-type-union-intersection-members.
@@ -834,109 +709,32 @@ module.exports = {
          */
         "@typescript-eslint/unified-signatures": "error",
 
-        // =================   Formatting rules =======================
-
-        /**
-         * Enforce consistent brace style for blocks.
-         * Https://typescript-eslint.io/rules/brace-style.
-         */
-        "brace-style": "off",
-        "@typescript-eslint/brace-style": baseRules["brace-style"],
-
-        /**
-         * Enforce consistent spacing before and after commas.
-         * Https://typescript-eslint.io/rules/comma-spacing.
-         */
-        "comma-spacing": "off",
-        "@typescript-eslint/comma-spacing": baseRules["comma-spacing"],
-
-        /**
-         * Require or disallow spacing between function identifiers and their invocations.
-         * Https://typescript-eslint.io/rules/func-call-spacing.
-         */
-        "func-call-spacing": "off",
-        "@typescript-eslint/func-call-spacing": baseRules["func-call-spacing"],
-
-        /**
-         * Enforce consistent indentation.
-         * Https://typescript-eslint.io/rules/indent.
-         */
-        indent: "off",
-        "@typescript-eslint/indent": baseRules.indent,
-
-        /**
-         * Enforce consistent spacing before and after keywords.
-         * Https://typescript-eslint.io/rules/keyword-spacing.
-         */
-        "keyword-spacing": "off",
-        "@typescript-eslint/keyword-spacing": baseRules["keyword-spacing"],
-
-        /**
-         * Enforce consistent spacing inside braces.
-         * Https://typescript-eslint.io/rules/object-curly-spacing.
-         */
-        "object-curly-spacing": "off",
-        "@typescript-eslint/object-curly-spacing": baseRules["object-curly-spacing"],
-
-        /**
-         * Require or disallow padding lines between statements.
-         * Https://typescript-eslint.io/rules/padding-line-between-statements.
-         */
-        "padding-line-between-statements": "off",
-        "@typescript-eslint/padding-line-between-statements": baseRules["padding-line-between-statements"],
-
-        /**
-         * Enforce consistent spacing before blocks.
-         * Https://typescript-eslint.io/rules/space-before-blocks.
-         */
-        "space-before-blocks": "off",
-        "@typescript-eslint/space-before-blocks": baseRules["space-before-blocks"],
-
-        /**
-         * Enforce consistent spacing before function parenthesis.
-         * Https://typescript-eslint.io/rules/space-before-function-paren.
-         */
-        "space-before-function-paren": "off",
-        "@typescript-eslint/space-before-function-paren": baseRules["space-before-function-paren"],
-
-        /**
-         * Require spacing around infix operators.
-         * Https://typescript-eslint.io/rules/space-infix-ops.
-         */
-        "space-infix-ops": "off",
-        "@typescript-eslint/space-infix-ops": baseRules["space-infix-ops"],
-
-        /**
-         * Require consistent spacing around type annotations
-         * https://typescript-eslint.io/rules/type-annotation-spacing.
-         */
-        "@typescript-eslint/type-annotation-spacing": "warn",
-
+        // TODO: fix this rule!
         // Append "ts" and "tsx" to Airbnb "import/extensions" rule
-        "import/extensions": [
-            baseImportsRules["import/extensions"][0],
-            baseImportsRules["import/extensions"][1],
-            {
-                ...baseImportsRules["import/extensions"][2],
-                ts: "never",
-                tsx: "never",
-            },
-        ],
-
-        // Append "ts" and "tsx" extensions to Airbnb "import/no-extraneous-dependencies" rule
-        "import/no-extraneous-dependencies": [
-            baseImportsRules["import/no-extraneous-dependencies"][0],
-            {
-                ...baseImportsRules["import/no-extraneous-dependencies"][1],
-                devDependencies: baseImportsRules["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];
-                    },
-                ),
-            },
-        ],
+        // "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];
+        //             },
+        //         ),
+        //     },
+        // ],
     },
 };

package/rules/plugin-vitest-rules.js

@@ -0,0 +1,77 @@
+import vitestPlugin from "eslint-plugin-vitest";
+import { commonRules } from "./test-rules.js";
+
+export default {
+    plugins: { vitest: vitestPlugin },
+
+    languageOptions: {
+        globals: {
+            suite: true,
+            test: true,
+            describe: true,
+            it: true,
+            expectTypeOf: true,
+            assertType: true,
+            expect: true,
+            assert: true,
+            vitest: true,
+            vi: true,
+            beforeAll: true,
+            afterAll: true,
+            beforeEach: true,
+            afterEach: true,
+        },
+    },
+
+    rules: {
+        ...commonRules("vitest"),
+
+        /**
+         * Forbidden test file pattern: default only "test" accepted
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/consistent-test-filename.md
+         */
+        "vitest/consistent-test-filename": ["off", { pattern: ".*\\.test\\.[tj]sx?$" }],
+
+        /**
+         * Do not use conditionals to run tests
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-conditional-tests.md
+         */
+        "vitest/no-conditional-tests": "off",
+
+        /**
+         * Disallow importing node:test ✅ 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-import-node-test.md
+         */
+        "vitest/no-import-node-test": "error",
+
+        /**
+         * Disallow specific vi. methods
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/no-restricted-vi-methods.md
+         */
+        "vitest/no-restricted-vi-methods": "off",
+
+        /**
+         * Suggest using toBeFalsy() 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-falsy.md
+         */
+        "vitest/prefer-to-be-falsy)": "off",
+
+        /**
+         * Prefer toBeObject() 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-object.md
+         */
+        "vitest/prefer-to-be-object": "off",
+
+        /**
+         * Suggest using toBeTruthy 🔧
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/prefer-to-be-truthy.md
+         */
+        "vitest/prefer-to-be-truthy": "off",
+
+        /**
+         * Require local Test Context for concurrent snapshot tests ✅
+         * https://github.com/veritem/eslint-plugin-vitest/blob/main/docs/rules/require-local-test-context-for-concurrent-snapshots.md
+         */
+        "vitest/require-local-test-context-for-concurrent-snapshots": "error",
+    },
+};