Fixed problem with lua sibling files

Perryvw · Perryvw · commit a24708eb8211 · 2021-05-24T18:44:52.000+02:00
diff --git a/src/transpilation/resolve.ts b/src/transpilation/resolve.ts
@@ -10,43 +10,52 @@ import { couldNotReadDependency, couldNotResolveRequire } from "./diagnostics";
 
 const resolver = resolve.ResolverFactory.createResolver({
     extensions: [".lua"],
-    enforceExtension: true, // Must be a lua file
+    enforceExtension: true, // Resolved file must be a lua file
     fileSystem: { ...new resolve.CachedInputFileSystem(fs) },
     useSyncFileSystemCalls: true,
 });
 
-const projectFiles = new Map<string, string>();
-
 interface ResolutionResult {
     resolvedFiles: ProcessedFile[];
     diagnostics: ts.Diagnostic[];
 }
 
+// Cache for getting source files from the program
+const projectFileCache = new Set<string>();
+function isProjectFile(file: string): boolean {
+    // Check if file is in the project ts.program
+    return projectFileCache.has(path.normalize(file));
+}
+
 export function resolveDependencies(program: ts.Program, files: ProcessedFile[], emitHost: EmitHost): ResolutionResult {
-    const outFiles: ProcessedFile[] = [];
+    const outFiles: ProcessedFile[] = [...files];
     const diagnostics: ts.Diagnostic[] = [];
 
+    // Add files to project cache
     const projectRoot = getProjectRoot(program);
     for (const sourceFile of program.getSourceFiles()) {
         const filePath = path.isAbsolute(sourceFile.fileName)
             ? path.normalize(sourceFile.fileName)
             : path.resolve(projectRoot, sourceFile.fileName);
-        projectFiles.set(filePath, sourceFile.text);
+        projectFileCache.add(filePath);
     }
 
+    // Resolve dependencies for all processed files
     for (const file of files) {
         const resolutionResult = resolveFileDependencies(file, program, emitHost);
-        outFiles.push(file, ...resolutionResult.resolvedFiles);
+        outFiles.push(...resolutionResult.resolvedFiles);
         diagnostics.push(...resolutionResult.diagnostics);
     }
 
     return { resolvedFiles: outFiles, diagnostics };
 }
 
 function resolveFileDependencies(file: ProcessedFile, program: ts.Program, emitHost: EmitHost): ResolutionResult {
-    const projectRootDir = getSourceDir(program);
     const dependencies: ProcessedFile[] = [];
     const diagnostics: ts.Diagnostic[] = [];
+
+    const projectRootDir = getSourceDir(program);
+
     for (const required of findRequiredPaths(file.code)) {
         // Do no resolve lualib
         if (required === "lualib_bundle") {
@@ -63,23 +72,23 @@ function resolveFileDependencies(file: ProcessedFile, program: ts.Program, emitH
 
         // Try to resolve the import starting from the directory `file` is in
         const fileDir = path.dirname(file.fileName);
-        const resolvedDependency = resolveDependency(fileDir, projectRootDir, required);
+        const resolvedDependency = resolveDependency(fileDir, projectRootDir, required, emitHost);
         if (resolvedDependency) {
-            // If dependency resolved successfully, read its content
-            const dependencyContent = projectFiles.get(resolvedDependency) ?? emitHost.readFile(resolvedDependency);
-            if (dependencyContent === undefined) {
-                diagnostics.push(couldNotReadDependency(resolvedDependency));
-                continue;
-            }
-
             // Figure out resolved require path and dependency output path
             const resolvedRequire = getEmitPathRelativeToOutDir(resolvedDependency, program);
 
             replaceRequireInCode(file, required, resolvedRequire);
             replaceRequireInSourceMap(file, required, resolvedRequire);
 
-            // If dependency is not part of sources, add dependency to output and resolve its dependencies recursively
-            if (!projectFiles.has(resolvedDependency)) {
+            // If dependency is not part of project, add dependency to output and resolve its dependencies recursively
+            if (!isProjectFile(resolvedDependency)) {
+                // If dependency resolved successfully, read its content
+                const dependencyContent = emitHost.readFile(resolvedDependency);
+                if (dependencyContent === undefined) {
+                    diagnostics.push(couldNotReadDependency(resolvedDependency));
+                    continue;
+                }
+
                 const dependency = {
                     fileName: resolvedDependency,
                     code: dependencyContent,
@@ -100,12 +109,12 @@ function resolveFileDependencies(file: ProcessedFile, program: ts.Program, emitH
     return { resolvedFiles: dependencies, diagnostics };
 }
 
-function replaceRequireInCode(file: ProcessedFile, originalRequire: string, newRequire: string) {
+function replaceRequireInCode(file: ProcessedFile, originalRequire: string, newRequire: string): void {
     const requirePath = formatPathToLuaPath(newRequire.replace(".lua", ""));
     file.code = file.code.replace(`require("${originalRequire}")`, `require("${requirePath}")`);
 }
 
-function replaceRequireInSourceMap(file: ProcessedFile, originalRequire: string, newRequire: string) {
+function replaceRequireInSourceMap(file: ProcessedFile, originalRequire: string, newRequire: string): void {
     const requirePath = formatPathToLuaPath(newRequire.replace(".lua", ""));
     if (file.sourceMapNode) {
         replaceInSourceMap(file.sourceMapNode, file.sourceMapNode, `"${originalRequire}"`, `"${requirePath}"`);
@@ -142,20 +151,32 @@ function findRequiredPaths(code: string): string[] {
     return paths;
 }
 
-function resolveDependency(fileDirectory: string, rootDirectory: string, dependency: string): string | undefined {
-    // Check if file is a TS file in the project
+function resolveDependency(
+    fileDirectory: string,
+    rootDirectory: string,
+    dependency: string,
+    emitHost: EmitHost
+): string | undefined {
+    // Check if file is a file in the project
     const resolvedPath = path.resolve(fileDirectory, dependency);
 
     const resolvedFile = resolvedPath + ".ts";
-    if (projectFiles.has(resolvedFile)) {
+    if (isProjectFile(resolvedFile)) {
         return resolvedFile;
     }
 
     const projectIndexPath = path.resolve(resolvedPath, "index.ts");
-    if (projectFiles.has(projectIndexPath)) {
+    if (isProjectFile(projectIndexPath)) {
         return projectIndexPath;
     }
 
+    // Check if this is a sibling of a required lua file
+    const luaFilePath = path.resolve(fileDirectory, dependency + ".lua");
+    if (emitHost.fileExists(luaFilePath)) {
+        return luaFilePath;
+    }
+
+    // Not a TS file in our project sources, use resolver to check if we can find dependency
     try {
         const resolveResult = resolver.resolveSync({}, rootDirectory, dependency);
         if (resolveResult) {
diff --git a/test/transpile/module-resolution.spec.ts b/test/transpile/module-resolution.spec.ts
@@ -84,7 +84,7 @@ describe("basic module resolution", () => {
 
 describe("module resolution with chained dependencies", () => {
     const projectPath = path.resolve(__dirname, "module-resolution", "project-with-dependency-chain");
-    const expectedResult = { result: "dependency3" };
+    const expectedResult = { result: "dependency3", result2: "someFunc from otherfile.lua" };
 
     test("can resolve dependencies in chain", () => {
         util.testProject(path.join(projectPath, "tsconfig.json"))
@@ -103,7 +103,7 @@ describe("module resolution with chained dependencies", () => {
 
 describe("module resolution with outDir", () => {
     const projectPath = path.resolve(__dirname, "module-resolution", "project-with-dependency-chain");
-    const expectedResult = { result: "dependency3" };
+    const expectedResult = { result: "dependency3", result2: "someFunc from otherfile.lua" };
 
     test("emits files in outDir", () => {
         const builder = util
@@ -114,10 +114,11 @@ describe("module resolution with outDir", () => {
 
         // Get the output paths relative to the project path
         const outPaths = builder.getLuaResult().transpiledFiles.map(f => path.relative(projectPath, f.outPath));
-        expect(outPaths).toHaveLength(4);
+        expect(outPaths).toHaveLength(5);
         expect(outPaths).toContain(path.join("tstl-out", "main.lua"));
         // Note: outputs to lua_modules
         expect(outPaths).toContain(path.join("tstl-out", "lua_modules", "dependency1", "index.lua"));
+        expect(outPaths).toContain(path.join("tstl-out", "lua_modules", "dependency1", "otherfile.lua"));
         expect(outPaths).toContain(path.join("tstl-out", "lua_modules", "dependency2", "index.lua"));
         expect(outPaths).toContain(path.join("tstl-out", "lua_modules", "dependency3", "index.lua"));
     });
diff --git a/test/transpile/module-resolution/project-with-dependency-chain/main.ts b/test/transpile/module-resolution/project-with-dependency-chain/main.ts
@@ -1,3 +1,4 @@
 import * as dependency1 from "dependency1";
 
 export const result = dependency1.f1();
+export const result2 = dependency1.otherFileFromDependency1();
diff --git a/test/transpile/module-resolution/project-with-dependency-chain/node_modules/dependency1/index.d.ts b/test/transpile/module-resolution/project-with-dependency-chain/node_modules/dependency1/index.d.ts
diff --git a/test/transpile/module-resolution/project-with-dependency-chain/node_modules/dependency1/index.lua b/test/transpile/module-resolution/project-with-dependency-chain/node_modules/dependency1/index.lua
diff --git a/test/transpile/module-resolution/project-with-dependency-chain/node_modules/dependency1/otherfile.lua b/test/transpile/module-resolution/project-with-dependency-chain/node_modules/dependency1/otherfile.lua
diff --git a/test/transpile/module-resolution/project-with-sourceDir/src/subdir/otherfile.ts b/test/transpile/module-resolution/project-with-sourceDir/src/subdir/otherfile.ts
@@ -2,4 +2,4 @@ export function func() {
     return "non-node_modules import";
 }
 
-export { nestedFunc } from "./subdirofsubdir/nestedfile";
+export { nestedFunc } from "./subdirofsubdir/nestedfile";
diff --git a/test/transpile/module-resolution/project-with-sourceDir/src/subdir/otherfile2.ts b/test/transpile/module-resolution/project-with-sourceDir/src/subdir/otherfile2.ts
@@ -1,3 +1,3 @@
 export function func2() {
     return "non-node_modules import 2";
-}
+}
diff --git a/test/transpile/module-resolution/project-with-sourceDir/src/subdir/subdirofsubdir/nestedfile.ts b/test/transpile/module-resolution/project-with-sourceDir/src/subdir/subdirofsubdir/nestedfile.ts
@@ -6,4 +6,4 @@ export function nestedFunc() {
 
 export function nestedFuncUsingParent() {
     return `nested func: ${func2()}`;
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`import * as dependency1 from "dependency1";`
`2`	`2`
`3`	`3`	`export const result = dependency1.f1();`
	`4`	`+export const result2 = dependency1.otherFileFromDependency1();`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@ export function func() {`
`2`	`2`	`return "non-node_modules import";`
`3`	`3`	`}`
`4`	`4`
`5`		`-export { nestedFunc } from "./subdirofsubdir/nestedfile";`
	`5`	`+export { nestedFunc } from "./subdirofsubdir/nestedfile";`
-Original file line number
+Diff line change
@@ @@ -1,3 +1,3 @@ @@
 export function func2() {
     return "non-node_modules import 2";
 -}
 +}