Migrate to ESMBundler and node 24 (#345)

Author: eifinger

.github/scripts/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
+    "target": "es2022",
+    "types": ["node"]
+  },
+  "include": ["check-all-tests-passed-needs.ts"]
+}

.github/workflows/test.yml

@@ -27,14 +27,15 @@ jobs:
         uses: zizmorcore/zizmor-action@71321a20a9ded102f6e9ce5718a2fcec2c4f70d8 # v0.5.2
       - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
-          node-version: "20"
+          node-version-file: .nvmrc
+          cache: npm
       - run: |
           npm ci --ignore-scripts
       - run: |
           npm run all
       - name: Check all jobs are in all-tests-passed.needs
         run: |
-          tsc check-all-tests-passed-needs.ts
+          tsc -p tsconfig.json
           node check-all-tests-passed-needs.js
         working-directory: .github/scripts
       - name: Make sure no changes from linters are detected

.github/workflows/update-known-checksums.yml

@@ -16,11 +16,12 @@ jobs:
           persist-credentials: false
       - uses: actions/setup-node@6044e13b5dc448c55e2357c09f80417699197238 # v6.2.0
         with:
-          node-version: "20"
+          node-version-file: .nvmrc
+          cache: npm
       - name: Update known checksums
         id: update-known-checksums
         run:
-          node dist/update-known-checksums/index.js
+          node dist/update-known-checksums/index.cjs
           src/download/checksum/known-checksums.ts ${{ secrets.GITHUB_TOKEN }}
       - run: npm ci --ignore-scripts && npm run all
       - name: Create Pull Request

.nvmrc

@@ -0,0 +1 @@
+24

__tests__/utils/pyproject-finder.test.ts

@@ -0,0 +1,122 @@
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { beforeEach, describe, expect, it, jest } from "@jest/globals";
+
+const debug = jest.fn();
+const info = jest.fn();
+
+jest.unstable_mockModule("@actions/core", () => ({
+  debug,
+  info,
+}));
+
+const { findPyprojectToml } = await import("../../src/utils/pyproject-finder");
+
+const testFilePath = fileURLToPath(import.meta.url);
+const testDir = path.dirname(testFilePath);
+const repoRoot = path.resolve(testDir, "..", "..");
+const fixturesDir = path.join(repoRoot, "__tests__", "fixtures");
+
+describe("findPyprojectToml", () => {
+  beforeEach(() => {
+    debug.mockReset();
+    info.mockReset();
+  });
+
+  describe("when pyproject.toml exists in src directory", () => {
+    it("should return the exact path", () => {
+      const result = findPyprojectToml(fixturesDir, repoRoot);
+
+      expect(result).toContain("pyproject.toml");
+      expect(result).toContain("fixtures");
+      expect(info).toHaveBeenCalled();
+    });
+  });
+
+  describe("when pyproject.toml exists only in parent directory", () => {
+    it("should search upwards and find the parent's pyproject.toml", () => {
+      const subprojectDir = path.join(
+        fixturesDir,
+        "parent-config-project",
+        "subproject",
+      );
+
+      const result = findPyprojectToml(subprojectDir, repoRoot);
+
+      expect(result).toBeTruthy();
+      expect(result).toContain("pyproject.toml");
+      expect(result).toContain("parent-config-project");
+      expect(info).toHaveBeenCalled();
+    });
+  });
+
+  describe("boundary conditions", () => {
+    it("should stop searching at workspace root and return undefined when not found", () => {
+      const nodeModulesDir = path.join(repoRoot, "node_modules", "@actions");
+
+      const result = findPyprojectToml(nodeModulesDir, repoRoot);
+
+      expect(result).toBeUndefined();
+      expect(info).not.toHaveBeenCalledWith(
+        expect.stringContaining("Found pyproject.toml"),
+      );
+    });
+
+    it("should find pyproject.toml when it exists at workspace root", () => {
+      const parentConfigProjectDir = path.join(
+        fixturesDir,
+        "parent-config-project",
+      );
+      const subprojectDir = path.join(parentConfigProjectDir, "subproject");
+
+      const result = findPyprojectToml(subprojectDir, parentConfigProjectDir);
+
+      expect(result).toBeTruthy();
+      expect(result).toContain("pyproject.toml");
+      expect(result).toContain("parent-config-project");
+    });
+
+    it("should stop at workspace root even if searching from it", () => {
+      const result = findPyprojectToml(fixturesDir, fixturesDir);
+
+      expect(result).toBeTruthy();
+      expect(result).toContain("pyproject.toml");
+      expect(result).toContain("fixtures");
+    });
+  });
+
+  describe("edge cases", () => {
+    it("should handle relative paths", () => {
+      const result = findPyprojectToml("./__tests__/fixtures", ".");
+
+      expect(result).toBeTruthy();
+      expect(result).toContain("pyproject.toml");
+    });
+
+    it("should handle when src equals workspace root", () => {
+      const result = findPyprojectToml(fixturesDir, fixturesDir);
+
+      expect(result).toBeTruthy();
+      expect(result).toContain("pyproject.toml");
+      expect(result).toContain("fixtures");
+    });
+
+    it("should log debug messages for each checked path", () => {
+      const pythonProjectDir = path.join(fixturesDir, "python-project");
+
+      findPyprojectToml(pythonProjectDir, repoRoot);
+
+      expect(debug).toHaveBeenCalled();
+      expect(debug.mock.calls.length).toBeGreaterThan(0);
+      expect(debug.mock.calls[0][0]).toContain("Checking for");
+      expect(debug.mock.calls[0][0]).toContain("python-project");
+    });
+
+    it("should handle paths with trailing slashes", () => {
+      const result = findPyprojectToml(`${fixturesDir}/`, repoRoot);
+
+      expect(result).toBeTruthy();
+      expect(result).toContain("pyproject.toml");
+    });
+  });
+});

src/utils/pyproject.test.ts __tests__/utils/pyproject.test.tssrc/utils/pyproject.test.ts renamed to __tests__/utils/pyproject.test.ts

@@ -1,77 +1,82 @@
-import * as core from "@actions/core";
-import { findRuffVersionInSpec } from "./pyproject";
+import { beforeEach, describe, expect, it, jest } from "@jest/globals";
 
-jest.mock("@actions/core", () => ({
-  info: jest.fn(),
-  warning: jest.fn(),
+const info = jest.fn();
+const warning = jest.fn();
+
+jest.unstable_mockModule("@actions/core", () => ({
+  info,
+  warning,
 }));
 
+const { findRuffVersionInSpec } = await import("../../src/utils/pyproject");
+
 describe("findRuffVersionInSpec", () => {
   beforeEach(() => {
-    jest.clearAllMocks();
+    info.mockReset();
+    warning.mockReset();
   });
 
   describe("ruff dependency strings", () => {
     it("should extract version from 'ruff==0.9.3'", () => {
       const result = findRuffVersionInSpec("ruff==0.9.3");
       expect(result).toBe("0.9.3");
-      expect(core.info).toHaveBeenCalledWith(
+      expect(info).toHaveBeenCalledWith(
         "Found ruff version in requirements file: 0.9.3",
       );
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should extract version from 'ruff>=0.14'", () => {
       const result = findRuffVersionInSpec("ruff>=0.14");
       expect(result).toBe(">=0.14");
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should extract version from 'ruff ~=1.0.0'", () => {
       const result = findRuffVersionInSpec("ruff ~=1.0.0");
       expect(result).toBe("~=1.0.0");
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should extract version from 'ruff>=0.14,<1.0'", () => {
       const result = findRuffVersionInSpec("ruff>=0.14,<1.0");
       expect(result).toBe(">=0.14,<1.0");
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should extract version from 'ruff>=0.14,<2.0,!=1.5.0'", () => {
       const result = findRuffVersionInSpec("ruff>=0.14,<2.0,!=1.5.0");
       expect(result).toBe(">=0.14,<2.0,!=1.5.0");
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should return undefined for non-ruff dependency 'another-dep 0.1.6'", () => {
       const result = findRuffVersionInSpec("another-dep 0.1.6");
       expect(result).toBeUndefined();
-      expect(core.info).not.toHaveBeenCalled();
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(info).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should return undefined for non-ruff dependency 'another-dep==0.1.6'", () => {
       const result = findRuffVersionInSpec("another-dep==0.1.6");
       expect(result).toBeUndefined();
-      expect(core.info).not.toHaveBeenCalled();
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(info).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should strip trailing backslash", () => {
       const result = findRuffVersionInSpec("ruff==0.9.3 \\");
       expect(result).toBe("0.9.3");
-      expect(core.info).toHaveBeenCalledWith(
+      expect(info).toHaveBeenCalledWith(
         "Found ruff version in requirements file: 0.9.3",
       );
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should strip trailing backslash with whitespace", () => {
       const result = findRuffVersionInSpec("  ruff==0.9.3  \\  ");
       expect(result).toBe("0.9.3");
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
   });
 
@@ -81,10 +86,10 @@ describe("findRuffVersionInSpec", () => {
         'ruff>=0.14 ; python_version >= "3.11"',
       );
       expect(result).toBe(">=0.14");
-      expect(core.info).toHaveBeenCalledWith(
+      expect(info).toHaveBeenCalledWith(
         "Found ruff version in requirements file: >=0.14",
       );
-      expect(core.warning).toHaveBeenCalledWith(
+      expect(warning).toHaveBeenCalledWith(
         "Environment markers are ignored. ruff is a standalone tool that works independently of Python version.",
       );
     });
@@ -94,7 +99,7 @@ describe("findRuffVersionInSpec", () => {
         "ruff==0.9.3 ; sys_platform == 'linux'",
       );
       expect(result).toBe("0.9.3");
-      expect(core.warning).toHaveBeenCalledWith(
+      expect(warning).toHaveBeenCalledWith(
         "Environment markers are ignored. ruff is a standalone tool that works independently of Python version.",
       );
     });
@@ -104,7 +109,7 @@ describe("findRuffVersionInSpec", () => {
         'ruff>=0.14 ; python_version >= "3.11" and sys_platform == "linux"',
       );
       expect(result).toBe(">=0.14");
-      expect(core.warning).toHaveBeenCalledWith(
+      expect(warning).toHaveBeenCalledWith(
         "Environment markers are ignored. ruff is a standalone tool that works independently of Python version.",
       );
     });
@@ -114,7 +119,7 @@ describe("findRuffVersionInSpec", () => {
         'ruff>=0.14,<1.0 ; python_version >= "3.11"',
       );
       expect(result).toBe(">=0.14,<1.0");
-      expect(core.warning).toHaveBeenCalledWith(
+      expect(warning).toHaveBeenCalledWith(
         "Environment markers are ignored. ruff is a standalone tool that works independently of Python version.",
       );
     });
@@ -124,47 +129,47 @@ describe("findRuffVersionInSpec", () => {
     it("should handle whitespace", () => {
       const result = findRuffVersionInSpec("  ruff  >=0.14  ");
       expect(result).toBe(">=0.14");
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should handle whitespace with environment markers", () => {
       const result = findRuffVersionInSpec(
         "  ruff  >=0.14  ;  python_version >= '3.11'  ",
       );
       expect(result).toBe(">=0.14");
-      expect(core.warning).toHaveBeenCalled();
+      expect(warning).toHaveBeenCalled();
     });
 
     it("should return undefined for empty string", () => {
       const result = findRuffVersionInSpec("");
       expect(result).toBeUndefined();
-      expect(core.info).not.toHaveBeenCalled();
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(info).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should return undefined for whitespace only", () => {
       const result = findRuffVersionInSpec("   ");
       expect(result).toBeUndefined();
-      expect(core.info).not.toHaveBeenCalled();
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(info).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should return undefined for just semicolon", () => {
       const result = findRuffVersionInSpec(";");
       expect(result).toBeUndefined();
-      expect(core.info).not.toHaveBeenCalled();
-      expect(core.warning).not.toHaveBeenCalled();
+      expect(info).not.toHaveBeenCalled();
+      expect(warning).not.toHaveBeenCalled();
     });
 
     it("should handle exact example from issue #256", () => {
       const result = findRuffVersionInSpec(
         'ruff>=0.14 ; python_version >= "3.11"',
       );
       expect(result).toBe(">=0.14");
-      expect(core.info).toHaveBeenCalledWith(
+      expect(info).toHaveBeenCalledWith(
         "Found ruff version in requirements file: >=0.14",
       );
-      expect(core.warning).toHaveBeenCalledWith(
+      expect(warning).toHaveBeenCalledWith(
         "Environment markers are ignored. ruff is a standalone tool that works independently of Python version.",
       );
     });
@@ -174,15 +179,15 @@ describe("findRuffVersionInSpec", () => {
         "ruff>=0.14 ; python_version >= '3.11'",
       );
       expect(result).toBe(">=0.14");
-      expect(core.warning).toHaveBeenCalled();
+      expect(warning).toHaveBeenCalled();
     });
 
     it("should handle double-quoted environment markers", () => {
       const result = findRuffVersionInSpec(
         'ruff>=0.14 ; python_version >= "3.11"',
       );
       expect(result).toBe(">=0.14");
-      expect(core.warning).toHaveBeenCalled();
+      expect(warning).toHaveBeenCalled();
     });
   });
 });

action.yml

@@ -30,8 +30,8 @@ outputs:
   ruff-version:
     description: "The installed ruff version. Useful when using latest."
 runs:
-  using: "node20"
-  main: "dist/ruff-action/index.js"
+  using: "node24"
+  main: "dist/ruff-action/index.cjs"
 branding:
   icon: "code"
   color: "black"