Move from convertPathsToAlias → compilePathMappings (resolve #1641)

webpro · webpro · commit ccc62d6840a7 · 2026-03-26T08:39:01.000+01:00
diff --git a/packages/knip/fixtures/path-aliases/index.ts b/packages/knip/fixtures/path-aliases/index.ts
@@ -3,8 +3,10 @@ import fn from '@lib/fn';
 import customExt from '@lib/data.ext';
 import js from 'xyz/main.js';
 import anything from '~/my-module';
+import icon from '~icons/material-symbols/more-horiz';
 customExt;
 index;
 fn;
 js;
 anything;
+icon;
diff --git a/packages/knip/fixtures/path-aliases/knip.json b/packages/knip/fixtures/path-aliases/knip.json
@@ -3,6 +3,7 @@
     "~/*": ["./*"],
     "@lib": ["./lib/index.ts"],
     "@lib/*": ["./lib/*"],
-    "xyz/*": ["abc/*"]
+    "xyz/*": ["abc/*"],
+    "~icons/*": ["./types/virtual.d.ts"]
   }
 }
diff --git a/packages/knip/fixtures/path-aliases/types/virtual.d.ts b/packages/knip/fixtures/path-aliases/types/virtual.d.ts
@@ -0,0 +1,4 @@
+declare module '~icons/*' {
+  const component: object;
+  export default component;
+}
diff --git a/packages/knip/src/typescript/resolve-module-names.ts b/packages/knip/src/typescript/resolve-module-names.ts
@@ -4,10 +4,30 @@ import { DEFAULT_EXTENSIONS, DTS_EXTENSIONS } from '../constants.ts';
 import { sanitizeSpecifier } from '../util/modules.ts';
 import { timerify } from '../util/Performance.ts';
 import { dirname, extname, isAbsolute, isInNodeModules, join } from '../util/path.ts';
-import { _createSyncModuleResolver, _resolveModuleSync, convertPathsToAlias } from '../util/resolve.ts';
+import { _createSyncModuleResolver, _resolveModuleSync } from '../util/resolve.ts';
 import type { ToSourceFilePath } from '../util/to-source-path.ts';
 import type { ResolveModule, ResolvedModule } from './visitors/helpers.ts';
 
+interface PathMapping {
+  prefix: string;
+  wildcard: boolean;
+  values: string[];
+}
+
+function compilePathMappings(paths: Record<string, string[]> | undefined): PathMapping[] | undefined {
+  if (!paths) return undefined;
+  const mappings: PathMapping[] = [];
+  for (const key in paths) {
+    const starIdx = key.indexOf('*');
+    if (starIdx >= 0) {
+      mappings.push({ prefix: key.slice(0, starIdx), wildcard: true, values: paths[key] });
+    } else {
+      mappings.push({ prefix: key, wildcard: false, values: paths[key] });
+    }
+  }
+  return mappings.length > 0 ? mappings : undefined;
+}
+
 export function createCustomModuleResolver(
   compilerOptions: { paths?: Record<string, string[]>; rootDirs?: string[] },
   customCompilerExtensions: string[],
@@ -16,9 +36,8 @@ export function createCustomModuleResolver(
   const customCompilerExtensionsSet = new Set(customCompilerExtensions);
   const hasCustomExts = customCompilerExtensionsSet.size > 0;
   const extensions = [...DEFAULT_EXTENSIONS, ...customCompilerExtensions, ...DTS_EXTENSIONS];
-  const alias = convertPathsToAlias(compilerOptions.paths as Record<string, string[]>);
   const resolveSync = hasCustomExts ? _createSyncModuleResolver(extensions) : _resolveModuleSync;
-  const resolveWithAlias = alias ? _createSyncModuleResolver(extensions, alias) : undefined;
+  const pathMappings = compilePathMappings(compilerOptions.paths as Record<string, string[]>);
   const rootDirs = compilerOptions.rootDirs;
 
   function toSourcePath(resolvedFileName: string): string {
@@ -37,38 +56,47 @@ export function createCustomModuleResolver(
   }
 
   function resolveModuleName(name: string, containingFile: string): ResolvedModule | undefined {
-    const sanitizedSpecifier = sanitizeSpecifier(name);
+    const specifier = sanitizeSpecifier(name);
 
-    if (isBuiltin(sanitizedSpecifier)) return undefined;
+    if (isBuiltin(specifier)) return undefined;
 
-    const resolvedFileName = resolveSync(sanitizedSpecifier, containingFile);
+    const resolvedFileName = resolveSync(specifier, containingFile);
     if (resolvedFileName) return toResult(resolvedFileName);
 
-    if (resolveWithAlias) {
-      const aliasResolved = resolveWithAlias(sanitizedSpecifier, containingFile);
-      if (aliasResolved) return toResult(aliasResolved);
-    }
-
-    const candidate = isAbsolute(sanitizedSpecifier)
-      ? sanitizedSpecifier
-      : join(dirname(containingFile), sanitizedSpecifier);
-    if (existsSync(candidate)) {
-      return { resolvedFileName: candidate, isExternalLibraryImport: false };
+    // Fallback for knip.json#paths not in tsconfig.json#compilerOptions.paths
+    if (pathMappings) {
+      for (const { prefix, wildcard, values } of pathMappings) {
+        if (wildcard ? specifier.startsWith(prefix) : specifier === prefix) {
+          const captured = wildcard ? specifier.slice(prefix.length) : '';
+          for (const value of values) {
+            const starIdx = value.indexOf('*');
+            const mapped = starIdx >= 0 ? value.slice(0, starIdx) + captured + value.slice(starIdx + 1) : value;
+            const resolved = resolveSync(mapped, containingFile);
+            if (resolved) return toResult(resolved);
+          }
+        }
+      }
     }
 
-    if (rootDirs && !isAbsolute(sanitizedSpecifier)) {
+    // Fallback for https://github.com/oxc-project/oxc-resolver/issues/1075
+    if (rootDirs && !isAbsolute(specifier)) {
       const containingDir = dirname(containingFile);
       for (const srcRoot of rootDirs) {
         if (!containingDir.startsWith(srcRoot)) continue;
         const relPath = containingDir.slice(srcRoot.length);
         for (const targetRoot of rootDirs) {
           if (targetRoot === srcRoot) continue;
-          const mapped = join(targetRoot, relPath, sanitizedSpecifier);
+          const mapped = join(targetRoot, relPath, specifier);
           const resolved = resolveSync(mapped, containingFile);
           if (resolved) return toResult(resolved);
         }
       }
     }
+
+    const candidate = isAbsolute(specifier) ? specifier : join(dirname(containingFile), specifier);
+    if (existsSync(candidate)) {
+      return { resolvedFileName: candidate, isExternalLibraryImport: false };
+    }
   }
 
   return timerify(resolveModuleName);
diff --git a/packages/knip/src/util/resolve.ts b/packages/knip/src/util/resolve.ts
@@ -43,20 +43,8 @@ const resolveModuleSync = createSyncModuleResolver([...DEFAULT_EXTENSIONS, ...DT
  */
 export const _resolveModuleSync = timerify(resolveModuleSync, 'resolveModuleSync');
 
-export const _createSyncModuleResolver = (extensions: string[], alias?: Record<string, string[]>) =>
-  timerify(createSyncModuleResolver(extensions, alias), 'resolveModuleSync');
-
-/** Convert TS compilerOptions.paths to oxc-resolver alias format */
-export function convertPathsToAlias(paths: Record<string, string[]> | undefined): Record<string, string[]> | undefined {
-  if (!paths) return undefined;
-  const alias: Record<string, string[]> = {};
-  for (const key in paths) {
-    const stripWildcard = key.endsWith('/*');
-    const aliasKey = stripWildcard ? key.slice(0, -2) : key;
-    alias[aliasKey] = stripWildcard ? paths[key].map(v => (v.endsWith('/*') ? v.slice(0, -2) : v)) : paths[key];
-  }
-  return alias;
-}
+export const _createSyncModuleResolver = (extensions: string[]) =>
+  timerify(createSyncModuleResolver(extensions), 'resolveModuleSync');
 
 const createSyncResolver = (extensions: string[]) => {
   const resolver = new ResolverFactory({
diff --git a/packages/knip/test/path-aliases.test.ts b/packages/knip/test/path-aliases.test.ts
@@ -13,7 +13,7 @@ test('Resolve import path aliases', async () => {
 
   assert.deepEqual(counters, {
     ...baseCounters,
-    processed: 5,
-    total: 5,
+    processed: 6,
+    total: 6,
   });
 });

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`"~/": ["./"],`
`4`	`4`	`"@lib": ["./lib/index.ts"],`
`5`	`5`	`"@lib/": ["./lib/"],`
`6`		`- "xyz/": ["abc/"]`
	`6`	`+ "xyz/": ["abc/"],`
	`7`	`+ "~icons/*": ["./types/virtual.d.ts"]`
`7`	`8`	`}`
`8`	`9`	`}`