fix: External project references not resolved properly in composite projects (fixes #125)

nonara · nonara · commit 4a1639619905 · 2021-08-16T14:34:37.000-04:00
diff --git a/src/utils/ts-helpers.ts b/src/utils/ts-helpers.ts
@@ -21,11 +21,13 @@ export function getOutputDirForSourceFile(context: VisitorContext, sourceFile: S
 
   if (outputFileNamesCache.has(sourceFile)) return outputFileNamesCache.get(sourceFile)!;
 
-  const outputPath = getOwnEmitOutputFilePath(
-    sourceFile.fileName,
-    emitHost,
-    getOutputExtension(sourceFile, compilerOptions)
-  );
+  // Note: In project references, resolved path is different from path. In that case, our output path is already
+  // determined in resolvedPath
+  const outputPath =
+    sourceFile.path && sourceFile.resolvedPath && sourceFile.path !== sourceFile.resolvedPath
+      ? sourceFile.resolvedPath
+      : getOwnEmitOutputFilePath(sourceFile.fileName, emitHost, getOutputExtension(sourceFile, compilerOptions));
+
   if (!outputPath)
     throw new Error(
       `Could not resolve output path for ${sourceFile.fileName}. Please report a GH issue at: ` +
diff --git a/test/config.ts b/test/config.ts
@@ -16,13 +16,14 @@ export const tsThree: typeof TypeScriptThree = require("typescript-three");
 /* ****************************************************************************************************************** */
 
 export const tsModules = <const>[
-  ["Latest", ts, "typescript"],
   ["3.6.5", tsThree, "typescript-three"],
+  ["Latest", ts, "typescript"],
 ];
-export const projectsPaths = path.join(__dirname, "../projects");
-Error.stackTraceLimit = 120;
 
-export const transformerPath = path.resolve(__dirname, "../../src/index.ts");
-export const builtTransformerPath = path.resolve(__dirname, "../../dist/index.js");
+export const projectsPaths = path.join(__dirname, "./projects");
+export const transformerPath = path.resolve(__dirname, "../src/index.ts");
+export const builtTransformerPath = path.resolve(__dirname, "../dist/index.js");
+
+Error.stackTraceLimit = 120;
 
 // endregion
diff --git a/test/projects/project-ref/a/index.ts b/test/projects/project-ref/a/index.ts
@@ -0,0 +1 @@
+export const AReffedConst = 43;
diff --git a/test/projects/project-ref/a/tsconfig.json b/test/projects/project-ref/a/tsconfig.json
@@ -0,0 +1,8 @@
+{
+  "files": [ "index.ts" ],
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "../lib/a",
+    "declaration": true
+  }
+}
diff --git a/test/projects/project-ref/b/index.ts b/test/projects/project-ref/b/index.ts
@@ -0,0 +1,2 @@
+export { AReffedConst } from "#a/index";
+export { LocalConst } from "#b/local/index";
diff --git a/test/projects/project-ref/b/local/index.ts b/test/projects/project-ref/b/local/index.ts
@@ -0,0 +1 @@
+export const LocalConst = 55;
diff --git a/test/projects/project-ref/b/tsconfig.json b/test/projects/project-ref/b/tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "files": [ "index.ts", "local/index.ts" ],
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "../lib/b",
+  },
+  "references": [
+    {
+      "path": "../a"
+    }
+  ]
+}
diff --git a/test/projects/project-ref/package.json b/test/projects/project-ref/package.json
@@ -0,0 +1,8 @@
+{
+  "private": true,
+  "name": "@tests/project-ref",
+  "version": "0.0.0",
+  "dependencies": {
+    "typescript-transform-paths": "link:../../../"
+  }
+}
diff --git a/test/projects/project-ref/tsconfig.base.json b/test/projects/project-ref/tsconfig.base.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "target": "ESNext",
+    "composite": true,
+    "declaration": true,
+
+    "baseUrl": ".",
+    "paths": {
+      "#a/*": [ "./a/*" ],
+      "#b/*": [ "./b/*" ]
+    },
+    "plugins": [
+      {
+        "transform": "./src/index.ts",
+      },
+      {
+        "transform": "./src/index.ts",
+        "afterDeclarations": true
+      }
+    ]
+  }
+}
diff --git a/test/projects/project-ref/tsconfig.json b/test/projects/project-ref/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "references": [
+    {
+      "path": "./a"
+    },
+    {
+      "path": "./b"
+    }
+  ]
+}
diff --git a/test/tests/extras.test.ts b/test/tests/extras.test.ts
@@ -1,8 +1,8 @@
 import { createTsProgram, getEmitResultFromProgram } from "../utils";
-import { projectsPaths } from "./config";
+import { projectsPaths } from "../config";
 import path from "path";
 import ts from "typescript";
-import * as config from "./config";
+import * as config from "../config";
 import { execSync } from "child_process";
 
 /* ****************************************************************************************************************** *
diff --git a/test/tests/project-ref.test.ts b/test/tests/project-ref.test.ts
@@ -0,0 +1,37 @@
+// noinspection ES6UnusedImports
+import {} from "ts-expose-internals";
+import * as path from "path";
+import { createTsSolutionBuilder, EmittedFiles } from "../utils";
+import { projectsPaths, ts } from "../config";
+
+/* ****************************************************************************************************************** *
+ * Config
+ * ****************************************************************************************************************** */
+
+/* File Paths */
+const projectDir = ts.normalizePath(path.join(projectsPaths, "project-ref"));
+const indexFile = ts.normalizePath(path.join(projectDir, "lib/b/index.ts"));
+
+/* ****************************************************************************************************************** *
+ * Tests
+ * ****************************************************************************************************************** */
+
+// see: https://github.com/LeDDGroup/typescript-transform-paths/issues/125
+describe(`Project References`, () => {
+  let emittedFiles: EmittedFiles;
+
+  beforeAll(() => {
+    const builder = createTsSolutionBuilder({ tsInstance: ts, projectDir });
+    emittedFiles = builder.getEmitFiles();
+  });
+
+  test(`Specifier for referenced project file resolves properly`, () => {
+    expect(emittedFiles[indexFile].js).toMatch(`export { AReffedConst } from "../a/index"`);
+    expect(emittedFiles[indexFile].dts).toMatch(`export { AReffedConst } from "../a/index"`);
+  });
+
+  test(`Specifier for local file resolves properly`, () => {
+    expect(emittedFiles[indexFile].js).toMatch(`export { LocalConst } from "./local/index"`);
+    expect(emittedFiles[indexFile].dts).toMatch(`export { LocalConst } from "./local/index"`);
+  });
+});
diff --git a/test/tests/transformer/general.test.ts b/test/tests/transformer/general.test.ts
@@ -2,7 +2,7 @@
 import {} from "ts-expose-internals";
 import * as path from "path";
 import { createTsProgram, EmittedFiles, getEmitResultFromProgram } from "../../utils";
-import { ts, tsModules, projectsPaths } from "../config";
+import { ts, tsModules, projectsPaths } from "../../config";
 
 /* ****************************************************************************************************************** *
  * Helpers
diff --git a/test/tests/transformer/specific.test.ts b/test/tests/transformer/specific.test.ts
@@ -8,8 +8,8 @@ import {
   getManualEmitResult,
   getTsNodeEmitResult,
 } from "../../utils";
-import { projectsPaths, ts, tsModules } from "../config";
-import { TsTransformPathsConfig } from '../../../src';
+import { projectsPaths, ts, tsModules } from "../../config";
+import { TsTransformPathsConfig } from "../../../src";
 import TS from "typescript";
 
 /* ****************************************************************************************************************** *
diff --git a/test/utils/helpers.ts b/test/utils/helpers.ts
@@ -2,7 +2,7 @@ import { default as tstpTransform, TsTransformPathsConfig } from "../../src";
 import fs from "fs";
 import ts from "typescript";
 import * as tsNode from "ts-node";
-import * as config from "../tests/config";
+import * as config from "../config";
 
 /* ****************************************************************************************************************** */
 // region: Types
@@ -11,14 +11,49 @@ import * as config from "../tests/config";
 export type EmittedFiles = { [fileName: string]: { js: string; dts: string } };
 
 export interface CreateTsProgramOptions {
-  tsInstance: any;
+  tsInstance: typeof ts;
   files?: { [fileName: string]: /* data */ string };
   tsConfigFile?: string;
   disablePlugin?: boolean;
   additionalOptions?: ts.CompilerOptions;
   pluginOptions?: TsTransformPathsConfig;
 }
 
+export interface CreateTsSolutionBuilderOptions {
+  tsInstance: typeof ts;
+  projectDir: string;
+}
+
+// endregion
+
+/* ****************************************************************************************************************** */
+// region: Helpers
+/* ****************************************************************************************************************** */
+
+function createWriteFile(outputFiles: EmittedFiles) {
+  return (fileName: string, data: string) => {
+    let { 1: rootName, 2: ext } = fileName.match(/(.+)\.((d.ts)|(js))$/) ?? [];
+    if (!ext) return;
+    rootName = `${rootName}.ts`;
+    const key = ext.replace(".", "") as keyof EmittedFiles[string];
+    if (!outputFiles[rootName]) outputFiles[rootName] = <any>{};
+    outputFiles[rootName][key] = data;
+  };
+}
+
+function createReadFile(outputFiles: EmittedFiles, originalReadFile: Function) {
+  return (fileName: string) => {
+    let { 1: rootName, 2: ext } = fileName.match(/(.+)\.((d.ts)|(js))$/) ?? [];
+    if (ext) {
+      rootName = `${rootName}.ts`;
+      const key = ext.replace(".", "") as keyof EmittedFiles[string];
+      const res = outputFiles[rootName]?.[key];
+      if (res) return res;
+    }
+    return originalReadFile(fileName);
+  };
+}
+
 // endregion
 
 /* ****************************************************************************************************************** */
@@ -83,24 +118,36 @@ export function createTsProgram(
   return tsInstance.createProgram({ options: compilerOptions, rootNames: fileNames, host });
 }
 
+export function createTsSolutionBuilder(
+  opt: CreateTsSolutionBuilderOptions
+): ts.SolutionBuilder<ts.BuilderProgram> & { getEmitFiles(): EmittedFiles } {
+  const { tsInstance, projectDir } = opt;
+
+  const outputFiles: EmittedFiles = {};
+
+  const host = tsInstance.createSolutionBuilderHost();
+  const originalReadFile = host.readFile;
+  Object.assign(host, {
+    readFile: createReadFile(outputFiles, originalReadFile),
+    writeFile: createWriteFile(outputFiles),
+  });
+
+  const builder = tsInstance.createSolutionBuilder(host, [projectDir], { force: true });
+
+  return Object.assign(builder, {
+    getEmitFiles() {
+      builder.build();
+      return outputFiles;
+    },
+  });
+}
+
 /**
  * Get emitted files for program
- * @param program
  */
 export function getEmitResultFromProgram(program: ts.Program): EmittedFiles {
   const outputFiles: EmittedFiles = {};
-
-  const writeFile = (fileName: string, data: string) => {
-    let { 1: rootName, 2: ext } = fileName.match(/(.+)\.((d.ts)|(js))$/) ?? [];
-    if (!ext) return;
-    rootName = `${rootName}.ts`;
-    const key = ext.replace(".", "") as keyof EmittedFiles[string];
-    if (!outputFiles[rootName]) outputFiles[rootName] = <any>{};
-    outputFiles[rootName][key] = data;
-  };
-
-  program.emit(undefined, writeFile);
-
+  program.emit(undefined, createWriteFile(outputFiles));
   return outputFiles;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export { AReffedConst } from "#a/index";`
	`2`	`+export { LocalConst } from "#b/local/index";`