fix: migrate helper scripts to .cjs extension to work with ESM extension

Author: dsanders11

.vscode/launch.json

@@ -13,7 +13,7 @@
         "--extensionDevelopmentPath=${workspaceFolder}"
       ],
       "outFiles": [
-        "${workspaceFolder}/out/**/*.js"
+        "${workspaceFolder}/out/**/*.{cjs,js}"
       ],
       "autoAttachChildProcesses": true,
       "preLaunchTask": "npm: esbuild"
@@ -27,7 +27,7 @@
         "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
       ],
       "outFiles": [
-        "${workspaceFolder}/out/test/**/*.js"
+        "${workspaceFolder}/out/test/**/*.{cjs,js}"
       ],
       "preLaunchTask": "${defaultBuildTask}"
     },

electron/listMochaTests.ts

@@ -24,7 +24,7 @@ const { retrieveSourceMap } = require(
   path.resolve(process.cwd(), "node_modules", "source-map-support"),
 );
 const { getFileContent } = require(
-  path.resolve(__dirname, "electron-build-tools-typescript"),
+  path.resolve(__dirname, "electron-build-tools-typescript.cjs"),
 );
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -133,7 +133,7 @@ app
     );
 
     const mocha: MochaType = new Mocha({
-      ui: path.resolve(__dirname, "mocha-interface.js"),
+      ui: path.resolve(__dirname, "mocha-interface.cjs"),
     });
 
     // Use a socket to pass filenames rather than command line

package.json

@@ -1069,12 +1069,12 @@
     "esbuild": "run-p \"esbuild:* -- {1}\" -- --sourcemap",
     "watch": "run-p \"esbuild:* -- {1} {2}\" -- --sourcemap --watch",
     "esbuild:extension": "esbuild ./src/extension.ts --bundle --outfile=out/main.js --external:vscode --external:original-fs --format=esm --platform=node --banner:js=\"import { createRequire as createRequireBanner } from 'node:module'; var require = createRequireBanner(import.meta.url);\"",
-    "esbuild:list-tests": "esbuild ./electron/listMochaTests.ts --bundle --outfile=out/electron/listMochaTests.js --external:electron --format=cjs --platform=node",
-    "esbuild:mocha-interface": "esbuild ./electron/mocha-interface.ts --bundle --outfile=out/electron/mocha-interface.js --format=cjs --platform=node",
-    "esbuild:mocha-reporter": "esbuild ./electron/mocha-reporter.ts --bundle --outfile=out/electron/mocha-reporter.js --format=cjs --platform=node",
-    "esbuild:ts-compiler": "esbuild ./electron/electron-build-tools-typescript.ts --bundle --outfile=out/electron/electron-build-tools-typescript.js --format=cjs --platform=node",
-    "esbuild:echo-to-socket": "esbuild ./scripts/echo-to-socket.ts --bundle --outfile=out/scripts/echo-to-socket.js --format=cjs --platform=node",
-    "esbuild:lm-tests": "esbuild ./lm-tests/*.ts --bundle --external:vscode --outdir=out/lm-tests/ --format=cjs --platform=node",
+    "esbuild:list-tests": "esbuild ./electron/listMochaTests.ts --bundle --outfile=out/electron/listMochaTests.cjs --external:electron --format=cjs --platform=node",
+    "esbuild:mocha-interface": "esbuild ./electron/mocha-interface.ts --bundle --outfile=out/electron/mocha-interface.cjs --format=cjs --platform=node",
+    "esbuild:mocha-reporter": "esbuild ./electron/mocha-reporter.ts --bundle --outfile=out/electron/mocha-reporter.cjs --format=cjs --platform=node",
+    "esbuild:ts-compiler": "esbuild ./electron/electron-build-tools-typescript.ts --bundle --outfile=out/electron/electron-build-tools-typescript.cjs --format=cjs --platform=node",
+    "esbuild:echo-to-socket": "esbuild ./scripts/echo-to-socket.ts --bundle --outfile=out/scripts/echo-to-socket.cjs --format=cjs --platform=node",
+    "esbuild:lm-tests": "esbuild ./lm-tests/*.ts --bundle --external:vscode --out-extension:.js=.cjs --outdir=out/lm-tests/ --format=cjs --platform=node",
     "lint": "eslint electron src && yarn prettier:check",
     "prepare": "husky",
     "pretest": "yarn run esbuild && yarn run lint",

src/extension.ts

@@ -267,7 +267,7 @@ function registerElectronBuildToolsCommands(
       // Use a custom reporter to send output to an OutputChannel, and
       // also output the number of continuations a given test needed
       const reporterModule = await import(
-        vscode.Uri.joinPath(context.extensionUri, "out/lm-tests/reporter.js")
+        vscode.Uri.joinPath(context.extensionUri, "out/lm-tests/reporter.cjs")
           .fsPath
       );
 

src/tasks.ts

@@ -57,7 +57,7 @@ export function runAsTask({
   // base64 encode the command to get around shell quoting issues
   const b64command = Buffer.from(command).toString("base64");
 
-  const script = context.asAbsolutePath("out/scripts/echo-to-socket.js");
+  const script = context.asAbsolutePath("out/scripts/echo-to-socket.cjs");
 
   const task = new vscode.Task(
     { type: "electron-build-tools", task: taskName },

src/tests.ts

@@ -160,7 +160,7 @@ export async function createTestController(
     const env: Record<string, string> = {
       MOCHA_REPORTER: "mocha-multi-reporters",
       MOCHA_MULTI_REPORTERS: `${context.asAbsolutePath(
-        "out/electron/mocha-reporter.js",
+        "out/electron/mocha-reporter.cjs",
       )}, spec`,
       ELECTRON_ROOT: electronRoot.fsPath,
     };
@@ -668,7 +668,7 @@ export async function createTestController(
         }
 
         const specRunnerContents = await vscode.workspace.fs.readFile(
-          vscode.Uri.joinPath(electronRoot, "script", "spec-runner.js"),
+          vscode.Uri.joinPath(electronRoot, "script", "spec-runner.cjs"),
         );
 
         if (
@@ -796,9 +796,9 @@ async function getElectronTests(
   const electronExe = await vscode.commands.executeCommand<string>(
     `${commandPrefix}.show.exec`,
   );
-  const scriptName = context.asAbsolutePath("out/electron/listMochaTests.js");
+  const scriptName = context.asAbsolutePath("out/electron/listMochaTests.cjs");
   const tsNodeCompiler = context.asAbsolutePath(
-    "out/electron/electron-build-tools-typescript.js",
+    "out/electron/electron-build-tools-typescript.cjs",
   );
   const socketName = generateSocketName();