From bdbbd096a681ef20264b6710849905e794e55560 Mon Sep 17 00:00:00 2001
From: Jack Murray <jack.murray@trayport.com>
Date: Tue, 23 Jan 2024 12:38:29 +0000
Subject: [PATCH] rewrite patchMkdocsYmlWithPlugins to correctly only merge in
 all default plugins that are missing

Signed-off-by: Jack Murray <115712715+jackmtpt@users.noreply.github.com>
---
 .../src/stages/generate/mkdocsPatchers.ts     | 31 ++++++++++++-------
 1 file changed, 20 insertions(+), 11 deletions(-)

diff --git a/plugins/techdocs-node/src/stages/generate/mkdocsPatchers.ts b/plugins/techdocs-node/src/stages/generate/mkdocsPatchers.ts
index 945aab3884..762a1c267a 100644
--- a/plugins/techdocs-node/src/stages/generate/mkdocsPatchers.ts
+++ b/plugins/techdocs-node/src/stages/generate/mkdocsPatchers.ts
@@ -153,21 +153,30 @@ export const patchMkdocsYmlWithPlugins = async (
   defaultPlugins: string[] = ['techdocs-core'],
 ) => {
   await patchMkdocsFile(mkdocsYmlPath, logger, mkdocsYml => {
-    // Modify mkdocs.yaml to contain the required default plugins
+    // Modify mkdocs.yaml to contain the required default plugins.
+    // If no plugins are defined we can just return the defaults.
     if (!('plugins' in mkdocsYml)) {
       mkdocsYml.plugins = defaultPlugins;
       return true;
     }
 
-    if (
-      mkdocsYml.plugins &&
-      !defaultPlugins.every(plugin => mkdocsYml.plugins!.includes(plugin))
-    ) {
-      mkdocsYml.plugins = [
-        ...new Set([...mkdocsYml.plugins, ...defaultPlugins]),
-      ];
-      return true;
-    }
-    return false;
+    // Otherwise, check each default plugin and include it if necessary.
+    let changesMade = false;
+
+    defaultPlugins.forEach(dp => {
+      // if the plugin isn't there as a string, and isn't there as an object (which may itself contain extra config)
+      // then we need to add it
+      if (
+        !(
+          mkdocsYml.plugins!.includes(dp) ||
+          mkdocsYml.plugins!.some(p => p.hasOwnProperty(dp))
+        )
+      ) {
+        mkdocsYml.plugins = [...new Set([...mkdocsYml.plugins!, dp])];
+        changesMade = true;
+      }
+    });
+
+    return changesMade;
   });
 };