Module resolution should ignore functions that look like requires but are not (#1066)

Perryvw · web-flow · commit 4910922a89bc · 2021-08-05T22:03:08.000+02:00
* Module resolution should ignore functions that look like requires but are not

* fix prettier

* Escape special characters in require regex
diff --git a/src/transpilation/resolve.ts b/src/transpilation/resolve.ts
@@ -274,19 +274,26 @@ function isBuildModeLibrary(program: ts.Program) {
 function findRequiredPaths(code: string): string[] {
     // Find all require("<path>") paths in a lua code string
     const paths: string[] = [];
-    const pattern = /require\("(.+)"\)/g;
+    const pattern = /(^|\s|;|=)require\("(.+)"\)/g;
     // eslint-disable-next-line @typescript-eslint/ban-types
     let match: RegExpExecArray | null;
     while ((match = pattern.exec(code))) {
-        paths.push(match[1]);
+        paths.push(match[2]);
     }
 
     return paths;
 }
 
 function replaceRequireInCode(file: ProcessedFile, originalRequire: string, newRequire: string): void {
     const requirePath = formatPathToLuaPath(newRequire.replace(".lua", ""));
-    file.code = file.code.replace(`require("${originalRequire}")`, `require("${requirePath}")`);
+
+    // Escape special characters to prevent the regex from breaking...
+    const escapedRequire = originalRequire.replace(/[-/\\^$*+?.()|[\]{}]/g, "\\$&");
+
+    file.code = file.code.replace(
+        new RegExp(`(^|\\s|;|=)require\\("${escapedRequire}"\\)`),
+        `$1require("${requirePath}")`
+    );
 }
 
 function replaceRequireInSourceMap(file: ProcessedFile, originalRequire: string, newRequire: string): void {
diff --git a/test/transpile/module-resolution.spec.ts b/test/transpile/module-resolution.spec.ts
@@ -329,6 +329,7 @@ test("module resolution should not try to resolve @noResolution annotation", ()
         .expectToHaveNoDiagnostics();
 });
 
+// https://github.com/TypeScriptToLua/TypeScriptToLua/issues/1062
 test("module resolution should not rewrite @NoResolution requires in library mode", () => {
     const { transpiledFiles } = util.testModule`
         import * as json from "json";
@@ -351,6 +352,40 @@ test("module resolution should not rewrite @NoResolution requires in library mod
     expect(transpiledFiles[0].lua).toContain('require("@NoResolution:');
 });
 
+// https://github.com/TypeScriptToLua/TypeScriptToLua/issues/1050
+test("module resolution should not try to resolve resolve-like functions", () => {
+    util.testModule`
+        function custom_require(this: void, value: string) {
+            return value;
+        }
+
+        namespace ns {
+            export function require(this: void, value: string) {
+                return value;
+            }
+        }
+
+        class MyClass {
+            require(value: string) {
+                return value;
+            }
+        }
+        const inst = new MyClass();
+
+        export const result = [
+            custom_require("value 1"),
+            ns.require("value 2"),
+            inst.require("value 3")
+        ];
+
+    `
+        .expectToHaveNoDiagnostics()
+        .expectToEqual({
+            result: ["value 1", "value 2", "value 3"],
+        });
+});
+
+// https://github.com/TypeScriptToLua/TypeScriptToLua/issues/1050
 test("module resolution uses baseURL to resolve imported files", () => {
     util.testModule`
         import { foo } from "dep1";
