@dextinity/eslint-plugin 2.0.0-canary-20260729062014

package/LICENSE

@@ -0,0 +1,24 @@
+BSD 2-Clause License
+
+Copyright (c) 2023, Vivid Planet Software GmbH
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/lib/index.d.ts

@@ -0,0 +1,8 @@
+declare const plugin: {
+    rules: {
+        "no-private-sibling-import": import("eslint").Rule.RuleModule;
+        "no-other-module-relative-import": import("eslint").Rule.RuleModule;
+    };
+};
+export type Plugin = typeof plugin;
+export {};

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var no_other_module_relative_import_1 = __importDefault(require("./rules/no-other-module-relative-import"));
+var no_private_sibling_import_1 = __importDefault(require("./rules/no-private-sibling-import"));
+var plugin = {
+    rules: {
+        "no-private-sibling-import": no_private_sibling_import_1.default,
+        "no-other-module-relative-import": no_other_module_relative_import_1.default,
+    },
+};
+module.exports = plugin;

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

@@ -0,0 +1,3 @@
+import { type Rule } from "eslint";
+declare const _default: Rule.RuleModule;
+export default _default;

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

@@ -0,0 +1,66 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var path_1 = __importDefault(require("path"));
+function parentDirCount(dir) {
+    var match = dir.match(/^(\.\.\/)*/);
+    return match[0].length / 3;
+}
+exports.default = {
+    meta: {
+        type: "suggestion",
+        fixable: "code",
+        schema: [
+            {
+                type: "object",
+                properties: {
+                    sourceRoot: {
+                        type: "string",
+                    },
+                    sourceRootAlias: {
+                        type: "string",
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    create: function (context) {
+        return {
+            ImportDeclaration: function (node) {
+                var _a;
+                var options = (_a = context.options[0]) !== null && _a !== void 0 ? _a : { sourceRoot: "./src", sourceRootAlias: "@src" };
+                var importParentDirCount = parentDirCount(node.source.value.toString());
+                if (!importParentDirCount) {
+                    // import is not relative
+                    return;
+                }
+                var filePath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+                if (filePath == "<text>")
+                    return; // If the input is from stdin, this test can't fail
+                var sourceDir = "".concat(context.getCwd(), "/").concat(options.sourceRoot);
+                var fileDir = path_1.default.dirname(filePath);
+                var relativeFileToSourceDir = path_1.default.relative(sourceDir, fileDir);
+                if (!relativeFileToSourceDir || relativeFileToSourceDir.startsWith("..")) {
+                    // file is not in source directory
+                    return;
+                }
+                var fileSubdirectoriesCount = relativeFileToSourceDir.split(path_1.default.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: node,
+                        message: "Avoid relative import from other module",
+                        fix: function (fixer) {
+                            var importPathRelativeToSourceDir = path_1.default.relative(sourceDir, "".concat(fileDir, "/").concat(node.source.value.toString()));
+                            return fixer.replaceText(node.source, "\"".concat(options.sourceRootAlias, "/").concat(importPathRelativeToSourceDir, "\""));
+                        },
+                    });
+                }
+            },
+        };
+    },
+};

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

@@ -0,0 +1,3 @@
+import { type Rule } from "eslint";
+declare const _default: Rule.RuleModule;
+export default _default;

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

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var path_1 = __importDefault(require("path"));
+exports.default = {
+    meta: {
+        type: "suggestion",
+        schema: [
+            {
+                type: "array",
+                description: "List of private sibling file extensions, defaults to gql, sc",
+                items: {
+                    type: "string",
+                },
+            },
+        ],
+    },
+    create: function (context) {
+        return {
+            ImportDeclaration: function (node) {
+                var _a;
+                var optionSiblingExtensions = (_a = context.options[0]) !== null && _a !== void 0 ? _a : ["gql", "sc"];
+                var filePath = context.getPhysicalFilename ? context.getPhysicalFilename() : context.getFilename();
+                if (filePath == "<text>")
+                    return; // If the input is from stdin, this test can't fail
+                var isPrivateFileMatch = String(node.source.value).match(new RegExp("^(.*)\\.(".concat(optionSiblingExtensions.join("|"), ")$")));
+                if (isPrivateFileMatch) {
+                    if (!isPrivateFileMatch[1].startsWith("./")) {
+                        context.report({
+                            node: node,
+                            message: "Import private siblings always with relative imports",
+                        });
+                    }
+                    else {
+                        var baseName = path_1.default.basename(filePath);
+                        if (baseName.endsWith(".tsx")) {
+                            baseName = baseName.slice(0, -4);
+                        }
+                        else if (baseName.endsWith(".ts")) {
+                            baseName = baseName.slice(0, -3);
+                        }
+                        for (var _i = 0, optionSiblingExtensions_1 = optionSiblingExtensions; _i < optionSiblingExtensions_1.length; _i++) {
+                            var ext = optionSiblingExtensions_1[_i];
+                            var suffix = ".".concat(ext);
+                            if (baseName.endsWith(suffix)) {
+                                baseName = baseName.slice(0, -suffix.length);
+                                break;
+                            }
+                        }
+                        if (isPrivateFileMatch[1] != "./".concat(baseName)) {
+                            context.report({
+                                node: node,
+                                message: "Avoid private sibling import from other files",
+                            });
+                        }
+                    }
+                }
+            },
+        };
+    },
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@dextinity/eslint-plugin",
+  "version": "2.0.0-canary-20260729062014",
+  "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",
+    "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.91.2",
+    "eslint-plugin-prettier": "^5.5.6",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "eslint-plugin-unused-imports": "^4.4.1",
+    "globals": "^15.15.0",
+    "npm-run-all2": "^8.0.4",
+    "prettier": "^3.6.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.62.1",
+    "vitest": "^4.1.8"
+  },
+  "peerDependencies": {
+    "eslint": ">=9",
+    "prettier": ">=3"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "pnpm run clean && tsc --project ./tsconfig.build.json",
+    "clean": "rimraf lib",
+    "dev": "tsc --watch",
+    "lint": "run-p lint:prettier lint:eslint lint:tsc",
+    "lint:ci": "pnpm run lint",
+    "lint:eslint": "eslint --max-warnings 0 src/ '**/*.json' --no-warn-ignored",
+    "lint:fix": "run-p lint:fix:eslint lint:fix:prettier",
+    "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 --noEmit",
+    "test": "pnpm run test:unit",
+    "test:unit": "vitest --run",
+    "test:watch": "vitest --watch"
+  }
+}