docs: added docs for prefer-aliased-path

README.md

@@ -8,3 +8,4 @@ This ESLint plugin currently contains 2 rules:
 
 - [prefer-destructured-optionals](./docs/rules/prefer-destructured-optionals.md)
 - [valid-event-listener](./docs/rules/valid-event-listener.md)
+- [prefer-aliased-path](./docs/rules/prefer-aliased-path.md)

docs/rules/prefer-aliased-path.md

@@ -0,0 +1,32 @@
+# Suggest using a package.json alias subpath import instead of a relative import
+
+This rule enforce to prefer using a [package.json alias subpath import](https://nodejs.org/api/packages.html#imports) path instead of a relative path, where possible.
+
+## Examples
+
+Given package.json:
+
+```json
+{
+  "name": "dummy-package-json",
+  "imports": {
+    "#helpers/*": "./src/helpers/*.ts"
+  }
+}
+```
+
+### Fail
+
+```js
+import { myHelper } from "./src/helpers/myHelper";
+```
+
+### Pass
+
+```js
+import { myHelper } from "#helpers/myHelper";
+```
+
+```js
+import { myHook } from "./hooks/myHook";
+```

src/index.ts

@@ -1,3 +1,4 @@
+import preferAliasedPath from "./rules/prefer-aliased-path";
 import preferDestructuredOptionals from "./rules/prefer-destructured-optionals";
 import validEventListener from "./rules/valid-event-listener";
 
@@ -9,6 +10,7 @@ const plugin = {
   rules: {
     "prefer-destructured-optionals": preferDestructuredOptionals,
     "valid-event-listener": validEventListener,
+    "prefer-aliased-path": preferAliasedPath,
   },
 };
 

src/rules/prefer-aliased-path.test.ts

@@ -4,7 +4,14 @@ import rule, { RULE_NAME } from "./prefer-aliased-path";
 
 const valids = [
   `import { myHelper } from "#helpers/myHelper";`,
+  `import myHelper from "#helpers/myHelper";`,
+  `import { myHelper } from "./helpers/myHelper";`,
   `import { myHook } from "./hooks/myHook";`,
+  `import myHook from "./hooks/myHook";`,
+  `import { myHook } from "../hooks/myHook";`,
+  `import myHook from "../hooks/myHook";`,
+  `const myHook = require("../../hooks/myHook");`,
+  `const { myHook } = require("../../hooks/myHook");`,
 ];
 
 const invalids = [[`import { myHelper } from "./src/helpers/myHelper";`]];

src/rules/prefer-aliased-path.ts

@@ -1,4 +1,4 @@
-import { readPackageUpSync } from "read-package-up";
+import { readPackageUpSync, type ReadResult } from "read-package-up";
 import { minimatch } from "minimatch";
 import { createEslintRule } from "../utils";
 
@@ -28,21 +28,35 @@ export default createEslintRule<Options, MessageIds>({
   },
   defaultOptions: [],
   create(context) {
+    let packageJson;
+    const sourceCode = context.getSourceCode();
+
+    sourceCode.ast.body.some((node) => {
+      if (node.type === "ImportDeclaration") {
+        const packagePath = node.source.value;
+
+        if (packagePath.startsWith(".")) {
+          const currentLocalDirectory = new URL(".", import.meta.url);
+          packageJson = readPackageUpSync({
+            cwd: currentLocalDirectory,
+          });
+        }
+      }
+      if (packageJson) {
+        return true;
+      }
+    });
+
+    if (!packageJson?.packageJson?.imports) {
+      return {};
+    }
+
     return {
       ImportDeclaration(node) {
         if (node.type === "ImportDeclaration") {
           const packagePath = node.source.value;
 
           if (packagePath.startsWith(".")) {
-            const currentLocalDirectory = new URL(".", import.meta.url);
-            const packageJson = readPackageUpSync({
-              cwd: currentLocalDirectory,
-            });
-
-            if (!packageJson?.packageJson?.imports) {
-              return;
-            }
-
             const importAliases = Object.values(
               packageJson.packageJson.imports,
             );