From 072c24c358c5dbb1c7a9d88011f57a8864784da3 Mon Sep 17 00:00:00 2001
From: FoxxMD <FoxxMD@users.noreply.github.com>
Date: Thu, 28 Mar 2024 11:17:20 -0400
Subject: [PATCH] docs: Use BASE_TD_URL env to replace typedoc base url in
 generated typedocs

Useful for local development when using links from README
---
 package.json       |  1 +
 typedoc.config.cjs | 24 ++++++++++++++++++------
 2 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/package.json b/package.json
index 733198d..776e8d5 100644
--- a/package.json
+++ b/package.json
@@ -6,6 +6,7 @@
   "description": "A typed, opinionated, batteries-included, Pino-based logging solution for backend TS/JS projects",
   "scripts": {
     "typedoc": "typedoc --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-replace-text --plugin typedoc-plugin-inline-sources --media ./assets",
+    "typedoc:watch": "typedoc --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-replace-text --plugin typedoc-plugin-inline-sources --media ./assets --watch",
     "build": "tsc",
     "prepare": "tshy",
     "test": "mocha --reporter spec --recursive ./tests/*.test.ts",
diff --git a/typedoc.config.cjs b/typedoc.config.cjs
index 4bf1404..f4a283e 100644
--- a/typedoc.config.cjs
+++ b/typedoc.config.cjs
@@ -1,3 +1,20 @@
+const replacements = [
+    {
+        pattern: "\/assets\/",
+        replace: "media://"
+    }
+];
+const baseUrl = process.env.BASE_TD_URL;
+if(baseUrl !== undefined && baseUrl.trim() !== '') {
+    const cleaned = baseUrl.replace(/^["']/, '').replace(/["']$/, '');
+    replacements.push(
+        {
+            pattern: "https:\/\/foxxmd.github.io\/logging",
+            replace: cleaned
+        }
+    );
+}
+
 /** @type { import('typedoc').TypeDocOptionMap & import('typedoc-plugin-replace-text').Config } */
 module.exports ={
     name: "@foxxmd/logging Docs",
@@ -16,11 +33,6 @@ module.exports ={
     },
     replaceText: {
         inIncludedFiles: true,
-        replacements: [
-            {
-                pattern: "\/assets\/",
-                replace: "media://"
-            }
-        ]
+        replacements
     }
 }
-- 
2.51.2