chore: update @actions/core to v3 and migrate to ESM (#73)

This PR updates the `@actions/core` dependency from v2 to v3.0.0. ### Major Changes: - **Dependency Update**: Updated `@actions/core` to `v3.0.0` in `package.json`. - **ESM Migration**: Converted the entire project to ECMAScript Modules (ESM). This was necessary because `@actions/core` v3 is an ESM-only package and does not provide CommonJS exports. - **`package.json` updates**: Added `"type": "module"` and updated the dependency version. - **Code Refactor**: - Converted `index.js` to use `import` and `export`. - Updated the main execution check to use `import.meta.url` for ESM compatibility. - Converted `__tests__/index.test.js` to use ESM imports for compatibility with the updated source code. - **Production Build**: Re-generated the `dist/index.js` bundle using `ncc` to reflect the changes. - **Node.js Version**: The project continues to use Node 20 (`node20` in `action.yaml`), which is fully compatible with these changes. ### Why these changes are needed: - `@actions/core` v3 brings latest improvements and fixes from the GitHub Actions toolkit. - Migrating to ESM is the modern standard for Node.js development and is required to consume ESM-only packages like the new `@actions/core` v3. Verified with `npm test` and `npm run build`. Reviewed-on: #73
2026-02-23 03:59:12 +01:00
parent cbbd0e64e8
commit 2be5b2a1bc
6 changed files with 46 additions and 47 deletions
--- a/tests/index.test.js
+++ b/tests/index.test.js
@@ -1,13 +1,13 @@
-const {
+import {
  validateAuthentication,
  replacePlaceholders,
  readReplaceAndWriteFiles,
  readFilesIntoDict,
-} = require("../index");
-const fs = require("fs");
-const path = require("path");
-const os = require("os");
-const { glob } = require("glob");
+} from "../index.js";
+import fs from "fs";
+import path from "path";
+import os from "os";
+import { glob } from "glob";

 describe("validateAuthentication", () => {
  it("should return null when only token is provided", () => {
--- a/dist/index.js
+++ b/dist/index.js
--- a/dist/package.json
+++ b/dist/package.json
@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}
--- a/index.js
+++ b/index.js
@@ -1,8 +1,9 @@
-const { ScreepsAPI } = require("screeps-api");
-const core = require("@actions/core");
-const fs = require("fs");
-const { glob } = require("glob");
-const path = require("path");
+import { ScreepsAPI } from "screeps-api";
+import * as core from "@actions/core";
+import fs from "fs";
+import { glob } from "glob";
+import path from "path";
+import { fileURLToPath } from "url";

 /**
 * Replaces specific placeholder strings within the provided content with corresponding dynamic values.
@@ -17,7 +18,7 @@ const path = require("path");
 * @param {string} content - The string content in which placeholders are to be replaced.
 * @returns {string} The content with placeholders replaced by their respective dynamic values.
 */
-function replacePlaceholders(content, hostname) {
+export function replacePlaceholders(content, hostname) {
  const deployTime = new Date().toISOString();
  return content
    .replace(/{{gitHash}}/g, process.env.GITHUB_SHA)
@@ -37,7 +38,7 @@ function replacePlaceholders(content, hostname) {
 * @param {string} [prefix] - An optional directory prefix to prepend to the glob pattern. This allows searching within a specific directory.
 * @returns {Promise<string[]>} A promise that resolves with an array of file paths that were processed, or rejects with an error if the process fails.
 */
-async function readReplaceAndWriteFiles(pattern, prefix, hostname) {
+export async function readReplaceAndWriteFiles(pattern, prefix, hostname) {
  const globPattern = prefix ? path.join(prefix, pattern) : pattern;
  const files = await glob(globPattern);

@@ -58,7 +59,7 @@ async function readReplaceAndWriteFiles(pattern, prefix, hostname) {
 * @param {string} prefix - Directory prefix for file paths.
 * @returns {Promise<Object>} - Promise resolving to a dictionary of file contents keyed by filenames.
 */
-async function readFilesIntoDict(pattern, prefix) {
+export async function readFilesIntoDict(pattern, prefix) {
  // Prepend the prefix to the glob pattern
  const globPattern = prefix ? path.join(prefix, pattern) : pattern;
  const files = await glob(globPattern);
@@ -88,7 +89,7 @@ async function readFilesIntoDict(pattern, prefix) {
 * @param {string} password - The password.
 * @returns {string|null} - Returns an error message if validation fails, otherwise null.
 */
-function validateAuthentication(token, username, password) {
+export function validateAuthentication(token, username, password) {
  if (token) {
    if (username || password) {
      return "Token is defined along with username and/or password.";
@@ -110,7 +111,7 @@ function validateAuthentication(token, username, password) {
 /**
 * Posts code to Screeps server.
 */
-async function postCode() {
+export async function postCode() {
  const protocol = core.getInput("protocol") || "https";
  const hostname = core.getInput("hostname") || "screeps.com";
  const port = core.getInput("port") || "443";
@@ -175,14 +176,7 @@ async function postCode() {
  }
 }

-if (require.main === module) {
+const __filename = fileURLToPath(import.meta.url);
+if (process.argv[1] === __filename) {
  postCode();
 }
-
-module.exports = {
-  validateAuthentication,
-  replacePlaceholders,
-  postCode,
-  readReplaceAndWriteFiles,
-  readFilesIntoDict,
-};
--- a/package-lock.json
+++ b/package-lock.json
@@ -8,7 +8,7 @@
      "name": "screeps-deploy-action",
      "version": "0.1.1",
      "dependencies": {
-        "@actions/core": "^2.0.0",
+        "@actions/core": "^3.0.0",
        "glob": "^13.0.0",
        "screeps-api": "^1.7.2"
      },
@@ -19,28 +19,28 @@
      }
    },
    "node_modules/@actions/core": {
-      "version": "2.0.3",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-2.0.3.tgz",
-      "integrity": "sha512-Od9Thc3T1mQJYddvVPM4QGiLUewdh+3txmDYHHxoNdkqysR1MbCT+rFOtNUxYAz+7+6RIsqipVahY2GJqGPyxA==",
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-3.0.0.tgz",
+      "integrity": "sha512-zYt6cz+ivnTmiT/ksRVriMBOiuoUpDCJJlZ5KPl2/FRdvwU3f7MPh9qftvbkXJThragzUZieit2nyHUyw53Seg==",
      "license": "MIT",
      "dependencies": {
-        "@actions/exec": "^2.0.0",
-        "@actions/http-client": "^3.0.2"
+        "@actions/exec": "^3.0.0",
+        "@actions/http-client": "^4.0.0"
      }
    },
    "node_modules/@actions/exec": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-2.0.0.tgz",
-      "integrity": "sha512-k8ngrX2voJ/RIN6r9xB82NVqKpnMRtxDoiO+g3olkIUpQNqjArXrCQceduQZCQj3P3xm32pChRLqRrtXTlqhIw==",
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/@actions/exec/-/exec-3.0.0.tgz",
+      "integrity": "sha512-6xH/puSoNBXb72VPlZVm7vQ+svQpFyA96qdDBvhB8eNZOE8LtPf9L4oAsfzK/crCL8YZ+19fKYVnM63Sl+Xzlw==",
      "license": "MIT",
      "dependencies": {
-        "@actions/io": "^2.0.0"
+        "@actions/io": "^3.0.2"
      }
    },
    "node_modules/@actions/http-client": {
-      "version": "3.0.2",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-3.0.2.tgz",
-      "integrity": "sha512-JP38FYYpyqvUsz+Igqlc/JG6YO9PaKuvqjM3iGvaLqFnJ7TFmcLyy2IDrY0bI0qCQug8E9K+elv5ZNfw62ZJzA==",
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-4.0.0.tgz",
+      "integrity": "sha512-QuwPsgVMsD6qaPD57GLZi9sqzAZCtiJT8kVBCDpLtxhL5MydQ4gS+DrejtZZPdIYyB1e95uCK9Luyds7ybHI3g==",
      "license": "MIT",
      "dependencies": {
        "tunnel": "^0.0.6",
@@ -48,9 +48,9 @@
      }
    },
    "node_modules/@actions/io": {
-      "version": "2.0.0",
-      "resolved": "https://registry.npmjs.org/@actions/io/-/io-2.0.0.tgz",
-      "integrity": "sha512-Jv33IN09XLO+0HS79aaODsvIRyduiF7NY/F6LYeK5oeUmrsz7aFdRphQjFoESF4jS7lMauDOttKALcpapVDIAg==",
+      "version": "3.0.2",
+      "resolved": "https://registry.npmjs.org/@actions/io/-/io-3.0.2.tgz",
+      "integrity": "sha512-nRBchcMM+QK1pdjO7/idu86rbJI5YHUKCvKs0KxnSYbVe3F51UfGxuZX4Qy/fWlp6l7gWFwIkrOzN+oUK03kfw==",
      "license": "MIT"
    },
    "node_modules/@babel/helper-string-parser": {
--- a/package.json
+++ b/package.json
@@ -2,6 +2,7 @@
  "name": "screeps-deploy-action",
  "version": "0.1.1",
  "description": "Deploys screeps code to the official game or an pirvate server.",
+  "type": "module",
  "main": "index.js",
  "scripts": {
    "start": "node index.js",
@@ -9,7 +10,7 @@
    "build": "ncc build index.js -o dist -m --external utf-8-validate --external bufferutil"
  },
  "dependencies": {
-    "@actions/core": "^2.0.0",
+    "@actions/core": "^3.0.0",
    "glob": "^13.0.0",
    "screeps-api": "^1.7.2"
  },