convert action source and tests to TypeScript (#100)

Author: Simek

.oxlintrc.json

@@ -1,6 +1,6 @@
 {
   "$schema": "./node_modules/oxlint/configuration_schema.json",
-  "plugins": ["import", "promise", "unicorn"],
+  "plugins": ["import", "promise", "typescript", "unicorn"],
   "ignorePatterns": ["**/dist"],
   "rules": {
     "curly": "error",
@@ -36,6 +36,32 @@
     "import/no-self-import": "error",
     "promise/always-return": "error",
     "promise/no-callback-in-promise": "error",
+    "typescript/await-thenable": "error",
+    "typescript/ban-ts-comment": [
+      "error",
+      {
+        "minimumDescriptionLength": 3,
+        "ts-check": false,
+        "ts-expect-error": "allow-with-description",
+        "ts-ignore": true,
+        "ts-nocheck": true
+      }
+    ],
+    "typescript/consistent-type-imports": ["error", { "fixStyle": "inline-type-imports" }],
+    "typescript/no-confusing-non-null-assertion": "error",
+    "typescript/no-extra-non-null-assertion": "error",
+    "typescript/no-misused-promises": ["error", { "checksVoidReturn": false }],
+    "typescript/no-restricted-types": "error",
+    "typescript/no-unnecessary-boolean-literal-compare": "error",
+    "typescript/no-unnecessary-type-arguments": "error",
+    "typescript/no-unnecessary-type-assertion": "error",
+    "typescript/no-unnecessary-type-constraint": "error",
+    "typescript/no-unsafe-enum-comparison": "error",
+    "typescript/prefer-includes": "error",
+    "typescript/prefer-nullish-coalescing": "error",
+    "typescript/prefer-readonly": "error",
+    "typescript/return-await": ["error", "error-handling-correctness-only"],
+    "typescript/unbound-method": "off",
     "unicorn/consistent-date-clone": "error",
     "unicorn/consistent-empty-array-spread": "error",
     "unicorn/consistent-existence-index-check": "error",

dist/index.js

@@ -6,11 +6,11 @@
   "author": "Simek <me@simek.dev>",
   "license": "MIT",
   "scripts": {
-    "build": "esbuild src/action.js --bundle --platform=node --target=node22 --minify --legal-comments=none --outfile=dist/index.js",
-    "lint": "oxlint && oxfmt --check",
-    "lint:fix": "oxlint --fix && oxfmt",
+    "build": "esbuild src/action.ts --bundle --platform=node --target=node22 --minify --legal-comments=none --outfile=dist/index.js",
+    "lint": "oxlint --type-aware && oxfmt --check",
+    "lint:fix": "oxlint --type-aware --fix && oxfmt",
     "optimize": "svgo -f ./assets",
-    "test": "uvu tests -i .cjs -i testUtils"
+    "test": "node --import tsx --test"
   },
   "dependencies": {
     "@actions/core": "^3.0.0",
@@ -20,12 +20,16 @@
     "semver": "^7.7.3"
   },
   "devDependencies": {
+    "@types/node": "24.1.0",
+    "@types/semver": "^7.7.1",
     "@yarnpkg/lockfile": "^1.1.0",
     "@yarnpkg/parsers": "^3.0.3",
     "esbuild": "^0.27.2",
     "oxfmt": "^0.27.0",
     "oxlint": "^1.42.0",
-    "uvu": "^0.5.6"
+    "oxlint-tsgolint": "^0.11.4",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
   },
   "volta": {
     "node": "24.13.0",

package.json

@@ -1,13 +1,20 @@
 import { debug, getBooleanInput, getInput, setFailed, warning } from '@actions/core';
 import { context, getOctokit } from '@actions/github';
+import { type operations } from '@octokit/openapi-types';
+import { type Api } from '@octokit/plugin-rest-endpoint-methods';
 import { Base64 } from 'js-base64';
 import { existsSync, readFileSync } from 'node:fs';
 import { resolve } from 'node:path';
 
-import { createSummary, createTable } from './comment.mjs';
-import { countStatuses, diffLocks, parseLock, STATUS } from './utils.mjs';
+import { createSummary, createTable } from './comment';
+import { countStatuses, diffLocks, parseLock, STATUS } from './utils';
 
-async function getCommentId(octokit, oktokitParams, issueNumber, commentHeader) {
+async function getCommentId(
+  octokit: Api,
+  oktokitParams: { owner: string; repo: string },
+  issueNumber: number,
+  commentHeader: string
+) {
   const currentComments = await octokit.rest.issues.listComments({
     ...oktokitParams,
     issue_number: issueNumber,
@@ -19,11 +26,11 @@ async function getCommentId(octokit, oktokitParams, issueNumber, commentHeader)
   }
 
   return currentComments.data
-    .filter(({ user, body }) => user.login === 'github-actions[bot]' && body.startsWith(commentHeader))
+    .filter(({ user, body }) => user?.login === 'github-actions[bot]' && body?.startsWith(commentHeader))
     .map(({ id }) => id)[0];
 }
 
-function getBasePathFromInput(input) {
+function getBasePathFromInput(input: string) {
   return input.lastIndexOf('/') ? input.substring(0, input.lastIndexOf('/')) : '';
 }
 
@@ -38,14 +45,20 @@ async function run() {
 
     const { owner, repo, number } = context.issue;
 
-    if (!number) {
+    if (!number || !context.payload.pull_request) {
       throw Error('💥 Cannot find the PR data in the workflow context, aborting!');
     }
 
     const { ref } = context.payload.pull_request.base;
-    const { default_branch } = context.payload.repository;
+    const contextRepo = context.payload?.repository;
 
-    const baseBranch = ref || default_branch;
+    if (!contextRepo) {
+      throw Error('💥 Cannot find the repository data in the workflow context, aborting!');
+    }
+
+    const { default_branch } = contextRepo;
+
+    const baseBranch = ref ?? default_branch;
     debug('Base branch: ' + baseBranch);
 
     const lockPath = resolve(process.cwd(), inputPath);
@@ -56,6 +69,9 @@ async function run() {
 
     const content = readFileSync(lockPath, { encoding: 'utf8' });
     const updatedLock = parseLock(content);
+    if (updatedLock.type === 'error') {
+      warning('Unsupported Yarn lock version! Please report this issue in the action repository.');
+    }
 
     const oktokitParams = { owner, repo };
     debug('Oktokit params: ' + JSON.stringify(oktokitParams));
@@ -73,7 +89,10 @@ async function run() {
       throw Error('💥 Cannot fetch repository base branch tree, aborting!');
     }
 
-    const baseLockSHA = baseTree.data.tree.filter(file => file.path === 'yarn.lock')[0].sha;
+    const baseLockSHA = baseTree.data.tree.filter(
+      (file: operations['repos/get-content']['responses']['200']['content']['application/vnd.github.object']) =>
+        file.path === 'yarn.lock'
+    )[0].sha;
 
     debug('Base lockfile SHA: ' + baseLockSHA);
 
@@ -155,7 +174,11 @@ async function run() {
       }
     }
   } catch (error) {
-    setFailed(error.message);
+    if (error instanceof Error) {
+      setFailed(error.message);
+    } else if (typeof error === 'string') {
+      setFailed(error);
+    }
   }
 }
 

src/action.js src/action.tssrc/action.js renamed to src/action.ts

@@ -1,6 +1,7 @@
 import { markdownTable } from 'markdown-table';
 
-import { countStatuses, STATUS_ORDER } from './utils.mjs';
+import { type LockChanges, type StausType } from './types';
+import { countStatuses, STATUS_ORDER } from './utils';
 
 const ASSETS_URL = {
   ADDED: 'https://git.io/J38HP',
@@ -16,11 +17,11 @@ const ASSETS_WIDTH = {
   UPDATED: 60,
 };
 
-function getStatusLabel(status) {
+function getStatusLabel(status: StausType) {
   return `[<sub><img alt="${status}" src="${ASSETS_URL[status]}" height="16" width="${ASSETS_WIDTH[status]}" /></sub>](#)`;
 }
 
-export function createTable(lockChanges, groupByType = false, plainStatuses = false) {
+export function createTable(lockChanges: Record<string, LockChanges>, groupByType = false, plainStatuses = false) {
   return markdownTable(
     [
       ['Name', 'Status', 'Previous', 'Current'],
@@ -41,14 +42,14 @@ export function createTable(lockChanges, groupByType = false, plainStatuses = fa
   );
 }
 
-function createSummaryRow(lockChanges, status) {
+function createSummaryRow(lockChanges: Record<string, LockChanges>, status: keyof typeof ASSETS_URL) {
   const statusCount = countStatuses(lockChanges, status);
-  return statusCount ? [getStatusLabel(status), statusCount] : undefined;
+  return statusCount ? [getStatusLabel(status), statusCount.toString()] : [undefined];
 }
 
-export function createSummary(lockChanges) {
-  return markdownTable(
-    [['Status', 'Count'], ...STATUS_ORDER.map(status => createSummaryRow(lockChanges, status))].filter(Boolean),
-    { align: ['l', 'c'], alignDelimiters: false }
-  );
+export function createSummary(lockChanges: Record<string, LockChanges>) {
+  return markdownTable([['Status', 'Count'], ...STATUS_ORDER.map(status => createSummaryRow(lockChanges, status))], {
+    align: ['l', 'c'],
+    alignDelimiters: false,
+  });
 }

src/comment.mjs src/comment.tssrc/comment.mjs renamed to src/comment.ts

@@ -0,0 +1,29 @@
+export type StausType = 'ADDED' | 'DOWNGRADED' | 'REMOVED' | 'UPDATED';
+
+export type ParsedLock = {
+  type: 'error' | 'success';
+  object: Record<string, ClassicYarnEntry | BerryYarnEntry>;
+};
+
+export type LockChanges = {
+  previous: string;
+  current: string;
+  status: StausType;
+};
+
+export type ClassicYarnEntry = {
+  version: string;
+  resolved: string;
+  integrity: string;
+  dependencies: Record<string, string>;
+};
+
+export type BerryYarnEntry = {
+  version: string;
+  resolved: string;
+  integrity: string;
+  language: string;
+  link: string;
+  dependencies: Record<string, string>;
+  peerDependencies: Record<string, string>;
+};