Add TypeDoc integration and update README for new functionality

Author: DE7924

README.md

@@ -10,6 +10,7 @@ This action is designed to format and test Web Component repositories on pull re
 - prettier
 - playwright
 - web-test-runner
+- typedoc
 
 ### Usage
 

dist/index.js

@@ -2,7 +2,7 @@ import { getBooleanInput, getInput, setFailed, debug } from "@actions/core";
 import { exec } from "@actions/exec";
 import { getOctokit, context } from "@actions/github";
 import { eslint, litAnalyzer } from "./scripts/analyze";
-import { playwright, testing } from "./scripts/testing";
+import { playwright, testing, typeDoc } from "./scripts/testing";
 import { comment } from "./scripts/comment";
 import { cwd, chdir } from "process";
 // import { coverage } from './scripts/coverage'
@@ -185,7 +185,7 @@ export async function run(): Promise<void> {
       ? await eslint({
           label: "ESLint",
           // TODO: change to -format json
-          command: "npx eslint -f unix '" + wcSrcDirectory + "'",
+          command: "npx eslint -f unix " + wcSrcDirectory,
         })
       : undefined;
 
@@ -240,9 +240,9 @@ export async function run(): Promise<void> {
     // stderr: (data) => {
     //   outputStr += data.toString();
     // },
-    const tsDocStr: StepResponse | undefined = doTests
-      ? await commandComment({
-          label: "TSDoc",
+    const typeDocStr: StepResponse | undefined = doTests
+      ? await typeDoc({
+          label: "TypeDoc",
           command: "npx typedoc --logLevel Warn",
         })
       : undefined;
@@ -285,7 +285,7 @@ export async function run(): Promise<void> {
         prettierStr,
         playwrightStr,
         testingStr,
-        tsDocStr,
+        typeDocStr,
         checkModifiedFilesStr,
         updateChangesStr,
       );

dist/index.js.map

@@ -21,7 +21,7 @@ export const comment = async (
   prettierStr: StepResponse | undefined,
   playwrightStr: StepResponse | undefined,
   testingStr: StepResponse | undefined,
-  tsDocStr: StepResponse | undefined,
+  typeDocStr: StepResponse | undefined,
   checkModifiedFilesStr: StepResponse | undefined,
   updateChangesStr: StepResponse | undefined,
 ): Promise<StepResponse> => {
@@ -36,7 +36,7 @@ export const comment = async (
     ${prettierStr !== undefined ? li(prettierStr.output) : ""}
     ${playwrightStr !== undefined ? li(playwrightStr.output) : ""}
     ${testingStr !== undefined ? li(testingStr.output) : ""}
-    ${tsDocStr !== undefined ? li(tsDocStr.output) : ""}
+    ${typeDocStr !== undefined ? li(typeDocStr.output) : ""}
     ${checkModifiedFilesStr !== undefined ? li(checkModifiedFilesStr.output) : ""}
     ${updateChangesStr !== undefined ? li(updateChangesStr.output) : ""}
   </ul>`;

src/main.ts

@@ -6,6 +6,7 @@ import {
   Command,
   commandComment,
   runBashCommand,
+  runCommand,
   StepResponse,
 } from "src/main";
 import convert from "xml-js";
@@ -88,35 +89,20 @@ export const testing = async (
     outputStr += "</table>";
   }
   return await buildComment(response, outputStr, command.label);
+};
 
-  // const commands = [
-  //   // { label: "Testing", command: "npm run test -- --coverage" },
-  //   {
-  //     label: "Install PlayWright Browsers",
-  //     command: "npx playwright install --with-deps",
-  //   },
-  //   { label: "Testing", command: "npm run test -- --coverage" },
-  //   { label: "TSDoc", command: "npm run docs" },
-  // ];
-
-  // const [commentBody, errorMessages] = await buildComment(commands);
+export const typeDoc = async (command: Command): Promise<StepResponse> => {
+  const [response, commandOutput] = await runCommand(command);
+  let outputStr =
+    "<table><tr><th>File</th><th>Line</th><th>Column</th><th>Message</th></tr>";
+  outputStr += commandOutput.split("\n").forEach((line) => {
+    let match = line.match(/(.*):(\d+):(\d+) - (.*)/);
+    if (match) {
+      const [_, filePath, line, column, message] = match;
+      return `<tr><td>${filePath}</td><td>${line}</td><td>${column}</td><td>${message}</td></tr>`;
+    }
+  });
+  outputStr += "</table>";
 
-  // if (errorMessages) {
-  //   setFailed(errorMessages.trim());
-  //   return { output: commentBody.trim(), error: true };
-  // } else {
-  //   return { output: commentBody.trim(), error: false };
-  // }
+  return await buildComment(response, outputStr, command.label);
 };
-
-// function parseXmlToJson(xml: string) {
-//   const json: { [key: string]: any } = {};
-//   for (const res of xml.matchAll(
-//     /(?:<(\w*)(?:\s[^>]*)*>)((?:(?!<\1).)*)(?:<\/\1>)|<(\w*)(?:\s*)*\/>/gm,
-//   )) {
-//     const key = res[1] || res[3];
-//     const value = res[2] && parseXmlToJson(res[2]);
-//     json[key] = (value && Object.keys(value).length ? value : res[2]) || null;
-//   }
-//   return json;
-// }