refactor: remove ci-test script and implement setup function for dependency installation

Author: DE7924

dist/index.js

@@ -28,7 +28,6 @@
     "setup": "npm i && npm run bundle",
     "analyze": "cem analyze",
     "bundle": "npm run format:write && npm run package",
-    "ci-test": "npx jest",
     "coverage": "npx make-coverage-badge --output-path ./badges/coverage.svg",
     "docs": "npx typedoc --logLevel Warn",
     "format:write": "npx prettier --write .",

dist/index.js.map

@@ -8,6 +8,7 @@ import { comment } from "./scripts/comment";
 import { cwd, chdir } from "process";
 // import { coverage } from './scripts/coverage'
 import minimist from "minimist";
+import { setup } from "./scripts/setup";
 
 export type stepResponse = { output: string; error: boolean };
 export const failedEmoji = "❌";
@@ -68,12 +69,6 @@ export async function run(): Promise<void> {
   const isLocal =
     argv._.findLast((x: string) => x == "--local") == "--local" ? true : false;
 
-  try {
-    await exec("npm ci");
-  } catch (error: unknown) {
-    if (error instanceof Error) setFailed(error.message);
-  }
-
   try {
     const workingDirectory = getInput("working-directory");
     // Check if the working directory is different from the current directory
@@ -106,11 +101,14 @@ export async function run(): Promise<void> {
 
     // const runCoverage: boolean = getBooleanInput('run-coverage');
     // const coveragePassScore: string = getInput('coverage-pass-score');
-
+    // get comment input
     const createComment: boolean = isLocal
       ? true
       : getBooleanInput("create-comment");
 
+    // run set up
+    const setupStr: stepResponse | undefined = await setup();
+
     // run Static Analysis
     const analyzeStr: stepResponse | undefined = doStaticAnalysis
       ? await analyze()
@@ -136,6 +134,7 @@ export async function run(): Promise<void> {
       await comment(
         octokit,
         context,
+        setupStr,
         analyzeStr,
         codeFormattingStr,
         testingStr,

package.json

@@ -6,6 +6,7 @@ import { stepResponse } from "src/main";
 export const comment = async (
   ocotokit: ReturnType<typeof getOctokit>,
   context: Context,
+  setupStr: stepResponse | undefined,
   analyzeStr: stepResponse | undefined,
   codeFormattingStr: stepResponse | undefined,
   testingStr: stepResponse | undefined,
@@ -14,11 +15,12 @@ export const comment = async (
     const commentBody = `
 ## PR Checks Complete\n
 <ul>
+${setupStr?.output}
 ${analyzeStr?.output}
 ${codeFormattingStr?.output}
 ${testingStr?.output}
 </ul>`;
-    //    ## Coverage = ${coverageStr?.output}\n`
+    // ## Coverage = ${coverageStr?.output}\n`
 
     const { data: comments } = await ocotokit.rest.issues.listComments({
       issue_number: context.issue.number,

src/main.ts

@@ -0,0 +1,15 @@
+import { setFailed } from "@actions/core";
+import { stepResponse, buildComment } from "src/main";
+
+export const setup = async (): Promise<stepResponse> => {
+  const commands = [{ label: "Install Dependencies", command: "npm ci" }];
+
+  const [commentBody, errorMessages] = await buildComment(commands);
+
+  if (errorMessages) {
+    setFailed(errorMessages.trim());
+    return { output: commentBody.trim(), error: true };
+  } else {
+    return { output: commentBody.trim(), error: false };
+  }
+};

src/scripts/comment.ts

@@ -1,9 +1,41 @@
 import { setFailed } from "@actions/core";
 import { stepResponse, buildComment } from "src/main";
+import { exec } from "@actions/exec";
 
 export const testing = async (): Promise<stepResponse> => {
+  const runCommand = (command: string): Promise<string> => {
+    return new Promise((resolve, reject) => {
+      exec(command, [], {
+        listeners: {
+          stdout: (data: Buffer) => {
+            resolve(data.toString());
+          },
+          stderr: (data: Buffer) => {
+            reject(data.toString());
+          },
+        },
+      }).catch((error: any) => {
+        reject(error);
+      });
+    });
+  };
+
+  await runCommand("npm ls @playwright/test | grep @playwright | sed 's/.*@//'")
+    .then((version) => {
+      process.env.PLAYWRIGHT_VERSION = version.trim();
+    })
+    .catch((error) => {
+      setFailed(`Failed to get Playwright version: ${error}`);
+      return { output: "", error: true };
+    });
+
   const commands = [
-    { label: "Testing", command: "npm run test -- --coverage" },
+    // { label: "Testing", command: "npm run test -- --coverage" },
+    {
+      label: "Install PlayWright Browsers",
+      command: "npx playwright install --with-deps",
+    },
+    { label: "Testing", command: "npm run test" },
     { label: "TSDoc", command: "npm run docs" },
   ];