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

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
@@ -329,111 +322,10 @@ const rules = {
  * @param framework Used test framework
  * @returns Testing rules.
  */
-function commonRules(framework) {
+export function commonRules(framework) {
     const updated = {};
     for (const key in rules) {
         updated[`${framework}/${key}`] = rules[key];
     }
     return updated;
 }
-
-module.exports = {
-    jestRules: {
-        ...commonRules("jest"),
-
-        /**
-         * Disallow confusing usages of jest.setTimeout
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-confusing-set-timeout.md
-         */
-        "jest/no-confusing-set-timeout": "off",
-
-        /**
-         * Disallow use of deprecated functions ✅ 🔧
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-deprecated-functions.md
-         */
-        "jest/no-deprecated-functions": "error",
-
-        /**
-         * Disallow using exports in files containing tests ✅
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-export.md
-         */
-        "jest/no-export": "error",
-
-        /**
-         * Disallow Jasmine globals ✅ 🔧
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-jasmine-globals.md
-         */
-        "jest/no-jasmine-globals": "error",
-
-        /**
-         * Disallow specific jest. methods
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-restricted-jest-methods.md
-         */
-        "jest/no-restricted-jest-methods": "off",
-
-        /**
-         * Disallow using jest.mock() factories without an explicit type parameter
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/no-untyped-mock-factory.md
-         */
-        "jest/no-untyped-mock-factory": "off",
-
-        /**
-         * Require promises that have expectations in their chain to be valid ✅
-         * https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/valid-expect-in-promise.md
-         */
-        "jest/valid-expect-in-promise": "error",
-
-    },
-
-    vitestRules: {
-        ...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",
-    },
-};

package/typescript.js

@@ -1,23 +1,7 @@
-/**
- *
- */
-const { rules: tsRules } = require("./rules/plugin-typescript-rules");
+/*
+* Default rules for all typescript projects
+*/
+import base from "./base.js";
+import typescript from "./rules/plugin-typescript-rules.js";
 
-module.exports = {
-    extends: ["./index.js"].map(require.resolve),
-
-    plugins: ["@typescript-eslint"],
-
-    parser: "@typescript-eslint/parser",
-    rules: { ...tsRules },
-
-    settings: {
-        "import/parsers": { "@typescript-eslint/parser": [".ts", ".tsx"] },
-        "import/resolver": {
-            typescript: {
-                alwaysTryTypes: true,
-                project: __dirname, // use tsconfig.json of the root folder (where esLint is running from)
-            },
-        },
-    },
-};
+export default [base, typescript];

package/eslint-plugin-esm-extensions/index.js

@@ -1,155 +0,0 @@
-/* eslint-disable prefer-arrow/prefer-arrow-functions */
-const { default: moduleVisitor } = require("eslint-module-utils/moduleVisitor");
-const { default: resolve } = require("eslint-module-utils/resolve");
-const { isBuiltIn } = require("eslint-plugin-import/lib/core/importType");
-const fs = require("fs");
-const JSON5 = require("json5");
-const path = require("path");
-
-/**
- * Map correct extension
- *
- * @param extension Extension to map.
- * @returns Correct extension.
- */
-function mapExtension(extension) {
-    switch (extension) {
-        case ".ts":
-            return ".js";
-        case ".tsx":
-            return ".jsx";
-        case ".cts":
-            return ".cjs";
-        default:
-            return extension;
-    }
-}
-
-/**
- * Return the root path.
- *
- * @param context Context
- * @returns Root path.
- */
-function getRootCwd(context) {
-    const cwd = context.cwd || process.cwd();
-    if (
-        !context.parserOptions.project ||
-        !fs.existsSync(context.parserOptions.project)
-    ) {
-        return cwd;
-    }
-
-    const data = JSON5.parse(fs.readFileSync(context.parserOptions.project));
-    if (!data?.compilerOptions?.baseUrl) {
-        return cwd;
-    }
-    return path.join(path.dirname(context.parserOptions.project), data.compilerOptions.baseUrl);
-}
-
-module.exports = {
-    rules: {
-        "force-extensions": {
-            meta: {
-                type: "suggestion",
-                docs: {
-                    category: "Style guide",
-                    description: "Ensure consistent use of file extension within the import path.",
-                },
-                fixable: "code",
-            },
-            schema: [],
-
-            // eslint-disable-next-line jsdoc/require-jsdoc
-            create(context) {
-                const cwd = getRootCwd(context);
-                const nodeModulesTypesPath = path.join(cwd, "node_modules", "@types");
-                const nodeModulesPath = path.join(cwd, "node_modules");
-
-                // eslint-disable-next-line jsdoc/require-jsdoc
-                function isExternalType(resolvedPath) {
-                    return !path.relative(nodeModulesTypesPath, resolvedPath).startsWith("..");
-                }
-
-                // eslint-disable-next-line jsdoc/require-jsdoc
-                function isExternal(resolvedPath) {
-                    return !path.relative(nodeModulesPath, resolvedPath).startsWith("..");
-                }
-
-                // eslint-disable-next-line jsdoc/require-jsdoc
-                function isIndex(checkPath) {
-                    return path.parse(checkPath).name === "index";
-                }
-
-                // eslint-disable-next-line jsdoc/require-jsdoc
-                function resolveAndMap(importPath) {
-                    const resolvedPath = resolve(importPath, context) || importPath;
-                    if (!resolvedPath) {
-                        return undefined;
-                    }
-                    const parsed = path.parse(resolvedPath);
-                    return path.join(parsed.dir, `${parsed.name.replace(/\.d/, "")}${mapExtension(parsed.ext)}`);
-                }
-
-                // eslint-disable-next-line jsdoc/require-jsdoc
-                function checkFileExtension(source, node) {
-                    // bail if the declaration doesn't have a source, e.g. "export { foo };",
-                    // or if it's only partially typed like in an editor
-                    if (!source || !source.value) { return; }
-                    // don't enforce anything on builtins
-                    if (isBuiltIn(source.value, context.settings)) {
-                        return;
-                    }
-
-                    const importPath = source.value.replace(/\?(.*)$/, "");
-                    const resolvedPath = resolveAndMap(source.value, context);
-
-                    const resolvedExtension = path.extname(resolvedPath).substring(1);
-                    const importExtension = path.extname(node.source.value).substring(1);
-
-                    if (resolvedExtension === importExtension) {
-                        return;
-                    }
-
-                    if (isExternal(resolvedPath)) {
-                        if (!importPath.startsWith("@prowise/")) {
-                            // TODO figure out all te import rules for packages
-                            // We need to read exports in package.json
-                            // There might be a better way?
-                            return;
-                        }
-                        if (fs.existsSync(path.join(
-                            isExternalType(resolvedPath) ? nodeModulesTypesPath : nodeModulesPath,
-                            importPath,
-                            "package.json",
-                        ))) {
-                            return;
-                        }
-                    }
-
-                    if (isIndex(resolvedPath) && !isIndex(path.basename(importPath))) {
-                        context.report({
-                            node: source,
-                            message: `Missing index.${resolvedExtension} for import "${importPath}"`,
-                            fix: (fixer) => {
-                                const fixValue = `${importPath}/index.${resolvedExtension}`;
-                                return fixer.replaceText(node.source, `"${node.source.value.replace(importPath, fixValue)}"`);
-                            },
-                        });
-                        return;
-                    }
-
-                    context.report({
-                        node: source,
-                        message: `${importExtension ? `Incorrect extension "${importExtension}"` : "Missing extension"} for import: "${node.source.value}"`,
-                        fix: (fixer) => {
-                            const fixValue = `${importPath.substring(0, importPath.length - (importExtension.length ? importExtension.length + 1 : 0))}.${resolvedExtension}`;
-                            return fixer.replaceText(node.source, `"${node.source.value.replace(importPath, fixValue)}"`);
-                        },
-                    });
-                }
-                return moduleVisitor(checkFileExtension, { commonjs: true });
-            },
-        },
-    },
-};

package/eslint-plugin-esm-extensions/package.json

@@ -1,21 +0,0 @@
-{
-    "name": "eslint-plugin-esm-extensions",
-    "version": "1.0.0",
-    "scripts": {},
-    "main": "./index.js",
-    "type": "commonjs",
-    "exports": {
-        "require": "./index.js"
-    },
-    "files": [
-        "index.js"
-    ],
-    "dependencies": {
-        "eslint-module-utils": ">=2",
-        "eslint-plugin-import": ">=2",
-        "json5": ">=1"
-    },
-    "peerDependencies": {
-        "eslint": ">=8"
-    }
-}

package/frontend-vite.js

@@ -1,38 +0,0 @@
-const { rules: reactHooksRules } = require("./rules/plugin-react-hooks-rules");
-const { rules: reactRules } = require("./rules/plugin-react-rules");
-const { vitestRules } = require("./rules/test-rules");
-
-module.exports = {
-    extends: ["./typescript.js"].map(require.resolve),
-
-    env: {
-        browser: true,
-    },
-
-    settings: {
-        react: {
-            version: "detect",
-        },
-    },
-
-    globals: {
-        Atomics: "readonly",
-        SharedArrayBuffer: "readonly",
-    },
-
-    parserOptions: {
-        ecmaFeatures: { jsx: true },
-    },
-
-    plugins: [
-        "eslint-plugin-react",
-        "eslint-plugin-react-hooks",
-        "eslint-plugin-vitest",
-    ],
-
-    rules: {
-        ...reactRules,
-        ...reactHooksRules,
-        ...vitestRules,
-    },
-};

package/frontend.js

@@ -1,39 +0,0 @@
-const { rules: reactHooksRules } = require("./rules/plugin-react-hooks-rules");
-const { rules: reactRules } = require("./rules/plugin-react-rules");
-const { jestRules } = require("./rules/test-rules");
-
-module.exports = {
-    extends: ["./typescript.js"].map(require.resolve),
-
-    env: {
-        jest: true,
-        browser: true,
-    },
-
-    settings: {
-        react: {
-            version: "detect",
-        },
-    },
-
-    globals: {
-        Atomics: "readonly",
-        SharedArrayBuffer: "readonly",
-    },
-
-    parserOptions: {
-        ecmaFeatures: { jsx: true },
-    },
-
-    plugins: [
-        "eslint-plugin-react",
-        "eslint-plugin-react-hooks",
-        "eslint-plugin-jest",
-    ],
-
-    rules: {
-        ...reactRules,
-        ...reactHooksRules,
-        ...jestRules,
-    },
-};

package/solid.js

@@ -1,35 +0,0 @@
-const { rules: solidRules } = require("./rules/plugin-solid-rules");
-const { vitestRules } = require("./rules/test-rules");
-
-module.exports = {
-    extends: ["./typescript.js"].map(require.resolve),
-
-    env: { browser: true },
-    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,
-    },
-
-    plugins: [
-        "eslint-plugin-solid",
-        "vitest",
-    ],
-
-    parserOptions: {
-        ecmaFeatures: { jsx: true },
-    },
-
-    rules: { ...solidRules, ...vitestRules },
-};