From 51d13e32c5de7cb59d615d610c1332d7b3da64fb Mon Sep 17 00:00:00 2001
From: Daniel Bate <djbate23@gmail.com>
Date: Wed, 26 Jul 2023 21:51:25 +0100
Subject: [PATCH] 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 |  2 ++
 apps/docs/package.json                 |  2 +-
 apps/docs/scripts/typedoc-postbuild.ts | 17 +++++++++++++++++
 3 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 .changeset/perfect-elephants-scream.md
 create mode 100644 apps/docs/scripts/typedoc-postbuild.ts

diff --git a/.changeset/perfect-elephants-scream.md b/.changeset/perfect-elephants-scream.md
new file mode 100644
index 0000000000..a49ba48448
--- /dev/null
+++ b/.changeset/perfect-elephants-scream.md
@@ -0,0 +1,2 @@
+---
+---
\ No newline at end of file
diff --git a/apps/docs/package.json b/apps/docs/package.json
index 9c4ac306d6..7e14de3d5e 100644
--- a/apps/docs/package.json
+++ b/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"
   },
diff --git a/apps/docs/scripts/typedoc-postbuild.ts b/apps/docs/scripts/typedoc-postbuild.ts
new file mode 100644
index 0000000000..158fda2495
--- /dev/null
+++ b/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}`);
+  });
+});