Allow moduleresolution plugins to return an absolute path (#1496)

Perryvw · web-flow · commit 2d4202563660 · 2023-10-01T16:00:34.000+02:00
diff --git a/src/transpilation/resolve.ts b/src/transpilation/resolve.ts
@@ -112,6 +112,11 @@ class ResolutionContext {
                     this.emitHost
                 );
                 if (pluginResolvedPath !== undefined) {
+                    // If resolved path is absolute no need to further resolve it
+                    if (path.isAbsolute(pluginResolvedPath)) {
+                        return pluginResolvedPath;
+                    }
+
                     // If lua file is in node_module
                     if (requiredFromLuaFile && isNodeModulesFile(requiringFile.fileName)) {
                         // If requiring file is in lua module, try to resolve sibling in that file first
diff --git a/test/transpile/module-resolution.spec.ts b/test/transpile/module-resolution.spec.ts
@@ -714,9 +714,9 @@ test("paths without baseUrl is error", () => {
 test("module resolution using plugin", () => {
     const baseProjectPath = path.resolve(__dirname, "module-resolution", "project-with-module-resolution-plugin");
     const projectTsConfig = path.join(baseProjectPath, "tsconfig.json");
-    const mainFile = path.join(baseProjectPath, "src", "main.ts");
+    const mainFile = path.join(baseProjectPath, "main.ts");
 
-    const luaResult = util
+    const testBuilder = util
         .testProject(projectTsConfig)
         .setMainFileName(mainFile)
         .setOptions({
@@ -726,19 +726,13 @@ test("module resolution using plugin", () => {
                 },
             ],
         })
-        .expectToHaveNoDiagnostics()
-        .getLuaResult();
+        .expectToHaveNoDiagnostics();
 
-    expect(luaResult.transpiledFiles).toHaveLength(2);
-    let hasResolvedFile = false;
-    for (const f of luaResult.transpiledFiles) {
-        hasResolvedFile = f.outPath.endsWith("bar.lua");
-        if (hasResolvedFile) {
-            break;
-        }
-    }
+    const luaResult = testBuilder.getLuaResult();
+
+    expect(luaResult.transpiledFiles).toHaveLength(3);
 
-    expect(hasResolvedFile).toBe(true);
+    testBuilder.expectToEqual({ result: ["foo", "absolutefoo"] });
 });
 
 function snapshotPaths(files: tstl.TranspiledFile[]) {
diff --git a/test/transpile/module-resolution/project-with-module-resolution-plugin/lua_sources/absolutebar.lua b/test/transpile/module-resolution/project-with-module-resolution-plugin/lua_sources/absolutebar.lua
@@ -0,0 +1,5 @@
+local ____exports = {}
+function ____exports.absolutefoo(self)
+    return "absolutefoo"
+end
+return ____exports
diff --git a/test/transpile/module-resolution/project-with-module-resolution-plugin/lua_sources/absolutefoo.d.ts b/test/transpile/module-resolution/project-with-module-resolution-plugin/lua_sources/absolutefoo.d.ts
@@ -0,0 +1 @@
+export declare function absolutefoo(): string;
diff --git a/test/transpile/module-resolution/project-with-module-resolution-plugin/main.ts b/test/transpile/module-resolution/project-with-module-resolution-plugin/main.ts
@@ -1,2 +1,3 @@
 import { foo } from "./lua_sources/foo";
-export const result = foo();
+import { absolutefoo } from "./lua_sources/absolutefoo";
+export const result = [foo(), absolutefoo()];
diff --git a/test/transpile/module-resolution/project-with-module-resolution-plugin/tsconfig.json b/test/transpile/module-resolution/project-with-module-resolution-plugin/tsconfig.json
@@ -3,7 +3,6 @@
         "strict": true,
         "target": "esnext",
         "lib": ["esnext"],
-        "types": [],
-        "outDir": "./dist"
+        "types": []
     }
 }
diff --git a/test/transpile/plugins/moduleResolution.ts b/test/transpile/plugins/moduleResolution.ts
@@ -3,9 +3,18 @@ import type * as tstl from "../../../src";
 
 const plugin: tstl.Plugin = {
     moduleResolution(moduleIdentifier) {
-        const modulePath = moduleIdentifier.replace(/\./g, path.sep);
+        if (moduleIdentifier.includes("absolutefoo")) {
+            return path.join(
+                path.dirname(__dirname),
+                "module-resolution",
+                "project-with-module-resolution-plugin",
+                "lua_sources",
+                "absolutebar.lua"
+            );
+        }
+
         if (moduleIdentifier.includes("foo")) {
-            return modulePath.replace("foo", "bar");
+            return moduleIdentifier.replace("foo", "bar");
         }
     },
 };
diff --git a/test/util.ts b/test/util.ts
@@ -257,11 +257,18 @@ export abstract class TestBuilder {
     @memoize
     public getMainLuaFileResult(): ExecutableTranspiledFile {
         const { transpiledFiles } = this.getLuaResult();
+        const mainFileName = normalizeSlashes(this.mainFileName);
         const mainFile = this.options.luaBundle
             ? transpiledFiles[0]
-            : transpiledFiles.find(({ sourceFiles }) =>
-                  sourceFiles.some(f => f.fileName === normalizeSlashes(this.mainFileName))
-              );
+            : transpiledFiles.find(({ sourceFiles }) => sourceFiles.some(f => f.fileName === mainFileName));
+
+        if (mainFile === undefined) {
+            throw new Error(
+                `No source file could be found matching main file: ${mainFileName}.\nSource files in test:\n${transpiledFiles
+                    .flatMap(f => f.sourceFiles.map(sf => sf.fileName))
+                    .join("\n")}`
+            );
+        }
 
         expect(mainFile).toMatchObject({ lua: expect.any(String), luaSourceMap: expect.any(String) });
         return mainFile as ExecutableTranspiledFile;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+export declare function absolutefoo(): string;`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`	`"strict": true,`
`4`	`4`	`"target": "esnext",`
`5`	`5`	`"lib": ["esnext"],`
`6`		`- "types": [],`
`7`		`- "outDir": "./dist"`
	`6`	`+ "types": []`
`8`	`7`	`}`
`9`	`8`	`}`