Migrate to esm

jest.config.js

@@ -0,0 +1,23 @@
+import { createDefaultPreset } from "ts-jest";
+
+const presetConfig = createDefaultPreset();
+
+const jestConfig = {
+  ...presetConfig,
+  resetMocks: true,
+  testEnvironment: "node",
+  extensionsToTreatAsEsm: [".ts"],
+  moduleNameMapper: {
+    "^(\\.{1,2}/.*)\\.js$": "$1",
+  },
+  transform: {
+    "^.+\\.ts$": [
+      "ts-jest",
+      {
+        useESM: true,
+      },
+    ],
+  },
+};
+
+export default jestConfig;

package.json

@@ -1,13 +1,14 @@
 {
   "name": "stack-action",
   "version": "0.0.0",
+  "type": "module",
   "description": "Build and test stack-based Haskell projects",
   "main": "lib/main.js",
   "scripts": {
     "build": "tsc && ncc build lib/main.js && sed -i 's/\\x0D$//' ./dist/index.js",
     "format": "prettier --write \"**/*.ts\"",
     "format-check": "prettier --check \"**/*.ts\"",
-    "test": "jest",
+    "test": "NODE_OPTIONS='--experimental-vm-modules' jest",
     "readme": "npx action-docs -u && prettier --write README.md"
   },
   "repository": {

src/dirty-files.test.ts

@@ -1,4 +1,6 @@
-import { parseGitStatus, isInterestingFile } from "./dirty-files";
+import { jest } from "@jest/globals";
+
+import { parseGitStatus, isInterestingFile } from "./dirty-files.js";
 
 describe("parseGitStatus", () => {
   test("parse file name, and filters untracked", () => {

src/envsubst.test.ts

@@ -1,4 +1,6 @@
-import { envsubst } from "./envsubst";
+import { jest } from "@jest/globals";
+
+import { envsubst } from "./envsubst.js";
 
 const HOME = process.env.HOME;
 

src/get-cache-keys.test.ts

@@ -1,4 +1,6 @@
-import { getCacheKeys } from "./get-cache-keys";
+import { jest } from "@jest/globals";
+
+import { getCacheKeys } from "./get-cache-keys.js";
 
 test("getCacheKeys", () => {
   const keys = getCacheKeys(["prefix-os-compiler", "package", "source"]);

src/hie.ts

@@ -1,7 +1,7 @@
 import * as fs from "fs";
 import * as core from "@actions/core";
 
-import { StackCLI } from "./stack-cli";
+import { StackCLI } from "./stack-cli.js"
 
 export const HIE_YAML: string = "hie.yaml";
 

src/inputs.ts

@@ -1,7 +1,7 @@
 import * as core from "@actions/core";
 import * as Shellwords from "shellwords-ts";
-import { envsubst } from "./envsubst";
-import { type OnDirtyFiles, parseOnDirtyFiles } from "./dirty-files";
+import { envsubst } from "./envsubst.js"
+import { type OnDirtyFiles, parseOnDirtyFiles } from "./dirty-files.js"
 
 export type Inputs = {
   workingDirectory: string | null;

src/main.ts

@@ -1,13 +1,13 @@
 import * as core from "@actions/core";
 
-import { checkDirtyFiles } from "./dirty-files";
-import { StackCLI } from "./stack-cli";
-import { getCacheKeys } from "./get-cache-keys";
-import { hashProject } from "./hash-project";
-import { getInputs } from "./inputs";
-import { readStackYamlSync, getStackDirectories } from "./stack-yaml";
-import { DEFAULT_CACHE_OPTIONS, withCache } from "./with-cache";
-import { GenHIE } from "./hie";
+import { checkDirtyFiles } from "./dirty-files.js"
+import { StackCLI } from "./stack-cli.js"
+import { getCacheKeys } from "./get-cache-keys.js"
+import { hashProject } from "./hash-project.js"
+import { getInputs } from "./inputs.js"
+import { readStackYamlSync, getStackDirectories } from "./stack-yaml.js"
+import { DEFAULT_CACHE_OPTIONS, withCache } from "./with-cache.js"
+import { GenHIE } from "./hie.js"
 
 async function run() {
   try {

src/parse-stack-path.test.ts

@@ -1,4 +1,6 @@
-import { parseStackPath } from "./parse-stack-path";
+import { jest } from "@jest/globals";
+
+import { parseStackPath } from "./parse-stack-path.js";
 
 const EXAMPLE = [
   "snapshot-doc-root: /home/patrick/.stack/snapshots/x86_64-linux-tinfo6/0dd02c1d8a380045321779c4567c2aa8873910743eac342f72d56f3d26881028/9.2.7/doc",

src/parse-stack-query.test.ts

@@ -1,4 +1,6 @@
-import { parseStackQuery } from "./parse-stack-query";
+import { jest } from "@jest/globals";
+
+import { parseStackQuery } from "./parse-stack-query.js";
 
 const EXAMPLE = [
   "compiler:",

src/stack-cli.test.ts

@@ -1,12 +1,17 @@
-import * as exec from "@actions/exec";
+import { ExecOptions } from "@actions/exec";
+import { jest } from "@jest/globals";
 
-import { StackCLI } from "./stack-cli";
+import { ExecDelegate, StackCLI } from "./stack-cli.js";
 
-jest.spyOn(exec, "exec");
+const exec: ExecDelegate = {
+  exec: jest.fn((command: string, args: string[], options?: ExecOptions) =>
+    Promise.resolve(0),
+  ),
+};
 
 describe("StackCLI", () => {
   test("Respects --resolver given", async () => {
-    const stackCLI = new StackCLI(["--resolver", "lts"], false);
+    const stackCLI = new StackCLI(["--resolver", "lts"], false, exec);
 
     await stackCLI.setup([]);
 
@@ -21,6 +26,7 @@ describe("StackCLI", () => {
     const stackCLI = new StackCLI(
       ["--stack-yaml", "sub/stack-nightly.yaml"],
       false,
+      exec,
     );
 
     await stackCLI.setup([]);
@@ -47,6 +53,7 @@ describe("StackCLI", () => {
         "nightly-20240201",
       ],
       false,
+      exec,
     );
 
     await stackCLI.setup([]);
@@ -65,7 +72,7 @@ describe("StackCLI", () => {
   });
 
   test("installCompilerTools", async () => {
-    const stackCLI = new StackCLI([], false);
+    const stackCLI = new StackCLI([], false, exec);
     await stackCLI.installCompilerTools(["hlint", "weeder"]);
 
     expect(exec.exec).toHaveBeenCalledWith(
@@ -76,14 +83,14 @@ describe("StackCLI", () => {
   });
 
   test("installCompilerTools with empty arguments", async () => {
-    const stackCLI = new StackCLI([], false);
+    const stackCLI = new StackCLI([], false, exec);
     await stackCLI.installCompilerTools([]);
 
     expect(exec.exec).not.toHaveBeenCalled();
   });
 
   test("buildDependencies", async () => {
-    const stackCLI = new StackCLI([], false);
+    const stackCLI = new StackCLI([], false, exec);
 
     await stackCLI.buildDependencies(["--coverage"]);
 
@@ -101,7 +108,7 @@ describe("StackCLI", () => {
   });
 
   test("buildNoTest", async () => {
-    const stackCLI = new StackCLI([], false);
+    const stackCLI = new StackCLI([], false, exec);
 
     await stackCLI.buildNoTest(["--coverage"]);
 
@@ -113,7 +120,7 @@ describe("StackCLI", () => {
   });
 
   test("buildTest", async () => {
-    const stackCLI = new StackCLI([], false);
+    const stackCLI = new StackCLI([], false, exec);
 
     await stackCLI.buildTest(["--coverage"]);
 
@@ -125,7 +132,7 @@ describe("StackCLI", () => {
   });
 
   test("build", async () => {
-    const stackCLI = new StackCLI([], false);
+    const stackCLI = new StackCLI([], false, exec);
 
     await stackCLI.build(["--coverage"]);
 

src/stack-cli.ts

@@ -2,12 +2,12 @@ import * as fs from "fs";
 import * as path from "path";
 import { devNull } from "os";
 import type { ExecOptions } from "@actions/exec";
-import * as exec from "@actions/exec";
+import * as realExec from "@actions/exec";
 
-import type { StackPath } from "./parse-stack-path";
-import { parseStackPath } from "./parse-stack-path";
-import type { StackQuery } from "./parse-stack-query";
-import { parseStackQuery } from "./parse-stack-query";
+import type { StackPath } from "./parse-stack-path.js";
+import { parseStackPath } from "./parse-stack-path.js";
+import type { StackQuery } from "./parse-stack-query.js";
+import { parseStackQuery } from "./parse-stack-query.js";
 
 export interface ExecDelegate {
   exec: (
@@ -23,10 +23,12 @@ export class StackCLI {
 
   private debug: boolean;
   private globalArgs: string[];
+  private execImpl: ExecDelegate;
 
-  constructor(args: string[], debug?: boolean) {
+  constructor(args: string[], debug?: boolean, exec?: ExecDelegate) {
     this.debug = debug ?? false;
     this.globalArgs = args;
+    this.execImpl = exec ?? realExec;
 
     // Capture --stack-yaml if given
     const stackYamlIdx = args.indexOf("--stack-yaml");
@@ -49,7 +51,7 @@ export class StackCLI {
   }
 
   async installed(): Promise<boolean> {
-    const ec = await exec.exec("which", ["stack"], {
+    const ec = await this.execImpl.exec("which", ["stack"], {
       silent: true,
       ignoreReturnCode: true,
     });
@@ -59,14 +61,14 @@ export class StackCLI {
   async install(): Promise<void> {
     const url = "https://get.haskellstack.org";
     const tmp = "install-stack.sh";
-    await exec.exec("curl", ["-sSL", "-o", tmp, url]);
-    await exec.exec("sh", [tmp]);
+    await this.execImpl.exec("curl", ["-sSL", "-o", tmp, url]);
+    await this.execImpl.exec("sh", [tmp]);
     fs.rmSync(tmp);
   }
 
   async upgrade(): Promise<number> {
     // Avoid this.exec because we don't need/want globalArgs
-    return await exec.exec("stack", ["upgrade"]);
+    return await this.execImpl.exec("stack", ["upgrade"]);
   }
 
   async setup(args: string[]): Promise<number> {
@@ -139,6 +141,10 @@ export class StackCLI {
   }
 
   private async exec(args: string[], options?: ExecOptions): Promise<number> {
-    return await exec.exec("stack", this.globalArgs.concat(args), options);
+    return await this.execImpl.exec(
+      "stack",
+      this.globalArgs.concat(args),
+      options,
+    );
   }
 }

src/stack-yaml.test.ts

@@ -1,5 +1,7 @@
-import { parseStackYaml, getStackDirectories } from "./stack-yaml";
-import { StackCLI } from "./stack-cli";
+import { jest } from "@jest/globals";
+
+import { parseStackYaml, getStackDirectories } from "./stack-yaml.js";
+import { StackCLI } from "./stack-cli.js";
 
 const testStackRoot = "/home/me/.stack";
 const testPrograms = `${testStackRoot}/programs/x86_64-linux`;

src/stack-yaml.ts

@@ -2,7 +2,7 @@ import * as fs from "fs";
 import { join as pathJoin } from "path";
 import * as yaml from "js-yaml";
 
-import { StackCLI } from "./stack-cli";
+import { StackCLI } from "./stack-cli.js"
 
 export type StackYaml = {
   resolver: string;