eslint improvments

Author: DE7924

dist/index.js

@@ -10,6 +10,8 @@ import { cwd, chdir } from "process";
 import minimist from "minimist";
 import { setup } from "./scripts/setup";
 
+export type Command = { label: string; command: string };
+
 export type stepResponse = { output: string; error: boolean };
 export const failedEmoji = "❌";
 export const passedEmoji = "✅";
@@ -114,6 +116,10 @@ export async function run(): Promise<void> {
       ? await analyze()
       : undefined;
 
+    const eslintStr: stepResponse | undefined = doStaticAnalysis
+      ? await eslint({ label: "ESLint", command: "npm run lint" })
+      : undefined;
+
     // run Code Formatting
     const codeFormattingStr: stepResponse | undefined = doCodeFormatting
       ? await formatting()
@@ -136,6 +142,7 @@ export async function run(): Promise<void> {
         context,
         setupStr,
         analyzeStr,
+        eslintStr,
         codeFormattingStr,
         testingStr,
       );
@@ -145,3 +152,49 @@ export async function run(): Promise<void> {
     if (error instanceof Error) setFailed(error.message);
   }
 }
+
+const eslint = async (command: Command): Promise<stepResponse> => {
+  let response: stepResponse = { output: "", error: false };
+  let outputStr = "";
+  let error = false;
+  try {
+    await exec(command.command, [], {
+      listeners: {
+        stdout: (data) => {
+          outputStr += data.toString();
+        },
+        stderr: (data) => {
+          outputStr += data.toString();
+        },
+      },
+    });
+  } catch (error) {
+    error = true;
+    setFailed(`Failed ${command.label}: ${error}`);
+  }
+
+  if (error) {
+    response.error = true;
+    // Parse the output to find errors and problems
+    const lines = outputStr.split("\n");
+    const table = lines
+      .map((line) => {
+        const match = line.match(/^(.*?):(\d+):(\d+): (.*)$/);
+        if (match) {
+          const [_, file, line, column, message] = match;
+          return `<tr><td>${file}</td><td>${line}</td><td>${column}</td><td>${message}</td></tr>`;
+        }
+        return "";
+      })
+      .join("");
+
+    const problemCount = lines.filter((line) =>
+      line.match(/^(.*?):(\d+):(\d+): (.*)$/),
+    ).length;
+    response.output = `<p>${problemCount} problem${problemCount !== 1 ? "s" : ""} found</p><details><summary>See Details</summary><table><tr><th>File</th><th>Line</th><th>Column</th><th>Message</th></tr>${table}</table></details>`;
+    return response;
+  } else {
+    response.output = `<li>${passedEmoji} - ${command.label}\n</li>`;
+    return response;
+  }
+};

dist/index.js.map

@@ -1,10 +1,10 @@
 import { setFailed } from "@actions/core";
-import { stepResponse, buildComment } from "src/main";
+import { exec } from "@actions/exec";
+import { stepResponse, buildComment, Command, passedEmoji } from "src/main";
 
 export const analyze = async (): Promise<stepResponse> => {
   const commands = [
     { label: "Custom Elements Manifest Analyzer", command: "npm run analyze" },
-    { label: "ESLint", command: "npm run lint" },
     { label: "Lit Analyzer", command: "npm run lint:lit-analyzer" },
   ];
 
@@ -17,3 +17,48 @@ export const analyze = async (): Promise<stepResponse> => {
     return { output: commentBody.trim(), error: false };
   }
 };
+
+// export const buildComment = async (
+//   commands: { label: string; command: string }[],
+// ): Promise<string[]> => {
+//   let commentBody = "\n";
+//   let errorMessages = "";
+//   for (const { label, command } of commands) {
+//     const result = await runCommand(command, label);
+//     if (result) {
+//       commentBody += `<li>${failedEmoji} - ${label}
+// <details><summary>See details</summary>${result}</details></li>`;
+//       errorMessages += `${result}`;
+//     } else {
+//       commentBody += `<li>${passedEmoji} - ${label}\n</li>`;
+//     }
+//   }
+//   return [commentBody, errorMessages];
+// };
+
+// export const runCommand = async (
+//   command: string,
+//   label: string,
+// ): Promise<string | boolean> => {
+//   let output = "";
+//   try {
+//     await exec(command, [], {
+//       listeners: {
+//         stdout: (data) => {
+//           output += data.toString();
+//         },
+//       },
+//     });
+//     return false;
+//   } catch (error: unknown) {
+//     if (error instanceof Error) {
+//       debug(`${label} failed: ${error.message}`);
+//       return output;
+//     } else if (typeof error === "string") {
+//       debug(`${label} failed: ${error}`);
+//       return output;
+//     } else {
+//       return true;
+//     }
+//   }
+// };

src/main.ts

@@ -8,6 +8,7 @@ export const comment = async (
   context: Context,
   setupStr: stepResponse | undefined,
   analyzeStr: stepResponse | undefined,
+  eslintStr: stepResponse | undefined,
   codeFormattingStr: stepResponse | undefined,
   testingStr: stepResponse | undefined,
 ): Promise<stepResponse> => {
@@ -17,6 +18,7 @@ export const comment = async (
 <ul>
 ${setupStr?.output}
 ${analyzeStr?.output}
+${eslintStr?.output}
 ${codeFormattingStr?.output}
 ${testingStr?.output}
 </ul>`;

src/scripts/analyze.ts

@@ -42,7 +42,7 @@ export const testing = async (): Promise<stepResponse> => {
       label: "Install PlayWright Browsers",
       command: "npx playwright install --with-deps",
     },
-    { label: "Testing", command: "npm run test" },
+    { label: "Testing", command: "npm run test -- --coverage" },
     { label: "TSDoc", command: "npm run docs" },
   ];