chore: fix lint findings

Author: Codex-

src/action.spec.ts

@@ -25,7 +25,8 @@ describe("Action", () => {
         workflow_timeout_seconds: "60",
       };
 
-      vi.spyOn(core, "getInput").mockImplementation((input: string) => {
+      vi.spyOn(core, "getInput").mockImplementation((input: string): string => {
+        /* eslint-disable @typescript-eslint/no-unsafe-return */
         switch (input) {
           case "token":
             return mockEnvConfig.token;
@@ -44,6 +45,7 @@ describe("Action", () => {
           default:
             throw new Error("invalid input requested");
         }
+        /* eslint-enable @typescript-eslint/no-unsafe-return */
       });
     });
 

src/action.ts

@@ -42,9 +42,7 @@ export interface ActionConfig {
   workflowTimeoutSeconds: number;
 }
 
-interface ActionWorkflowInputs {
-  [input: string]: string | number | boolean;
-}
+type ActionWorkflowInputs = Record<string, string | number | boolean>;
 
 export enum ActionOutputs {
   runId = "run_id",
@@ -91,32 +89,23 @@ function getWorkflowInputs(
   }
 
   try {
-    const parsedJson = JSON.parse(workflowInputs);
+    const parsedJson = JSON.parse(workflowInputs) as Record<string, unknown>;
     for (const key of Object.keys(parsedJson)) {
       const value = parsedJson[key];
-      const type = (() => {
-        switch (true) {
-          case value === null: {
-            return "null";
-          }
-          case Array.isArray(value): {
-            return "Array";
-          }
-          default:
-            return typeof value;
-        }
-      })();
+      const type =
+        value === null ? "null" : Array.isArray(value) ? "Array" : typeof value;
+
       if (!["string", "number", "boolean"].includes(type)) {
         throw new Error(
           `Expected value to be string, number, or boolean. "${key}" value is ${type}`,
         );
       }
     }
-    return parsedJson;
+    return parsedJson as ActionWorkflowInputs;
   } catch (error) {
     core.error("Failed to parse workflow_inputs JSON");
     if (error instanceof Error) {
-      error.stack && core.debug(error.stack);
+      core.debug(error.stack ?? "");
     }
     throw error;
   }
@@ -125,6 +114,7 @@ function getWorkflowInputs(
 function getWorkflowValue(workflowInput: string): string | number {
   try {
     // We can assume that the string is defined and not empty at this point.
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
     return getNumberFromValue(workflowInput)!;
   } catch {
     // Assume using a workflow name instead of an ID.

src/api.spec.ts

@@ -21,29 +21,32 @@ interface MockResponse {
   status: number;
 }
 
-async function* mockPageIterator<T, P>(apiMethod: (params: P) => T, params: P) {
+function* mockPageIterator<T, P>(
+  apiMethod: (params: P) => T,
+  params: P,
+): Generator<T, void> {
   yield apiMethod(params);
 }
 
 const mockOctokit = {
   rest: {
     actions: {
-      createWorkflowDispatch: async (_req?: any): Promise<MockResponse> => {
+      createWorkflowDispatch: (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
-      getWorkflowRun: async (_req?: any): Promise<MockResponse> => {
+      getWorkflowRun: (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
-      listRepoWorkflows: async (_req?: any): Promise<MockResponse> => {
+      listRepoWorkflows: (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
-      listWorkflowRuns: async (_req?: any): Promise<MockResponse> => {
+      listWorkflowRuns: (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
-      downloadWorkflowRunLogs: async (_req?: any): Promise<MockResponse> => {
+      downloadWorkflowRunLogs: (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
-      listJobsForWorkflowRun: async (_req?: any): Promise<MockResponse> => {
+      listJobsForWorkflowRun: (_req?: any): Promise<MockResponse> => {
         throw new Error("Should be mocked");
       },
     },
@@ -75,6 +78,7 @@ describe("API", () => {
           return "";
       }
     });
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
     vi.spyOn(github, "getOctokit").mockReturnValue(mockOctokit as any);
     init();
   });
@@ -121,13 +125,13 @@ describe("API", () => {
       vi.spyOn(
         mockOctokit.rest.actions,
         "createWorkflowDispatch",
-      ).mockImplementation(async (req?: any) => {
+      ).mockImplementation((req?: any) => {
         dispatchedId = req.inputs.distinct_id;
 
-        return {
+        return Promise.resolve({
           data: undefined,
           status: 204,
-        };
+        });
       });
 
       await dispatchWorkflow(distinctId);
@@ -255,7 +259,7 @@ describe("API", () => {
       workflowIdCfg.ref = "/refs/heads/master";
       let parsedRef!: string;
       vi.spyOn(mockOctokit.rest.actions, "listWorkflowRuns").mockImplementation(
-        async (req: any) => {
+        (req: any) => {
           parsedRef = req.branch;
           const mockResponse: MockResponse = {
             data: {
@@ -264,7 +268,7 @@ describe("API", () => {
             },
             status: 200,
           };
-          return mockResponse;
+          return Promise.resolve(mockResponse);
         },
       );
 
@@ -276,7 +280,7 @@ describe("API", () => {
       workflowIdCfg.ref = "/refs/tags/1.5.0";
       let parsedRef!: string;
       vi.spyOn(mockOctokit.rest.actions, "listWorkflowRuns").mockImplementation(
-        async (req: any) => {
+        (req: any) => {
           parsedRef = req.branch;
           const mockResponse: MockResponse = {
             data: {
@@ -285,7 +289,7 @@ describe("API", () => {
             },
             status: 200,
           };
-          return mockResponse;
+          return Promise.resolve(mockResponse);
         },
       );
 
@@ -297,7 +301,7 @@ describe("API", () => {
       workflowIdCfg.ref = "/refs/cake";
       let parsedRef!: string;
       vi.spyOn(mockOctokit.rest.actions, "listWorkflowRuns").mockImplementation(
-        async (req: any) => {
+        (req: any) => {
           parsedRef = req.branch;
           const mockResponse: MockResponse = {
             data: {
@@ -306,7 +310,7 @@ describe("API", () => {
             },
             status: 200,
           };
-          return mockResponse;
+          return Promise.resolve(mockResponse);
         },
       );
 
@@ -433,16 +437,13 @@ describe("API", () => {
     });
 
     it("should return a populated array", async () => {
-      const attempt = async () => {
-        return [0];
-      };
-
+      const attempt = () => Promise.resolve([0]);
       expect(await retryOrDie(attempt, 1000)).toHaveLength(1);
     });
 
     it("should throw if the given timeout is exceeded", async () => {
       // Never return data.
-      const attempt = async () => [];
+      const attempt = () => Promise.resolve([]);
 
       const retryOrDiePromise = retryOrDie(attempt, 1000);
       vi.advanceTimersByTime(2000);

src/api.ts

@@ -9,7 +9,7 @@ let config: ActionConfig;
 let octokit: Octokit;
 
 export function init(cfg?: ActionConfig): void {
-  config = cfg || getConfig();
+  config = cfg ?? getConfig();
   octokit = github.getOctokit(config.token);
 }
 
@@ -27,6 +27,7 @@ export async function dispatchWorkflow(distinctId: string): Promise<void> {
       },
     });
 
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (response.status !== 204) {
       throw new Error(
         `Failed to dispatch action, expected 204 but received ${response.status}`,
@@ -48,7 +49,7 @@ export async function dispatchWorkflow(distinctId: string): Promise<void> {
       core.error(
         `dispatchWorkflow: An unexpected error has occurred: ${error.message}`,
       );
-      error.stack && core.debug(error.stack);
+      core.debug(error.stack ?? "");
     }
     throw error;
   }
@@ -72,6 +73,7 @@ export async function getWorkflowId(workflowFilename: string): Promise<number> {
     let workflowId: number | undefined;
 
     for await (const response of workflowIterator) {
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
       if (response.status !== 200) {
         throw new Error(
           `Failed to get workflows, expected 200 but received ${response.status}`,
@@ -99,7 +101,7 @@ export async function getWorkflowId(workflowFilename: string): Promise<number> {
       core.error(
         `getWorkflowId: An unexpected error has occurred: ${error.message}`,
       );
-      error.stack && core.debug(error.stack);
+      core.debug(error.stack ?? "");
     }
     throw error;
   }
@@ -114,6 +116,7 @@ export async function getWorkflowRunUrl(runId: number): Promise<string> {
       run_id: runId,
     });
 
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (response.status !== 200) {
       throw new Error(
         `Failed to get Workflow Run state, expected 200 but received ${response.status}`,
@@ -133,7 +136,7 @@ export async function getWorkflowRunUrl(runId: number): Promise<string> {
       core.error(
         `getWorkflowRunUrl: An unexpected error has occurred: ${error.message}`,
       );
-      error.stack && core.debug(error.stack);
+      core.debug(error.stack ?? "");
     }
     throw error;
   }
@@ -158,6 +161,7 @@ export async function getWorkflowRunIds(workflowId: number): Promise<number[]> {
           }),
     });
 
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (response.status !== 200) {
       throw new Error(
         `Failed to get Workflow runs, expected 200 but received ${response.status}`,
@@ -171,9 +175,9 @@ export async function getWorkflowRunIds(workflowId: number): Promise<number[]> {
     core.debug(
       "Fetched Workflow Runs:\n" +
         `  Repository: ${config.owner}/${config.repo}\n` +
-        `  Branch: ${branchName || "undefined"}\n` +
+        `  Branch: ${branchName}\n` +
         `  Workflow ID: ${workflowId}\n` +
-        `  Runs Fetched: [${runIds}]`,
+        `  Runs Fetched: [${runIds.join(", ")}]`,
     );
 
     return runIds;
@@ -182,7 +186,7 @@ export async function getWorkflowRunIds(workflowId: number): Promise<number[]> {
       core.error(
         `getWorkflowRunIds: An unexpected error has occurred: ${error.message}`,
       );
-      error.stack && core.debug(error.stack);
+      core.debug(error.stack ?? "");
     }
     throw error;
   }
@@ -198,6 +202,7 @@ export async function getWorkflowRunJobSteps(runId: number): Promise<string[]> {
       filter: "latest",
     });
 
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (response.status !== 200) {
       throw new Error(
         `Failed to get Workflow Run Jobs, expected 200 but received ${response.status}`,
@@ -206,16 +211,16 @@ export async function getWorkflowRunJobSteps(runId: number): Promise<string[]> {
 
     const jobs = response.data.jobs.map((job) => ({
       id: job.id,
-      steps: job.steps?.map((step) => step.name) || [],
+      steps: job.steps?.map((step) => step.name) ?? [],
     }));
     const steps = Array.from(new Set(jobs.flatMap((job) => job.steps)));
 
     core.debug(
       "Fetched Workflow Run Job Steps:\n" +
         `  Repository: ${config.owner}/${config.repo}\n` +
         `  Workflow Run ID: ${runId}\n` +
-        `  Jobs Fetched: [${jobs.map((job) => job.id)}]` +
-        `  Steps Fetched: [${steps}]`,
+        `  Jobs Fetched: [${jobs.map((job) => job.id).join(", ")}]` +
+        `  Steps Fetched: [${steps.join(", ")}]`,
     );
 
     return steps;
@@ -224,7 +229,7 @@ export async function getWorkflowRunJobSteps(runId: number): Promise<string[]> {
       core.error(
         `getWorkflowRunJobs: An unexpected error has occurred: ${error.message}`,
       );
-      error.stack && core.debug(error.stack);
+      core.debug(error.stack ?? "");
     }
     throw error;
   }

src/main.ts

@@ -45,7 +45,7 @@ async function run(): Promise<void> {
       );
 
       core.debug(
-        `Attempting to get step names for Run IDs: [${workflowRunIds}]`,
+        `Attempting to get step names for Run IDs: [${workflowRunIds.join(", ")}]`,
       );
 
       const idRegex = new RegExp(DISTINCT_ID);
@@ -93,10 +93,10 @@ async function run(): Promise<void> {
     if (error instanceof Error) {
       core.error(`Failed to complete: ${error.message}`);
       core.warning("Does the token have the correct permissions?");
-      error.stack && core.debug(error.stack);
+      core.debug(error.stack ?? "");
       core.setFailed(error.message);
     }
   }
 }
 
-(() => run())();
+((): Promise<void> => run())();

src/reset.d.ts

@@ -0,0 +1,2 @@
+// Do not add any other lines of code to this file!
+import "@total-typescript/ts-reset";

src/utils.ts

@@ -2,7 +2,7 @@ import * as core from "@actions/core";
 
 function getBranchNameFromRef(ref: string): string | undefined {
   const refItems = ref.split(/\/?refs\/heads\//);
-  if (refItems.length > 1 && refItems[1]!.length > 0) {
+  if (refItems.length > 1 && (refItems[1]?.length ?? 0) > 0) {
     return refItems[1];
   }
 }