feat: Add getConfigValue

mermaid-js · Jan 30, 2024 · 8b0399e · 8b0399e
1 parent 80c20a7
commit 8b0399e
Show file tree

Hide file tree

Showing 6 changed files with 326 additions and 196 deletions.
diff --git a/docs/config/setup/modules/config.md b/docs/config/setup/modules/config.md
diff --git a/packages/mermaid/package.json b/packages/mermaid/package.json
@@ -115,7 +115,7 @@
     "remark-gfm": "^3.0.1",
     "rimraf": "^5.0.0",
     "start-server-and-test": "^2.0.0",
-    "type-fest": "^4.1.0",
+    "type-fest": "^4.10.1",
     "typedoc": "^0.25.0",
     "typedoc-plugin-markdown": "^3.15.2",
     "typescript": "^5.0.4",

diff --git a/packages/mermaid/src/config.ts b/packages/mermaid/src/config.ts
@@ -4,7 +4,8 @@ import theme from './themes/index.js';
 import config from './defaultConfig.js';
 import type { MermaidConfig } from './config.type.js';
 import { sanitizeDirective } from './utils/sanitizeDirective.js';
-import type { RequiredDeep } from 'type-fest';
+import lodashGet from 'lodash-es/get.js';
+import type { RequiredDeep, Get, Paths } from 'type-fest';
 
 export const defaultConfig: RequiredDeep<MermaidConfig> = Object.freeze(config);
 
@@ -246,3 +247,20 @@ const checkConfig = (config: MermaidConfig) => {
     issueWarning('LAZY_LOAD_DEPRECATED');
   }
 };
+
+/**
+ * Get a value from the provided config, or the default config if it doesn't exist
+ * @param config - Mermaid Config
+ * @param path - Path of the value to get
+ * @returns Value from provided config if it exists, otherwise from default config
+ */
+export const getConfigValue = <Path extends Paths<RequiredDeep<MermaidConfig>>>(
+  config: MermaidConfig,
+  path: Path
+): Get<RequiredDeep<MermaidConfig>, Path> => {
+  let value = lodashGet(config, path) as Get<RequiredDeep<MermaidConfig>, Path>;
+  if (!value) {
+    value = lodashGet(defaultConfig, path) as Get<RequiredDeep<MermaidConfig>, Path>;
+  }
+  return value;
+};
diff --git a/packages/mermaid/src/diagrams/mindmap/mindmapDb.ts b/packages/mermaid/src/diagrams/mindmap/mindmapDb.ts
@@ -3,7 +3,7 @@ import type { D3Element } from '../../mermaidAPI.js';
 import { sanitizeText } from '../../diagrams/common/common.js';
 import { log } from '../../logger.js';
 import type { MindmapNode } from './mindmapTypes.js';
-import { defaultConfig } from '../../config.js';
+import { getConfigValue } from '../../config.js';
 
 let nodes: MindmapNode[] = [];
 let cnt = 0;
@@ -32,7 +32,7 @@ const getMindmap = () => {
 const addNode = (level: number, id: string, descr: string, type: number) => {
   log.info('addNode', level, id, descr, type);
   const conf = getConfig();
-  let padding: number = conf.mindmap?.padding ?? defaultConfig.mindmap.padding;
+  let padding: number = getConfigValue(conf, 'mindmap.padding');
   switch (type) {
     case nodeType.ROUNDED_RECT:
     case nodeType.RECT:
@@ -47,7 +47,7 @@ const addNode = (level: number, id: string, descr: string, type: number) => {
     descr: sanitizeText(descr, conf),
     type,
     children: [],
-    width: conf.mindmap?.maxNodeWidth ?? defaultConfig.mindmap.maxNodeWidth,
+    width: getConfigValue(conf, 'mindmap.maxNodeWidth'),
     padding,
   } satisfies MindmapNode;
 

diff --git a/packages/mermaid/src/diagrams/mindmap/mindmapRenderer.ts b/packages/mermaid/src/diagrams/mindmap/mindmapRenderer.ts
@@ -3,15 +3,14 @@ import cytoscape from 'cytoscape';
 import coseBilkent from 'cytoscape-cose-bilkent';
 import { select } from 'd3';
 import type { MermaidConfig } from '../../config.type.js';
-import { getConfig } from '../../diagram-api/diagramAPI.js';
 import type { DrawDefinition } from '../../diagram-api/types.js';
 import { log } from '../../logger.js';
 import type { D3Element } from '../../mermaidAPI.js';
 import { selectSvgElement } from '../../rendering-util/selectSvgElement.js';
 import { setupGraphViewbox } from '../../setupGraphViewbox.js';
 import type { FilledMindMapNode, MindmapDB, MindmapNode } from './mindmapTypes.js';
 import { drawNode, positionNode } from './svgDraw.js';
-import { defaultConfig } from '../../config.js';
+import { getConfig, getConfigValue } from '../../config.js';
 
 // Inject the layout algorithm into cytoscape
 cytoscape.use(coseBilkent);
@@ -191,8 +190,8 @@ export const draw: DrawDefinition = async (text, id, _version, diagObj) => {
   setupGraphViewbox(
     undefined,
     svg,
-    conf.mindmap?.padding ?? defaultConfig.mindmap.padding,
-    conf.mindmap?.useMaxWidth ?? defaultConfig.mindmap.useMaxWidth
+    getConfigValue(conf, 'mindmap.padding'),
+    getConfigValue(conf, 'mindmap.useMaxWidth')
   );
 };