build: fold update-known-events into generate-types script

Author: G-Rath

README.md

@@ -17,7 +17,6 @@
     "lint:fix": "prettier --write 'src/**/*.{ts,json}' 'scripts/**/*' 'test/**/*' README.md package.json",
     "pretest": "npm run -s lint",
     "test": "jest --coverage",
-    "update-known-events": "node scripts/update-known-events.js",
     "validate:ts": "tsc --noEmit --noImplicitAny --target es2020 --esModuleInterop --moduleResolution node test/typescript-validate.ts"
   },
   "prettier": {},
@@ -61,10 +60,8 @@
     "axios": "^0.21.0",
     "get-port": "^5.0.0",
     "jest": "^26.2.2",
-    "pascal-case": "^3.0.0",
     "prettier": "^2.0.1",
     "semantic-release": "^17.0.0",
-    "table-builder": "^2.1.1",
     "ts-jest": "^26.2.0",
     "ts-node": "^9.1.1",
     "typescript": "^4.0.2"

package-lock.json

@@ -113,6 +113,64 @@ const generateTypeScriptFile = (name: string, contents: string[]) => {
   );
 };
 
+const asCode = (str: string): string => `\`${str}\``;
+const asLink = (event: string): string => {
+  const link = `https://developer.github.com/v3/activity/events/types/#${event.replace(
+    /[^a-z]/g,
+    ""
+  )}event`;
+
+  return `[${asCode(event)}](${link})`;
+};
+
+const updateReadme = (properties: string[]) => {
+  const headers = "| Event | Actions |";
+
+  const events = properties
+    .filter((property) => property !== "*" && property !== "error")
+    .reduce<Record<string, string[]>>((events, property) => {
+      console.log(property);
+      const [event, action] = property.split(".");
+
+      events[event] ||= [];
+
+      if (action) {
+        events[event].push(action);
+      }
+
+      return events;
+    }, {});
+
+  const rows = Object.entries(events).map(
+    ([event, actions]) =>
+      `| ${asLink(event)} | ${actions.map(asCode).join("<br>")} |`
+  );
+
+  const table = format([headers, "| --- | --- |", ...rows].join("\n"), {
+    parser: "markdown",
+  });
+
+  const readme = fs.readFileSync("README.md", "utf-8");
+
+  const TableStartString =
+    "<!-- autogenerated via scripts/generate-types.ts -->";
+  const TableEndString =
+    "<!-- /autogenerated via scripts/generate-types.ts -->";
+  const tableStartIndex = readme.indexOf(TableStartString);
+  const tableEndIndex = readme.indexOf(TableEndString);
+
+  assert.ok(tableStartIndex !== -1, "cannot find start of table");
+  assert.ok(tableEndIndex !== -1, "cannot find end of table");
+
+  fs.writeFileSync(
+    "README.md",
+    `${readme.slice(
+      0,
+      tableStartIndex + TableStartString.length
+    )}\n\n${table}\n${readme.slice(tableEndIndex)}`
+  );
+};
+
 const run = () => {
   const [imports, properties] = getImportsAndProperties();
 
@@ -140,6 +198,8 @@ const run = () => {
     ...properties.map(([key]) => `"${key}",`),
     "];",
   ]);
+
+  updateReadme(properties.map(([key]) => key));
 };
 
 run();