fix: False-positive no-extraneous-import when using the tsconfig > paths alias import (#408)

MorevM · web-flow · commit f48649239392 · 2025-02-23T11:48:50.000+08:00
diff --git a/lib/util/import-target.js b/lib/util/import-target.js
@@ -176,6 +176,20 @@ module.exports = class ImportTarget {
             return "node"
         }
 
+        // This check should be done before the RegExp that checks npm packages,
+        // because `tsconfig.json` aliases may start with `~`, `@` and this will
+        // cause imports using aliases to be treated as npm-module imports
+        // https://github.com/eslint-community/eslint-plugin-n/issues/379
+        if (isTypescript(this.context)) {
+            const aliases = getTSConfigAliases(this.context)
+            if (
+                Array.isArray(aliases) &&
+                aliases.some(alias => this.name.startsWith(alias.name))
+            ) {
+                return "relative"
+            }
+        }
+
         if (/^(@[\w~-][\w.~-]*\/)?[\w~-][\w.~-]*/.test(this.name)) {
             return "npm"
         }
diff --git a/tests/fixtures/no-extraneous/tsconfig-paths/index.ts b/tests/fixtures/no-extraneous/tsconfig-paths/index.ts
@@ -0,0 +1 @@
+// File needs to exists
diff --git a/tests/fixtures/no-extraneous/tsconfig-paths/src/configurations/foo.ts b/tests/fixtures/no-extraneous/tsconfig-paths/src/configurations/foo.ts
@@ -0,0 +1 @@
+export default {};
diff --git a/tests/fixtures/no-extraneous/tsconfig-paths/tsconfig.json b/tests/fixtures/no-extraneous/tsconfig-paths/tsconfig.json
@@ -0,0 +1,9 @@
+{
+    "compilerOptions": {
+        "paths": {
+            "~configurations/*": ["./src/configurations/*"],
+            "@configurations/*": ["./src/configurations/*"],
+            "#configurations/*": ["./src/configurations/*"]
+        }
+    }
+}
diff --git a/tests/lib/rules/no-extraneous-import.js b/tests/lib/rules/no-extraneous-import.js
@@ -33,6 +33,11 @@ function fixture(name) {
 
 const ruleTester = new RuleTester({
     languageOptions: { sourceType: "module" },
+    settings: {
+        n: {
+            tryExtensions: [".ts"],
+        },
+    },
 })
 ruleTester.run("no-extraneous-import", rule, {
     valid: [
@@ -78,6 +83,21 @@ ruleTester.run("no-extraneous-import", rule, {
             filename: fixture("dependencies/a.js"),
             code: "import ccc from 'ccc'",
         },
+
+        // imports using `tsconfig.json > compilerOptions > paths` setting
+        // https://github.com/eslint-community/eslint-plugin-n/issues/379
+        {
+            filename: fixture("tsconfig-paths/index.ts"),
+            code: "import foo from '@configurations/foo'",
+        },
+        {
+            filename: fixture("tsconfig-paths/index.ts"),
+            code: "import foo from '~configurations/foo'",
+        },
+        {
+            filename: fixture("tsconfig-paths/index.ts"),
+            code: "import foo from '#configurations/foo'",
+        },
     ],
     invalid: [
         {
