feat: add docs script to remove unwanted files (#1139)

* feat: add script to remove unwanted docs files

* chore: changeset

---------

Co-authored-by: danielbate <--global>

.changeset/perfect-elephants-scream.md

@@ -0,0 +1,2 @@
+---
+---

apps/docs/package.json

@@ -5,7 +5,7 @@
   "description": "",
   "scripts": {
     "dev": "nodemon --config nodemon.config.json -x 'typedoc && vitepress dev'",
-    "build": "typedoc && vitepress build",
+    "build": "typedoc && tsx ./scripts/typedoc-postbuild.ts && vitepress build",
     "preview": "typedoc && vitepress preview",
     "docs": "typedoc"
   },

apps/docs/scripts/typedoc-postbuild.ts

@@ -0,0 +1,17 @@
+import { unlink } from 'fs';
+import { join } from 'path';
+
+/**
+ * Post build script to trim off undesired leftovers from Typedoc.
+ */
+const docsDir = join(__dirname, '../src/');
+const filesToRemove = ['api/modules.md'];
+const { log } = console;
+
+filesToRemove.forEach((filePath) => {
+  const fullFilePath = join(docsDir, filePath);
+  unlink(fullFilePath, (err) => {
+    if (err) throw err;
+    log(`Removed ${fullFilePath}`);
+  });
+});