refactor output formatting in analyze, comment, formatting, and testing scripts to use list items for better HTML structure

Author: DE7924

dist/index.js

@@ -14,11 +14,11 @@ export const analyze = async (): Promise<stepResponse> => {
   for (const { label, command } of results) {
     const result = await runCommand(command, label);
     if (result) {
-      commentBody += `${failedEmoji} - ${label}
-<details><summary>See details</summary>${result}</details>\n`;
+      commentBody += `<li>${failedEmoji} - ${label}
+<details><summary>See details</summary>${result}</details></li>`;
       errorMessages += `${result}\n`;
     } else {
-      commentBody += `${passedEmoji} - ${label}\n`;
+      commentBody += `<li>${passedEmoji} - ${label}\n</li>`;
     }
   }
 

dist/index.js.map

@@ -13,9 +13,11 @@ export const comment = async (
   try {
     const commentBody = `
 ## PR Checks Complete\n
+<ul>
 ${analyzeStr?.output}
 ${codeFormattingStr?.output}
-${testingStr?.output}`;
+${testingStr?.output}
+</ul>`;
     //    ## Coverage = ${coverageStr?.output}\n`
 
     const { data: comments } = await ocotokit.rest.issues.listComments({

src/scripts/analyze.ts

@@ -7,9 +7,9 @@ export const formatting = async (): Promise<stepResponse> => {
     // Run prettier
     await exec("npm run prettier");
 
-    return { output: `${passedEmoji} - Formatting`, error: false };
+    return { output: `<li>${passedEmoji} - Formatting</li>`, error: false };
   } catch (error) {
     if (error instanceof Error) setFailed(error.message);
-    return { output: `${failedEmoji} - Formatting`, error: true };
+    return { output: `<li>${failedEmoji} - Formatting</li>`, error: true };
   }
 };

src/scripts/comment.ts

@@ -14,10 +14,10 @@ export const testing = async (): Promise<stepResponse> => {
   for (const { label, command } of results) {
     const result = await runCommand(command, label);
     if (result) {
-      commentBody += `${failedEmoji} - ${label}\n`;
+      commentBody += `<li>${failedEmoji} - ${label}</li>`;
       errorMessages += `${result}\n`;
     } else {
-      commentBody += `${passedEmoji} - ${label}\n`;
+      commentBody += `<li>${passedEmoji} - ${label}</li>`;
     }
   }