Merge pull request #3155 from Michsior14/fix/relative-compiler-paths

fix(plugin): resolve compiler option paths relative to base
nestjs · Nov 8, 2024 · 3c7451b · 3c7451b
2 parents b230866 + a4e4950
commit 3c7451b
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 12 deletions.
diff --git a/lib/plugin/utils/plugin-utils.ts b/lib/plugin/utils/plugin-utils.ts
@@ -171,15 +171,13 @@ export function replaceImportPath(
       ? convertPath(options.pathToSource)
       : posix.dirname(convertPath(fileName));
 
-    for (const [key, value] of Object.entries(compilerOptionsPaths)) {
-      const keyToMatch = key.replace('*', '');
-      if (importPath.includes(keyToMatch)) {
-        const newImportPath = posix.join(
-          from,
-          importPath.replace(keyToMatch, value[0].replace('*', ''))
-        );
-        typeReference = typeReference.replace(importPath, newImportPath);
-        importPath = newImportPath;
+    for (const [optionName, optionPaths] of Object.entries(
+      compilerOptionsPaths
+    )) {
+      if (importPath.includes(optionName)) {
+        const optionPath = optionPaths[0];
+        typeReference = typeReference.replace(optionName, optionPath);
+        importPath = importPath.replace(optionName, optionPath);
         break;
       }
     }
@@ -210,7 +208,6 @@ export function replaceImportPath(
     }
 
     typeReference = typeReference.replace(importPath, relativePath);
-
     if (options.readonly) {
       const { typeName, typeImportStatement } =
         convertToAsyncImport(typeReference);
@@ -397,3 +394,36 @@ export function canReferenceNode(node: ts.Node, options: PluginOptions) {
   }
   return false;
 }
+
+/**
+ * Get modifies compiler options paths where
+ *
+ * - all `*` are removed from the aliases and paths
+ * - all paths are resolved to absolute paths
+ *
+ * If both `baseUrl` and `pathsBasePath` are not set, the current
+ * compilation directory is used as the base path for resolution.
+ */
+export function getAbsoluteCompilerOptionsPaths(
+  program: ts.Program
+): ts.MapLike<string[]> {
+  const compilerOptions = program.getCompilerOptions();
+  const { paths } = compilerOptions;
+  if (!paths) {
+    return {};
+  }
+
+  const base =
+    (compilerOptions.pathsBasePath as string | undefined) ||
+    compilerOptions.baseUrl ||
+    program.getCurrentDirectory();
+
+  const result: ts.MapLike<string[]> = {};
+  for (const [key, list] of Object.entries(paths)) {
+    result[key.replace('/*', '')] = list.map((item) => {
+      const path = item.replace('/*', '');
+      return isAbsolute(path) ? path : posix.join(base, path);
+    });
+  }
+  return result;
+}
diff --git a/lib/plugin/visitors/controller-class.visitor.ts b/lib/plugin/visitors/controller-class.visitor.ts
@@ -14,6 +14,7 @@ import {
 } from '../utils/ast-utils';
 import {
   convertPath,
+  getAbsoluteCompilerOptionsPaths,
   getDecoratorOrUndefinedByNames,
   getTypeReferenceAsString,
   hasPropertyKey
@@ -58,7 +59,7 @@ export class ControllerClassVisitor extends AbstractFileVisitor {
     options: PluginOptions
   ) {
     const typeChecker = program.getTypeChecker();
-    const compilerOptionsPaths = program.getCompilerOptions().paths ?? {};
+    const compilerOptionsPaths = getAbsoluteCompilerOptionsPaths(program);
     if (!options.readonly) {
       sourceFile = this.updateImports(sourceFile, ctx.factory, program);
     }

diff --git a/lib/plugin/visitors/model-class.visitor.ts b/lib/plugin/visitors/model-class.visitor.ts
@@ -28,6 +28,7 @@ import {
   canReferenceNode,
   convertPath,
   extractTypeArgumentIfArray,
+  getAbsoluteCompilerOptionsPaths,
   getDecoratorOrUndefinedByNames,
   getTypeReferenceAsString,
   hasPropertyKey,
@@ -72,7 +73,7 @@ export class ModelClassVisitor extends AbstractFileVisitor {
   ) {
     const externalImports = getExternalImports(sourceFile);
     const typeChecker = program.getTypeChecker();
-    const compilerOptionsPaths = program.getCompilerOptions().paths ?? {};
+    const compilerOptionsPaths = getAbsoluteCompilerOptionsPaths(program);
     sourceFile = this.updateImports(sourceFile, ctx.factory, program);
 
     const propertyNodeVisitorFactory =