updated check to avoid _ in shape syntax. updated readme path

mermaid-js · Sep 24, 2024 · 1c8c953 · 1c8c953
1 parent b3dfc60
commit 1c8c953
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/docs/adding-new-shape/Readme.md → docs/adding-new-shape.md b/docs/adding-new-shape/Readme.md → docs/adding-new-shape.md
@@ -2,7 +2,7 @@
 >
 > ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
 >
-> ## Please edit the corresponding file in [/packages/mermaid/src/docs/adding-new-shape/Readme.md](../../packages/mermaid/src/docs/adding-new-shape/Readme.md).
+> ## Please edit the corresponding file in [/packages/mermaid/src/docs/adding-new-shape.md](../packages/mermaid/src/docs/adding-new-shape.md).
 
 # Custom SVG Shapes Library
 
@@ -126,7 +126,9 @@ To add a new shape:
 
   const shapes = {
     ...,
-    myNewShape,
+    'my-new-shape': myNewShape,
+    // Shortened alias (if any).
+    'm-nsh': myNewShape
   };
   ```
 

diff --git a/packages/mermaid/src/diagrams/flowchart/flowDb.ts b/packages/mermaid/src/diagrams/flowchart/flowDb.ts
@@ -133,7 +133,7 @@ export const addVertex = function (
     }
     // console.log('yamlData', yamlData);
     const doc = yaml.load(yamlData, { schema: yaml.JSON_SCHEMA }) as NodeMetaData;
-    if (doc.shape && doc.shape !== doc.shape.toLowerCase()) {
+    if (doc.shape && (doc.shape !== doc.shape.toLowerCase() || doc.shape.includes('_'))) {
       throw new Error(`No such shape: ${doc.shape}. Shape names should be lowercase.`);
     }
 

diff --git a/...rmaid/src/docs/adding-new-shape/Readme.md → ...ages/mermaid/src/docs/adding-new-shape.md b/...rmaid/src/docs/adding-new-shape/Readme.md → ...ages/mermaid/src/docs/adding-new-shape.md
@@ -120,7 +120,9 @@ To add a new shape:
 
   const shapes = {
     ...,
-    myNewShape,
+    'my-new-shape': myNewShape,
+    // Shortened alias (if any).
+    'm-nsh': myNewShape
   };
   ```