@comet/eslint-plugin 9.0.0-beta.3 → 9.0.0-beta.4

package/package.json

@@ -1,28 +1,30 @@
 {
   "name": "@comet/eslint-plugin",
-  "version": "9.0.0-beta.3",
+  "version": "9.0.0-beta.4",
   "description": "A set of ESLint rules and configurations for Comet projects",
   "type": "commonjs",
   "main": "lib/index.js",
   "license": "BSD-2-Clause",
+  "sideEffects": false,
+  "files": [
+    "lib"
+  ],
   "devDependencies": {
     "@eslint/js": "^9.39.4",
-    "@types/jest": "^29.5.14",
-    "eslint": "^9.39.2",
+    "eslint": "^9.39.4",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-jsonc": "^2.21.1",
-    "eslint-plugin-package-json": "^0.88.2",
+    "eslint-plugin-package-json": "^0.91.2",
     "eslint-plugin-prettier": "^5.5.5",
     "eslint-plugin-simple-import-sort": "^12.1.1",
     "eslint-plugin-unused-imports": "^4.4.1",
     "globals": "^15.15.0",
-    "jest": "^29.7.0",
     "npm-run-all2": "^8.0.4",
     "prettier": "^3.6.2",
-    "ts-jest": "^29.4.9",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.53.0"
+    "typescript-eslint": "^8.59.3",
+    "vitest": "^4.0.16"
   },
   "peerDependencies": {
     "eslint": ">=9",
@@ -36,7 +38,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "scripts": {
-    "build": "pnpm run clean && tsc",
+    "build": "pnpm run clean && tsc --project ./tsconfig.build.json",
     "clean": "rimraf lib",
     "dev": "tsc --watch",
     "lint": "run-p lint:prettier lint:eslint lint:tsc",
@@ -46,8 +48,8 @@
     "lint:fix:eslint": "pnpm run lint:eslint --fix",
     "lint:fix:prettier": "pnpm run lint:prettier --write",
     "lint:prettier": "pnpm exec prettier --check '*.{ts,js,json,md,yml,yaml}'",
-    "lint:tsc": "tsc",
-    "test": "jest",
-    "test:watch": "jest --watch"
+    "lint:tsc": "tsc --noEmit",
+    "test": "vitest --run",
+    "test:watch": "vitest --watch"
   }
 }

package/CHANGELOG.md

@@ -1,265 +0,0 @@
-# @comet/eslint-plugin
-
-## 9.0.0-beta.3
-
-## 9.0.0-beta.2
-
-## 9.0.0-beta.1
-
-## 9.0.0-beta.0
-
-### Major Changes
-
-- db6b83a: Prevent lib imports from `@comet/` packages
-
-    Use `no-restricted-imports` to prevent importing private files from `@comet/*/lib`. For example, the following import would be forbidden:
-
-    ```ts
-    import { something } from "@comet/admin/lib/some/private/file";
-    ```
-
-## 8.20.0
-
-## 8.19.0
-
-## 8.18.0
-
-## 8.17.1
-
-## 8.17.0
-
-## 8.16.0
-
-## 8.15.0
-
-## 8.14.0
-
-## 8.13.0
-
-## 8.12.0
-
-## 8.11.1
-
-## 8.11.0
-
-## 8.10.0
-
-## 8.9.0
-
-## 8.8.0
-
-## 8.7.1
-
-## 8.7.0
-
-## 8.6.0
-
-## 8.5.2
-
-## 8.5.1
-
-## 8.5.0
-
-## 8.4.2
-
-## 8.4.1
-
-## 8.4.0
-
-## 8.3.0
-
-## 8.2.0
-
-## 8.1.1
-
-## 8.1.0
-
-## 8.0.0
-
-### Major Changes
-
-- f904b71: Require Node v22
-
-    The minimum required Node version is now v22.0.0.
-    See the migration guide for instructions on how to upgrade your project.
-
-## 8.0.0-beta.6
-
-## 8.0.0-beta.5
-
-## 8.0.0-beta.4
-
-## 8.0.0-beta.3
-
-## 8.0.0-beta.2
-
-### Major Changes
-
-- f904b71: Require Node v22
-
-    The minimum required Node version is now v22.0.0.
-    See the migration guide for instructions on how to upgrade your project.
-
-## 8.0.0-beta.1
-
-## 8.0.0-beta.0
-
-## 7.25.3
-
-## 7.25.2
-
-## 7.25.1
-
-### Patch Changes
-
-- 85e80218f: Support dot separated imports in no-private-sibling-import rule
-
-    This allows, for example, importing from MyBlock.loader.gql.ts in MyBlock.loader.ts
-
-## 7.25.0
-
-## 7.24.0
-
-## 7.23.0
-
-## 7.22.0
-
-## 7.21.1
-
-## 7.21.0
-
-## 7.20.0
-
-## 7.19.0
-
-## 7.18.0
-
-## 7.17.0
-
-## 7.16.0
-
-## 7.15.0
-
-## 7.14.0
-
-## 7.13.0
-
-## 7.12.0
-
-## 7.11.0
-
-## 7.10.0
-
-## 7.9.0
-
-## 7.8.0
-
-## 7.7.0
-
-## 7.6.0
-
-## 7.5.0
-
-## 7.4.2
-
-## 7.4.1
-
-## 7.4.0
-
-## 7.3.2
-
-## 7.3.1
-
-## 7.3.0
-
-## 7.2.1
-
-## 7.2.0
-
-## 7.1.0
-
-## 7.0.0
-
-## 7.0.0-beta.6
-
-## 7.0.0-beta.5
-
-## 7.0.0-beta.4
-
-## 7.0.0-beta.3
-
-## 7.0.0-beta.2
-
-## 7.0.0-beta.1
-
-## 7.0.0-beta.0
-
-## 6.17.1
-
-## 6.17.0
-
-## 6.16.0
-
-## 6.15.1
-
-## 6.15.0
-
-## 6.14.1
-
-## 6.14.0
-
-## 6.13.0
-
-## 6.12.0
-
-## 6.11.0
-
-## 6.10.0
-
-## 6.9.0
-
-## 6.8.0
-
-## 6.7.0
-
-## 6.6.2
-
-## 6.6.1
-
-## 6.6.0
-
-## 6.5.0
-
-## 6.4.0
-
-## 6.3.0
-
-## 6.2.1
-
-## 6.2.0
-
-## 6.1.0
-
-## 6.0.0
-
-## 5.6.0
-
-## 5.5.0
-
-## 5.4.0
-
-## 5.3.0
-
-## 5.2.0
-
-## 5.1.0
-
-### Minor Changes
-
-- ec0582e6: Add new ESLint rule to enforce absolute imports when importing from other modules
-
-    For instance, an import `import { AThingInModuleA } from "../moduleA/AThingInModuleA"` in module `B` needs to be imported as `import { AThingInModuleA } from "@src/moduleA/AThingInModuleA"`.
-    The default source root `"./src"` and alias `"@src"` can be changed via the rule's `sourceRoot` and `sourceRootAlias` options.
-    This rule will be enforced by `@comet/eslint-config` in the next major release.
-
-## 5.0.0

package/eslint.config.mjs

@@ -1,81 +0,0 @@
-import { defineConfig, globalIgnores } from "eslint/config";
-import eslint from "@eslint/js";
-import globals from "globals";
-import tseslint from "typescript-eslint";
-import prettierConfig from "eslint-config-prettier";
-import prettierPlugin from "eslint-plugin-prettier/recommended";
-import unusedImports from "eslint-plugin-unused-imports";
-import simpleImportSort from "eslint-plugin-simple-import-sort";
-import { configs as eslintPluginJsonc } from "eslint-plugin-jsonc";
-import importPlugin from "eslint-plugin-import";
-import packageJson from "eslint-plugin-package-json";
-
-export default defineConfig([
-    globalIgnores(["lib/**/*", "bin/**/*"]),
-    eslint.configs.recommended,
-    ...tseslint.configs.recommended,
-    prettierConfig,
-    prettierPlugin,
-    {
-        plugins: {
-            "unused-imports": unusedImports,
-        },
-        rules: {
-            "unused-imports/no-unused-imports": "error",
-        },
-    },
-    {
-        plugins: {
-            "simple-import-sort": simpleImportSort,
-        },
-        rules: {
-            "simple-import-sort/imports": "error",
-            "simple-import-sort/exports": "error",
-        },
-    },
-    {
-        ...importPlugin.flatConfigs.recommended,
-        rules: {
-            "import/no-duplicates": "error",
-            "import/newline-after-import": "error",
-            "import/no-extraneous-dependencies": "error",
-        },
-    },
-    ...eslintPluginJsonc["flat/recommended-with-json"],
-    {
-        ignores: ["package.json"],
-        rules: {
-            "jsonc/sort-keys": "error",
-        },
-    },
-    packageJson.configs.recommended,
-    {
-        ignores: ["*.json"],
-        languageOptions: {
-            globals: {
-                ...globals.node,
-                ...globals.jest,
-            },
-
-            parser: tseslint.parser,
-            parserOptions: {
-                projectService: true,
-                tsconfigRootDir: import.meta.dirname,
-            },
-        },
-        // Rules
-        rules: {
-            "prefer-template": "error",
-            "no-console": ["error", { allow: ["warn", "error", "info", "debug"] }],
-            "no-return-await": "error",
-            "@typescript-eslint/consistent-type-imports": [
-                "error",
-                {
-                    prefer: "type-imports",
-                    disallowTypeAnnotations: false,
-                    fixStyle: "inline-type-imports",
-                },
-            ],
-        },
-    },
-]);

package/jest.config.js

@@ -1,5 +0,0 @@
-module.exports = {
-    testEnvironment: "node",
-    transform: { "^.+\\.tsx?$": "ts-jest" },
-    rootDir: "./src",
-};

package/lib/rules/no-other-module-relative-import.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/rules/no-other-module-relative-import.test.js

@@ -1,37 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var eslint_1 = require("eslint");
-var no_other_module_relative_import_1 = __importDefault(require("./no-other-module-relative-import"));
-var ruleTester = new eslint_1.RuleTester();
-var errors = [{ message: "Avoid relative import from other module" }];
-var options = [{ sourceRoot: "./src", sourceRootAlias: "@src" }];
-ruleTester.run("no-other-module-relative-import", no_other_module_relative_import_1.default, {
-    valid: [
-        {
-            code: "import Bar from \"@src/moduleb/Bar\";",
-            filename: "".concat(process.cwd(), "/src/modulea/Foo.ts"),
-            options: options,
-        },
-        { code: "import Bar from \"../Bar\";", filename: "".concat(process.cwd(), "/src/modulea/sub/Foo.ts"), options: options },
-        { code: "import Bar from \"xx/bar\";", filename: "".concat(process.cwd(), "/src/modulea/Foo.ts"), options: options },
-    ],
-    invalid: [
-        {
-            code: "import Bar from \"../moduleb/Bar\";",
-            filename: "".concat(process.cwd(), "/src/modulea/Foo.ts"),
-            options: options,
-            errors: errors,
-            output: "import Bar from \"@src/moduleb/Bar\";",
-        },
-        {
-            code: "import Bar from \"../../Bar\";",
-            filename: "".concat(process.cwd(), "/src/modulea/sub/Foo.ts"),
-            options: options,
-            errors: errors,
-            output: "import Bar from \"@src/Bar\";",
-        },
-    ],
-});

package/lib/rules/no-private-sibling-import.test.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/rules/no-private-sibling-import.test.js

@@ -1,41 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var eslint_1 = require("eslint");
-var no_private_sibling_import_1 = __importDefault(require("./no-private-sibling-import"));
-var ruleTester = new eslint_1.RuleTester();
-var errors = [{ message: "Avoid private sibling import from other files" }];
-var options = [["gql", "sc", "gql.generated"]];
-ruleTester.run("can't import from private .gql.ts", no_private_sibling_import_1.default, {
-    valid: [
-        { code: "import FooGql from \"./Foo.gql\";", filename: "/path/to/Foo.ts" },
-        { code: "import FooGql from \"./Foo.gql\";", filename: "/path/to/Foo.tsx" },
-    ],
-    invalid: [
-        { code: "import BarGql from \"./Bar.gql\";", filename: "/path/to/Foo.ts", errors: errors },
-        { code: "import BarGql from \"./Bar.gql\";", filename: "/path/to/Foo.tsx", errors: errors },
-    ],
-});
-ruleTester.run("can't import from private .sc.ts", no_private_sibling_import_1.default, {
-    valid: [
-        { code: "import FooSc from \"./Foo.sc\";", filename: "/path/to/Foo.ts" },
-        { code: "import FooSc from \"./Foo.sc\";", filename: "/path/to/Foo.tsx" },
-    ],
-    invalid: [
-        { code: "import BarSc from \"./Bar.sc\";", filename: "/path/to/Foo.ts", errors: errors },
-        { code: "import BarSc from \"./Bar.sc\";", filename: "/path/to/Foo.tsx", errors: errors },
-    ],
-});
-ruleTester.run("can override extensions -> can't import from private .gql.generated.ts", no_private_sibling_import_1.default, {
-    valid: [{ code: "import FooGql from \"./Foo.gql.generated\";", filename: "/path/to/Foo.ts", options: options }],
-    invalid: [{ code: "import BarGql from \"./Bar.gql.generated\";", filename: "/path/to/Foo.ts", options: options, errors: errors }],
-});
-ruleTester.run("can't import from private .loader.gql.ts", no_private_sibling_import_1.default, {
-    valid: [{ code: "import FooGql from \"./FooBlock.loader.gql\";", filename: "/path/to/FooBlock.loader.ts" }],
-    invalid: [
-        { code: "import BarGql from \"./BarBlock.loader.gql\";", filename: "/path/to/FooBlock.loader.ts", errors: errors },
-        { code: "import BarGql from \"./FooBlock.loader.gql\";", filename: "/path/to/FooBlock.ts", errors: errors },
-    ],
-});

package/lint-staged.config.mjs

@@ -1,9 +0,0 @@
-/**
- * @filename: lint-staged.config.mjs
- * @type {import('lint-staged').Configuration}
- */
-export default {
-    "src/**/*.{ts,tsx,js,jsx,json,css,scss,md}": () => "pnpm lint:eslint",
-    "src/**/*.{ts,tsx}": () => "pnpm lint:tsc",
-    "*.{ts,js,json,md,yml,yaml}": () => "pnpm lint:prettier",
-};

package/src/index.ts

@@ -1,12 +0,0 @@
-import noOtherModuleRelativeImport from "./rules/no-other-module-relative-import";
-import noPrivateSiblingImport from "./rules/no-private-sibling-import";
-
-const plugin = {
-    rules: {
-        "no-private-sibling-import": noPrivateSiblingImport,
-        "no-other-module-relative-import": noOtherModuleRelativeImport,
-    },
-};
-export type Plugin = typeof plugin;
-
-module.exports = plugin;

package/src/rules/no-other-module-relative-import.test.ts

@@ -1,38 +0,0 @@
-import { RuleTester } from "eslint";
-
-import noOtherModuleRelativeImport from "./no-other-module-relative-import";
-
-const ruleTester = new RuleTester();
-
-const errors = [{ message: "Avoid relative import from other module" }];
-
-const options = [{ sourceRoot: "./src", sourceRootAlias: "@src" }];
-
-ruleTester.run("no-other-module-relative-import", noOtherModuleRelativeImport, {
-    valid: [
-        {
-            code: `import Bar from "@src/moduleb/Bar";`,
-            filename: `${process.cwd()}/src/modulea/Foo.ts`,
-            options,
-        },
-        { code: `import Bar from "../Bar";`, filename: `${process.cwd()}/src/modulea/sub/Foo.ts`, options },
-        { code: `import Bar from "xx/bar";`, filename: `${process.cwd()}/src/modulea/Foo.ts`, options },
-    ],
-
-    invalid: [
-        {
-            code: `import Bar from "../moduleb/Bar";`,
-            filename: `${process.cwd()}/src/modulea/Foo.ts`,
-            options,
-            errors,
-            output: `import Bar from "@src/moduleb/Bar";`,
-        },
-        {
-            code: `import Bar from "../../Bar";`,
-            filename: `${process.cwd()}/src/modulea/sub/Foo.ts`,
-            options,
-            errors,
-            output: `import Bar from "@src/Bar";`,
-        },
-    ],
-});

package/src/rules/no-other-module-relative-import.ts

@@ -1,68 +0,0 @@
-import { type Rule } from "eslint";
-import path from "path";
-
-function parentDirCount(dir: string) {
-    const match = dir.match(/^(\.\.\/)*/);
-    return match[0].length / 3;
-}
-
-export default {
-    meta: {
-        type: "suggestion",
-        fixable: "code",
-        schema: [
-            {
-                type: "object",
-                properties: {
-                    sourceRoot: {
-                        type: "string",
-                    },
-                    sourceRootAlias: {
-                        type: "string",
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
-    },
-    create(context) {
-        return {
-            ImportDeclaration: function (node) {
-                const options = context.options[0] ?? { sourceRoot: "./src", sourceRootAlias: "@src" };
-
-                const importParentDirCount = parentDirCount(node.source.value.toString());
-                if (!importParentDirCount) {
-                    // import is not relative
-                    return;
-                }
-
-                const filePath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
-                if (filePath == "<text>") return; // If the input is from stdin, this test can't fail
-                const sourceDir = `${context.getCwd()}/${options.sourceRoot}`;
-
-                const fileDir = path.dirname(filePath);
-
-                const relativeFileToSourceDir = path.relative(sourceDir, fileDir);
-                if (!relativeFileToSourceDir || relativeFileToSourceDir.startsWith("..")) {
-                    // file is not in source directory
-                    return;
-                }
-
-                const fileSubdirectoriesCount = relativeFileToSourceDir.split(path.sep).length;
-
-                // importParentDirCount is the number of ../ parts in the import path
-                // fileSubdirectoriesCount is the number of subdirectories in the file path relative to the source directory
-                if (importParentDirCount >= fileSubdirectoriesCount) {
-                    context.report({
-                        node,
-                        message: "Avoid relative import from other module",
-                        fix: (fixer) => {
-                            const importPathRelativeToSourceDir = path.relative(sourceDir, `${fileDir}/${node.source.value.toString()}`);
-                            return fixer.replaceText(node.source, `"${options.sourceRootAlias}/${importPathRelativeToSourceDir}"`);
-                        },
-                    });
-                }
-            },
-        };
-    },
-} as Rule.RuleModule;

package/src/rules/no-private-sibling-import.test.ts

@@ -1,44 +0,0 @@
-import { RuleTester } from "eslint";
-
-import noPrivateSiblingImport from "./no-private-sibling-import";
-
-const ruleTester = new RuleTester();
-
-const errors = [{ message: "Avoid private sibling import from other files" }];
-
-const options = [["gql", "sc", "gql.generated"]];
-
-ruleTester.run("can't import from private .gql.ts", noPrivateSiblingImport, {
-    valid: [
-        { code: `import FooGql from "./Foo.gql";`, filename: "/path/to/Foo.ts" },
-        { code: `import FooGql from "./Foo.gql";`, filename: "/path/to/Foo.tsx" },
-    ],
-    invalid: [
-        { code: `import BarGql from "./Bar.gql";`, filename: "/path/to/Foo.ts", errors },
-        { code: `import BarGql from "./Bar.gql";`, filename: "/path/to/Foo.tsx", errors },
-    ],
-});
-
-ruleTester.run("can't import from private .sc.ts", noPrivateSiblingImport, {
-    valid: [
-        { code: `import FooSc from "./Foo.sc";`, filename: "/path/to/Foo.ts" },
-        { code: `import FooSc from "./Foo.sc";`, filename: "/path/to/Foo.tsx" },
-    ],
-    invalid: [
-        { code: `import BarSc from "./Bar.sc";`, filename: "/path/to/Foo.ts", errors },
-        { code: `import BarSc from "./Bar.sc";`, filename: "/path/to/Foo.tsx", errors },
-    ],
-});
-
-ruleTester.run("can override extensions -> can't import from private .gql.generated.ts", noPrivateSiblingImport, {
-    valid: [{ code: `import FooGql from "./Foo.gql.generated";`, filename: "/path/to/Foo.ts", options }],
-    invalid: [{ code: `import BarGql from "./Bar.gql.generated";`, filename: "/path/to/Foo.ts", options, errors }],
-});
-
-ruleTester.run("can't import from private .loader.gql.ts", noPrivateSiblingImport, {
-    valid: [{ code: `import FooGql from "./FooBlock.loader.gql";`, filename: "/path/to/FooBlock.loader.ts" }],
-    invalid: [
-        { code: `import BarGql from "./BarBlock.loader.gql";`, filename: "/path/to/FooBlock.loader.ts", errors },
-        { code: `import BarGql from "./FooBlock.loader.gql";`, filename: "/path/to/FooBlock.ts", errors },
-    ],
-});

package/src/rules/no-private-sibling-import.ts

@@ -1,57 +0,0 @@
-import { type Rule } from "eslint";
-import path from "path";
-
-export default {
-    meta: {
-        type: "suggestion",
-        schema: [
-            {
-                type: "array",
-                description: "List of private sibling file extensions, defaults to gql, sc",
-                items: {
-                    type: "string",
-                },
-            },
-        ],
-    },
-    create(context) {
-        return {
-            ImportDeclaration: function (node) {
-                const optionSiblingExtensions = context.options[0] ?? ["gql", "sc"];
-                const filePath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
-                if (filePath == "<text>") return; // If the input is from stdin, this test can't fail
-                const isPrivateFileMatch = String(node.source.value).match(new RegExp(`^(.*)\\.(${optionSiblingExtensions.join("|")})$`));
-                if (isPrivateFileMatch) {
-                    if (!isPrivateFileMatch[1].startsWith("./")) {
-                        context.report({
-                            node,
-                            message: "Import private siblings always with relative imports",
-                        });
-                    } else {
-                        let baseName = path.basename(filePath);
-                        if (baseName.endsWith(".tsx")) {
-                            baseName = baseName.slice(0, -4);
-                        } else if (baseName.endsWith(".ts")) {
-                            baseName = baseName.slice(0, -3);
-                        }
-
-                        for (const ext of optionSiblingExtensions) {
-                            const suffix = `.${ext}`;
-                            if (baseName.endsWith(suffix)) {
-                                baseName = baseName.slice(0, -suffix.length);
-                                break;
-                            }
-                        }
-
-                        if (isPrivateFileMatch[1] != `./${baseName}`) {
-                            context.report({
-                                node,
-                                message: "Avoid private sibling import from other files",
-                            });
-                        }
-                    }
-                }
-            },
-        };
-    },
-} as Rule.RuleModule;

package/tsconfig.json

@@ -1,9 +0,0 @@
-{
-    "compilerOptions": {
-        "outDir": "lib",
-        "rootDir": "src"
-    },
-    "exclude": ["node_modules", "lib"],
-    "extends": "../../tsconfig.core.json",
-    "include": ["./src"]
-}