@kurateh/eslint-plugin 0.0.0

package/dist/index.cjs

@@ -0,0 +1,193 @@
+'use strict';
+
+var fs = require('fs');
+var path = require('path');
+var utils = require('@typescript-eslint/utils');
+
+var _documentCurrentScript = typeof document !== 'undefined' ? document.currentScript : null;
+function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
+
+var path__default = /*#__PURE__*/_interopDefault(path);
+
+// src/index.ts
+var createRule = utils.ESLintUtils.RuleCreator.withoutDocs;
+
+// src/rules/import-path.ts
+var posix = path__default.default.posix;
+var TS_CONFIG_FILE_NAMES = ["tsconfig.path.json", "tsconfig.json"];
+var has = (map, path2) => {
+  let inner = map;
+  for (const step of path2.split(".")) {
+    inner = inner[step];
+    if (inner === void 0) {
+      return false;
+    }
+  }
+  return true;
+};
+var normalizePath = (p) => p.replace(/\\/g, "/");
+var findFilePath = (filename, initialPath) => {
+  let dir = initialPath;
+  let lastDir;
+  do {
+    lastDir = dir;
+    dir = posix.dirname(dir);
+  } while (!fs.existsSync(path.join(dir, filename)) && dir !== lastDir);
+  const filePath = path.join(dir, filename);
+  if (!fs.existsSync(filePath)) {
+    return;
+  }
+  return normalizePath(filePath);
+};
+var getAbsolutePathInfo = (fileName) => {
+  const normalizedFileName = normalizePath(fileName);
+  for (const configPath of TS_CONFIG_FILE_NAMES) {
+    const filePath = findFilePath(configPath, normalizedFileName);
+    if (filePath === void 0) {
+      continue;
+    }
+    const baseDir = normalizePath(posix.dirname(filePath));
+    const tsPathConfig = JSON.parse(
+      fs.readFileSync(filePath, {
+        encoding: "utf-8"
+      }).replace(
+        /("(?:[^"\\]|\\.)*")|\/\/.*/g,
+        (_, string) => string || ""
+      ).replace(
+        /("(?:[^"\\]|\\.)*")|\/\*[\s\S]*?\*\//g,
+        (_, string) => string || ""
+      ).replace(/,(?=\s*[\]}])/g, "")
+    );
+    const result = {
+      baseUrl: "",
+      paths: {}
+    };
+    if (has(tsPathConfig, "compilerOptions.baseUrl")) {
+      result.baseUrl = normalizePath(
+        posix.join(baseDir, tsPathConfig.compilerOptions.baseUrl)
+      );
+    }
+    if (has(tsPathConfig, "compilerOptions.paths")) {
+      result.paths = Object.fromEntries(
+        Object.entries(tsPathConfig.compilerOptions.paths).map(
+          ([key, value]) => [
+            key.replace(/\/\*$/, "/"),
+            value.map(
+              (path2) => normalizePath(posix.join(baseDir, path2)).replace(/\/\*$/, "/")
+            )
+          ]
+        )
+      );
+    }
+    return result;
+  }
+  return;
+};
+var import_path_default = createRule({
+  meta: {
+    type: "suggestion",
+    fixable: "code",
+    messages: {
+      shouldBeRelativePath: 'When importing a child module, you must use the relative path. Use "{{expectedPath}}" instead of "{{source}}".',
+      shouldBeAbsolutePath: 'When importing a parent module, you must use the absolute path. Use "{{expectedPath}}" instead of "{{source}}".'
+    },
+    schema: [],
+    docs: {
+      description: "Enforce import path according to the location of the imported file."
+    }
+  },
+  defaultOptions: [],
+  create: (context) => {
+    const fileName = normalizePath(context.filename);
+    const absolutePathInfo = getAbsolutePathInfo(fileName);
+    return {
+      ImportDeclaration: (node) => {
+        if (absolutePathInfo === void 0) {
+          return;
+        }
+        const source = node.source.value;
+        if (source.startsWith("..")) {
+          const sourceAbsolutePath2 = normalizePath(
+            posix.join(posix.dirname(fileName), source)
+          );
+          for (const [alias, paths] of Object.entries(absolutePathInfo.paths)) {
+            for (const path2 of paths) {
+              if (sourceAbsolutePath2.startsWith(path2)) {
+                const expectedPath2 = sourceAbsolutePath2.replace(path2, alias);
+                context.report({
+                  node,
+                  messageId: "shouldBeAbsolutePath",
+                  data: {
+                    expectedPath: expectedPath2,
+                    source
+                  },
+                  fix(fixer) {
+                    return fixer.replaceText(node.source, `"${expectedPath2}"`);
+                  }
+                });
+                return;
+              }
+            }
+          }
+          return;
+        }
+        let sourceAbsolutePath;
+        for (const [alias, paths] of Object.entries(absolutePathInfo.paths)) {
+          for (const path2 of paths) {
+            if (source.startsWith(alias)) {
+              sourceAbsolutePath = normalizePath(
+                posix.join(path2, source.replace(alias, ""))
+              );
+              break;
+            }
+          }
+          if (sourceAbsolutePath !== void 0) {
+            break;
+          }
+        }
+        if (sourceAbsolutePath === void 0) {
+          return;
+        }
+        const sourceRelativePath = normalizePath(
+          posix.relative(posix.dirname(fileName), sourceAbsolutePath)
+        );
+        if (sourceRelativePath.startsWith("..")) {
+          return;
+        }
+        const expectedPath = "./" + sourceRelativePath;
+        context.report({
+          node,
+          messageId: "shouldBeRelativePath",
+          data: {
+            expectedPath,
+            source
+          },
+          fix(fixer) {
+            return fixer.replaceText(node.source, `"${expectedPath}"`);
+          }
+        });
+        return;
+      }
+    };
+  }
+});
+
+// src/rules/index.ts
+var rules_default = {
+  "import-path": import_path_default
+};
+
+// src/index.ts
+var pkg = JSON.parse(
+  fs.readFileSync(new URL("../package.json", (typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('index.cjs', document.baseURI).href))), "utf-8")
+);
+var plugin = {
+  meta: {
+    name: "@kurateh/eslint-plugin",
+    version: pkg.version
+  },
+  rules: rules_default
+};
+var index_default = plugin;
+
+module.exports = index_default;

package/dist/index.d.cts

@@ -0,0 +1,5 @@
+import { ESLint } from 'eslint';
+
+declare const plugin: ESLint.Plugin;
+
+export { plugin as default };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { ESLint } from 'eslint';
+
+declare const plugin: ESLint.Plugin;
+
+export { plugin as default };

package/dist/index.js

@@ -0,0 +1,187 @@
+import { createRequire } from 'module';
+import { readFileSync, existsSync } from 'fs';
+import path, { join } from 'path';
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+createRequire(import.meta.url);
+var createRule = ESLintUtils.RuleCreator.withoutDocs;
+
+// src/rules/import-path.ts
+var posix = path.posix;
+var TS_CONFIG_FILE_NAMES = ["tsconfig.path.json", "tsconfig.json"];
+var has = (map, path2) => {
+  let inner = map;
+  for (const step of path2.split(".")) {
+    inner = inner[step];
+    if (inner === void 0) {
+      return false;
+    }
+  }
+  return true;
+};
+var normalizePath = (p) => p.replace(/\\/g, "/");
+var findFilePath = (filename, initialPath) => {
+  let dir = initialPath;
+  let lastDir;
+  do {
+    lastDir = dir;
+    dir = posix.dirname(dir);
+  } while (!existsSync(join(dir, filename)) && dir !== lastDir);
+  const filePath = join(dir, filename);
+  if (!existsSync(filePath)) {
+    return;
+  }
+  return normalizePath(filePath);
+};
+var getAbsolutePathInfo = (fileName) => {
+  const normalizedFileName = normalizePath(fileName);
+  for (const configPath of TS_CONFIG_FILE_NAMES) {
+    const filePath = findFilePath(configPath, normalizedFileName);
+    if (filePath === void 0) {
+      continue;
+    }
+    const baseDir = normalizePath(posix.dirname(filePath));
+    const tsPathConfig = JSON.parse(
+      readFileSync(filePath, {
+        encoding: "utf-8"
+      }).replace(
+        /("(?:[^"\\]|\\.)*")|\/\/.*/g,
+        (_, string) => string || ""
+      ).replace(
+        /("(?:[^"\\]|\\.)*")|\/\*[\s\S]*?\*\//g,
+        (_, string) => string || ""
+      ).replace(/,(?=\s*[\]}])/g, "")
+    );
+    const result = {
+      baseUrl: "",
+      paths: {}
+    };
+    if (has(tsPathConfig, "compilerOptions.baseUrl")) {
+      result.baseUrl = normalizePath(
+        posix.join(baseDir, tsPathConfig.compilerOptions.baseUrl)
+      );
+    }
+    if (has(tsPathConfig, "compilerOptions.paths")) {
+      result.paths = Object.fromEntries(
+        Object.entries(tsPathConfig.compilerOptions.paths).map(
+          ([key, value]) => [
+            key.replace(/\/\*$/, "/"),
+            value.map(
+              (path2) => normalizePath(posix.join(baseDir, path2)).replace(/\/\*$/, "/")
+            )
+          ]
+        )
+      );
+    }
+    return result;
+  }
+  return;
+};
+var import_path_default = createRule({
+  meta: {
+    type: "suggestion",
+    fixable: "code",
+    messages: {
+      shouldBeRelativePath: 'When importing a child module, you must use the relative path. Use "{{expectedPath}}" instead of "{{source}}".',
+      shouldBeAbsolutePath: 'When importing a parent module, you must use the absolute path. Use "{{expectedPath}}" instead of "{{source}}".'
+    },
+    schema: [],
+    docs: {
+      description: "Enforce import path according to the location of the imported file."
+    }
+  },
+  defaultOptions: [],
+  create: (context) => {
+    const fileName = normalizePath(context.filename);
+    const absolutePathInfo = getAbsolutePathInfo(fileName);
+    return {
+      ImportDeclaration: (node) => {
+        if (absolutePathInfo === void 0) {
+          return;
+        }
+        const source = node.source.value;
+        if (source.startsWith("..")) {
+          const sourceAbsolutePath2 = normalizePath(
+            posix.join(posix.dirname(fileName), source)
+          );
+          for (const [alias, paths] of Object.entries(absolutePathInfo.paths)) {
+            for (const path2 of paths) {
+              if (sourceAbsolutePath2.startsWith(path2)) {
+                const expectedPath2 = sourceAbsolutePath2.replace(path2, alias);
+                context.report({
+                  node,
+                  messageId: "shouldBeAbsolutePath",
+                  data: {
+                    expectedPath: expectedPath2,
+                    source
+                  },
+                  fix(fixer) {
+                    return fixer.replaceText(node.source, `"${expectedPath2}"`);
+                  }
+                });
+                return;
+              }
+            }
+          }
+          return;
+        }
+        let sourceAbsolutePath;
+        for (const [alias, paths] of Object.entries(absolutePathInfo.paths)) {
+          for (const path2 of paths) {
+            if (source.startsWith(alias)) {
+              sourceAbsolutePath = normalizePath(
+                posix.join(path2, source.replace(alias, ""))
+              );
+              break;
+            }
+          }
+          if (sourceAbsolutePath !== void 0) {
+            break;
+          }
+        }
+        if (sourceAbsolutePath === void 0) {
+          return;
+        }
+        const sourceRelativePath = normalizePath(
+          posix.relative(posix.dirname(fileName), sourceAbsolutePath)
+        );
+        if (sourceRelativePath.startsWith("..")) {
+          return;
+        }
+        const expectedPath = "./" + sourceRelativePath;
+        context.report({
+          node,
+          messageId: "shouldBeRelativePath",
+          data: {
+            expectedPath,
+            source
+          },
+          fix(fixer) {
+            return fixer.replaceText(node.source, `"${expectedPath}"`);
+          }
+        });
+        return;
+      }
+    };
+  }
+});
+
+// src/rules/index.ts
+var rules_default = {
+  "import-path": import_path_default
+};
+
+// src/index.ts
+var pkg = JSON.parse(
+  readFileSync(new URL("../package.json", import.meta.url), "utf-8")
+);
+var plugin = {
+  meta: {
+    name: "@kurateh/eslint-plugin",
+    version: pkg.version
+  },
+  rules: rules_default
+};
+var index_default = plugin;
+
+export { index_default as default };

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@kurateh/eslint-plugin",
+  "version": "0.0.0",
+  "description": "",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [],
+  "author": {
+    "name": "kurateh",
+    "email": "me@kurateh.com"
+  },
+  "repository": {
+    "url": "https://github.com/kurateh/ts-configs"
+  },
+  "license": "ISC",
+  "dependencies": {
+    "@typescript-eslint/utils": "^8.59.0"
+  },
+  "devDependencies": {
+    "@types/node": "^24.13.3",
+    "@typescript-eslint/parser": "8.59.0",
+    "@typescript-eslint/rule-tester": "8.59.0",
+    "vitest": "^4.1.10"
+  },
+  "peerDependencies": {
+    "eslint": ">=9"
+  },
+  "scripts": {
+    "build": "tsup",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "test": "vitest run"
+  }
+}