Adopt TypeScript under Node 24

Author: Bo98

.github/workflows/test.yml

@@ -22,7 +22,10 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
         with:
-          node-version: '20'
+          node-version: '24'
+
+      - name: Run type checking
+        run: npm install && npx tsc
 
       - name: Run tests
         run: npm test -- --experimental-test-coverage --test-reporter lcov --test-reporter-destination lcov.info

.github/workflows/vendor-node-modules.yml

@@ -49,7 +49,7 @@ jobs:
           PR: ${{ github.event.pull_request.number || github.event.inputs.pull_request }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Vendor node_modules
-        run: npm install
+        run: npm ci --omit=dev
       - name: Commit changes
         id: commit
         run: |

.gitignore

@@ -0,0 +1,5 @@
+/node_modules/.bin/
+/node_modules/@tsconfig/
+/node_modules/@types/
+/node_modules/typescript/
+/node_modules/undici-types/

api-commit-and-push/action.yml

@@ -23,5 +23,5 @@ inputs:
     required: false
     default: ${{ github.repository }}
 runs:
-  using: node20
-  main: main.mjs
+  using: node24
+  main: main.mts

api-commit-and-push/main.mjs renamed to api-commit-and-push/main.mts

@@ -4,6 +4,8 @@ import github from "@actions/github"
 import fs from "node:fs/promises"
 import path from "node:path"
 
+import type { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"
+
 async function main() {
   const commitMessage = core.getInput("message")
   const branch = core.getInput("branch")
@@ -22,17 +24,19 @@ async function main() {
   const headCommitSha = (await exec.getExecOutput("git", ["-C", directory, "rev-parse", "HEAD"], { silent: true })).stdout.trim()
   const headTreeSha = (await exec.getExecOutput("git", ["-C", directory, "rev-parse", "HEAD:"], { silent: true })).stdout.trim()
 
-  const tree = {}
+  const tree: Record<string, RestEndpointMethodTypes["git"]["createTree"]["parameters"]["tree"][number]> = {}
   for (const file of files) {
     const absoluteFile = path.resolve(directory, file)
 
     let content;
     try {
       content = await fs.readFile(absoluteFile, {encoding: "base64"})
     } catch (error) {
-      if (error.code !== "ENOENT") throw error;
-
-      content = null;
+      if (error instanceof Error && "code" in error && error.code === "ENOENT") {
+        content = null
+      } else {
+        throw error
+      }
     }
 
     if (content !== null) {
@@ -59,7 +63,7 @@ async function main() {
       const blobResponse = await client.rest.git.createBlob({
         owner: owner,
         repo: repo,
-        content: await fs.readFile(absoluteFile, {encoding: "base64"}),
+        content: content,
         encoding: "base64"
       })
 

api-commit-and-push/main.test.mjs renamed to api-commit-and-push/main.test.mts

@@ -4,13 +4,15 @@ import os from "node:os"
 import path from "node:path"
 import util from "node:util"
 
+import type { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"
+
 describe("api-commit-and-push", async () => {
   const token = "fake-token"
   const branch = "a-branch"
   const message = "Some message"
-  let directory
-  let baseCommitSha
-  let baseTreeSha
+  let directory: string
+  let baseCommitSha: string
+  let baseTreeSha: string
 
   const blobSha = "abcdef1234567890abcdef1234567890abcdef12"
   const treeSha = "abcdef1234567890abcdef1234567890abcdef13"
@@ -70,7 +72,7 @@ describe("api-commit-and-push", async () => {
       sha: blobSha,
     })
 
-    const tree = []
+    const tree: Array<RestEndpointMethodTypes["git"]["createTree"]["parameters"]["tree"][number]> = []
     addedFile.split("/").slice(0, -1).reduce((parentPath, component) => {
       const treePath = path.posix.join(parentPath, component);
 

check-commit-format/action.yml

@@ -22,5 +22,5 @@ inputs:
     required: false
     default: CI-published-bottle-commits
 runs:
-  using: node20
-  main: main.mjs
+  using: node24
+  main: main.mts

check-commit-format/main.mjs renamed to check-commit-format/main.mts

@@ -1,8 +1,11 @@
+import assert from "node:assert/strict"
 import core from "@actions/core"
 import github from "@actions/github"
 import fs from "fs"
 import path from "path"
 
+import type { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods"
+
 async function main() {
     try {
         const token = core.getInput("token", { required: true })
@@ -13,6 +16,7 @@ async function main() {
         const client = github.getOctokit(token)
 
         // Parse event
+        assert(process.env.GITHUB_EVENT_PATH)
         const json = fs.readFileSync(process.env.GITHUB_EVENT_PATH, { encoding: "utf-8" })
         const event = JSON.parse(json)
         const pull = event.pull_request
@@ -25,9 +29,9 @@ async function main() {
 
         let is_success = true
         let autosquash = false
-        let commit_state = "success"
+        let commit_state: RestEndpointMethodTypes["repos"]["createCommitStatus"]["parameters"]["state"] = "success"
         let message = "Commit format is correct."
-        let files_touched = []
+        let files_touched: Array<string> = []
         let target_url = "https://docs.brew.sh/Formula-Cookbook#commit"
 
         // For each commit...
@@ -47,6 +51,14 @@ async function main() {
                 break
             }
 
+            // Empty commits that are not merge commits are usually a mistake or a bad rebase.
+            if (!commit_info.data.files || commit_info.data.files.length === 0) {
+                is_success = false
+                commit_state = "failure"
+                message = `${short_sha} is an empty commit.`
+                break
+            }
+
             // Autosquash doesn't support commits that modify more than one file.
             if (commit_info.data.files.length != 1) {
                 is_success = false
@@ -72,7 +84,7 @@ async function main() {
             }
 
             const file = commit_info.data.files[0]
-            const commit_subject = commit_info.data.commit.message.split("\n").shift()
+            const commit_subject = commit_info.data.commit.message.split("\n")[0]
 
             if (file.filename.startsWith("Formula/")) {
                 const formula = path.basename(file.filename, '.rb')
@@ -118,11 +130,11 @@ async function main() {
         })
 
         // Get existing labels on PR
-        let existingLabels = await client.rest.issues.listLabelsOnIssue({
+        let issueLabels = await client.rest.issues.listLabelsOnIssue({
             ...github.context.repo,
             issue_number: pull.number
         })
-        existingLabels = existingLabels.data.map(label => label.name)
+        let existingLabels = issueLabels.data.map(label => label.name)
 
         // Copy labels into new Array
         const updatedLabels = existingLabels.slice()
@@ -167,6 +179,8 @@ async function main() {
             labels: updatedLabels
         })
     } catch (error) {
+        if (!(error instanceof Error)) throw error
+
         core.setFailed(error)
     }
 }

check-commit-format/main.test.mjs renamed to check-commit-format/main.test.mts

@@ -28,7 +28,9 @@ describe("check-commit-format", async () => {
   })
 
   afterEach(() => {
-    fs.rmSync(path.dirname(process.env.GITHUB_EVENT_PATH), { recursive: true })
+    if (process.env.GITHUB_EVENT_PATH) {
+      fs.rmSync(path.dirname(process.env.GITHUB_EVENT_PATH), { recursive: true })
+    }
   })
 
   describe("on a correct commit", async () => {
@@ -132,6 +134,177 @@ describe("check-commit-format", async () => {
     })
   })
 
+  describe("on a merge commit", async () => {
+    beforeEach(() => {
+      const mockPool = githubMockPool()
+
+      mockPool.intercept({
+        method: "GET",
+        path: `/repos/${GITHUB_REPOSITORY}/pulls/${pr}/commits`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, [
+        {
+          sha: sha,
+        },
+      ])
+
+      mockPool.intercept({
+        method: "GET",
+        path: `/repos/${GITHUB_REPOSITORY}/commits/${sha}`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, {
+        sha: sha,
+        parents: [
+          { sha: "abcdef1234567890abcdef1234567890abcdef11" },
+          { sha: "abcdef1234567890abcdef1234567890abcdef12" }
+        ],
+        files: [],
+        commit: {
+          message: "Merge commit",
+        }
+      })
+
+      mockPool.intercept({
+        method: "POST",
+        path: `/repos/${GITHUB_REPOSITORY}/statuses/${sha}`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+        body: (body) => util.isDeepStrictEqual(JSON.parse(body), {
+          state:       "failure",
+          description: `${sha.substring(0, 10)} has 2 parents. Please rebase against origin/HEAD.`,
+          context:     "Commit style",
+          target_url:  "https://docs.brew.sh/Formula-Cookbook#commit"
+        }),
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, {})
+    })
+
+    it("fails and adds a failure label", async () => {
+      const mockPool = githubMockPool()
+
+      mockPool.intercept({
+        method: "GET",
+        path: `/repos/${GITHUB_REPOSITORY}/issues/${pr}/labels`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, [
+        { name: "other-label" },
+      ])
+
+      mockPool.intercept({
+        method: "PATCH",
+        path: `/repos/${GITHUB_REPOSITORY}/issues/${pr}`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+        body: (body) => util.isDeepStrictEqual(JSON.parse(body), {
+          labels: ["other-label", failureLabel],
+        }),
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, {})
+
+      await loadMain()
+    })
+  })
+
+  describe("on an empty commit", async () => {
+    beforeEach(() => {
+      const mockPool = githubMockPool()
+
+      mockPool.intercept({
+        method: "GET",
+        path: `/repos/${GITHUB_REPOSITORY}/pulls/${pr}/commits`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, [
+        {
+          sha: sha,
+        },
+      ])
+
+      mockPool.intercept({
+        method: "GET",
+        path: `/repos/${GITHUB_REPOSITORY}/commits/${sha}`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, {
+        sha: sha,
+        parents: [{ sha: "abcdef1234567890abcdef1234567890abcdef11" }],
+        files: [],
+        commit: {
+          message: "Empty commit",
+        }
+      })
+
+      mockPool.intercept({
+        method: "POST",
+        path: `/repos/${GITHUB_REPOSITORY}/statuses/${sha}`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+        body: (body) => util.isDeepStrictEqual(JSON.parse(body), {
+          state:       "failure",
+          description: `${sha.substring(0, 10)} is an empty commit.`,
+          context:     "Commit style",
+          target_url:  "https://docs.brew.sh/Formula-Cookbook#commit"
+        }),
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, {})
+    })
+
+    it("fails and adds a failure label", async () => {
+      const mockPool = githubMockPool()
+
+      mockPool.intercept({
+        method: "GET",
+        path: `/repos/${GITHUB_REPOSITORY}/issues/${pr}/labels`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, [
+        { name: "other-label" },
+      ])
+
+      mockPool.intercept({
+        method: "PATCH",
+        path: `/repos/${GITHUB_REPOSITORY}/issues/${pr}`,
+        headers: {
+          Authorization: `token ${token}`,
+        },
+        body: (body) => util.isDeepStrictEqual(JSON.parse(body), {
+          labels: ["other-label", failureLabel],
+        }),
+      }).defaultReplyHeaders({
+        "Content-Type": "application/json",
+      }).reply(200, {})
+
+      await loadMain()
+    })
+  })
+
   describe("on an autosquashable incorrect commit", async () => {
     beforeEach(() => {
       const mockPool = githubMockPool()

create-or-update-issue/action.yml

@@ -62,5 +62,5 @@ outputs:
       The node ID of the created or updated issue, used in GitHub GraphQL API
       queries; undefined if `outcome` is `none`
 runs:
-  using: node20
-  main: main.mjs
+  using: node24
+  main: main.mts