Disallow leading whitespace before delimiter

mermaid-js · Nov 19, 2022 · a11ab3d · a11ab3d
1 parent 70f0247
commit a11ab3d
Show file tree

Hide file tree

Showing 13 changed files with 58 additions and 52 deletions.
diff --git a/cypress/integration/rendering/classDiagram-v2.spec.js b/cypress/integration/rendering/classDiagram-v2.spec.js
@@ -500,11 +500,11 @@ describe('Class diagram V2', () => {
   it('1433: should render a simple class with a title', () => {
     imgSnapshotTest(
       `---
-       title: simple class diagram
-       ---
-       classDiagram-v2
-       class Class10
-      `,
+title: simple class diagram
+---
+classDiagram-v2
+class Class10
+`,
       {}
     );
   });

diff --git a/cypress/integration/rendering/erDiagram.spec.js b/cypress/integration/rendering/erDiagram.spec.js
@@ -277,12 +277,12 @@ describe('Entity Relationship Diagram', () => {
   it('1433: should render a simple ER diagram with a title', () => {
     imgSnapshotTest(
       `---
-       title: simple ER diagram
-       ---
-       erDiagram
-       CUSTOMER ||--o{ ORDER : places
-       ORDER ||--|{ LINE-ITEM : contains
-      `,
+title: simple ER diagram
+---
+erDiagram
+CUSTOMER ||--o{ ORDER : places
+ORDER ||--|{ LINE-ITEM : contains
+`,
       {}
     );
   });

diff --git a/cypress/integration/rendering/flowchart-v2.spec.js b/cypress/integration/rendering/flowchart-v2.spec.js
@@ -666,11 +666,11 @@ flowchart RL
   it('1433: should render a titled flowchart with titleTopMargin set to 0', () => {
     imgSnapshotTest(
       `---
-      title: Simple flowchart
-      ---
-      flowchart TD
-      A --> B
-      `,
+title: Simple flowchart
+---
+flowchart TD
+A --> B
+`,
       { titleTopMargin: 0 }
     );
   });

diff --git a/cypress/integration/rendering/gitGraph.spec.js b/cypress/integration/rendering/gitGraph.spec.js
@@ -325,11 +325,11 @@ describe('Git Graph diagram', () => {
   it('1433: should render a simple gitgraph with a title', () => {
     imgSnapshotTest(
       `---
-      title: simple gitGraph
-      ---
-      gitGraph
-       commit
-      `,
+title: simple gitGraph
+---
+gitGraph
+  commit
+`,
       {}
     );
   });

diff --git a/cypress/integration/rendering/stateDiagram-v2.spec.js b/cypress/integration/rendering/stateDiagram-v2.spec.js
@@ -562,12 +562,12 @@ stateDiagram-v2
   it('1433: should render a simple state diagram with a title', () => {
     imgSnapshotTest(
       `---
-       title: simple state diagram
-       ---
-       stateDiagram-v2
-       [*] --> State1
-       State1 --> [*]
-      `,
+title: simple state diagram
+---
+stateDiagram-v2
+[*] --> State1
+State1 --> [*]
+`,
       {}
     );
   });

diff --git a/demos/classchart.html b/demos/classchart.html
@@ -17,9 +17,9 @@
     <h1>Class diagram demos</h1>
 
     <pre class="mermaid">
-    ---
-    title: Demo Class Diagram
-    ---
+---
+title: Demo Class Diagram
+---
 		classDiagram
       accTitle: Demo Class Diagram
       accDescr: This class diagram show the abstract Animal class, and 3 classes that inherit from it: Duck, Fish, and Zebra.

diff --git a/demos/flowchart.html b/demos/flowchart.html
@@ -17,9 +17,9 @@ <h1>Comparison "graph vs. flowchart"</h1>
     <h2>Sample 1</h2>
     <h3>graph</h3>
     <pre class="mermaid">
-    ---
-    title: This is a complicated flow
-    ---
+---
+title: This is a complicated flow
+---
     graph LR
       accTitle: This is a complicated flow
       accDescr: This is the descriptoin for the complicated flow.
@@ -224,9 +224,9 @@ <h3>flowchart</h3>
     <h2>Sample 2</h2>
     <h3>graph</h3>
     <pre class="mermaid">
-    ---
-    title: What to buy
-    ---
+---
+title: What to buy
+---
     graph TD
       accTitle: What to buy
       accDescr: Options of what to buy with Christmas money

diff --git a/demos/git.html b/demos/git.html
@@ -16,9 +16,9 @@
   <body>
     <h1>Git diagram demo</h1>
     <pre class="mermaid">
-    ---
-    title: Simple Git diagram
-    ---
+---
+title: Simple Git diagram
+---
     gitGraph:
     options
     {

diff --git a/demos/journey.html b/demos/journey.html
@@ -16,9 +16,9 @@
   <body>
     <h1>Journey diagram demo</h1>
     <pre class="mermaid">
-     ---
-     title: My working day 
-     ---
+---
+title: My working day 
+---
      journey
       accTitle: Very simple journey demo
       accDescr: 2 main sections: work and home, each with just a few tasks

diff --git a/demos/state.html b/demos/state.html
@@ -17,9 +17,9 @@
     <h1>State diagram demos</h1>
     <h2>Very simple showing change from State1 to State2</h2>
     <pre class="mermaid">
-    ---
-    title: Very simple diagram
-    ---
+---
+title: Very simple diagram
+---
 		stateDiagram
 		  accTitle: This is the accessible title
       accDescr:This is an accessible description
@@ -46,9 +46,9 @@ <h4>And these are how they are applied:</h4>
       </code>
     </p>
     <pre class="mermaid">
-    ---
-    title: Very simple diagram
-    ---
+---
+title: Very simple diagram
+---
 		stateDiagram-v2
 		  accTitle: This is the accessible title
       accDescr: This is an accessible description

diff --git a/packages/mermaid/src/diagram-api/frontmatter.spec.ts b/packages/mermaid/src/diagram-api/frontmatter.spec.ts
@@ -41,6 +41,13 @@ describe('extractFrontmatter', () => {
     expect(db.setDiagramTitle).toHaveBeenCalledWith('foo---bar');
   });
 
+  it('handles frontmatter with multi-line string and multiple delimiters', () => {
+    const db = dbMock();
+    const text = `---\ntitle: |\n   multi-line string\n   ---\n---\ndiagram`;
+    expect(extractFrontMatter(text, db)).toEqual('diagram');
+    expect(db.setDiagramTitle).toHaveBeenCalledWith('multi-line string\n---\n');
+  });
+
   it('handles frontmatter with title', () => {
     const db = dbMock();
     const text = `---\ntitle: foo\n---\ndiagram`;

diff --git a/packages/mermaid/src/diagram-api/frontmatter.ts b/packages/mermaid/src/diagram-api/frontmatter.ts
@@ -6,7 +6,7 @@ import * as yaml from 'js-yaml';
 // Note that JS doesn't support the "\A" anchor, which means we can't use
 // multiline mode.
 // Relevant YAML spec: https://yaml.org/spec/1.2.2/#914-explicit-documents
-export const frontMatterRegex = /^(?:\s*---\s*[\r\n])(.*?)(?:[\r\n]\s*---\s*[\r\n]+)/s;
+export const frontMatterRegex = /^(?:---\s*[\r\n])(.*?)(?:[\r\n]---\s*[\r\n]+)/s;
 
 type FrontMatterMetadata = {
   title?: string;

diff --git a/packages/mermaid/src/utils.spec.js b/packages/mermaid/src/utils.spec.js
@@ -238,10 +238,9 @@ Alice->Bob: hi`;
     const type = detectType(str);
     expect(type).toBe('gitGraph');
   });
-  it('should handle frontmatter with leading spaces', function () {
+  it('should not allow frontmatter with leading spaces', function () {
     const str = '    ---\ntitle: foo\n---\n  gitGraph TB:\nbfs1:queue';
-    const type = detectType(str);
-    expect(type).toBe('gitGraph');
+    expect(() => detectType(str)).toThrow('No diagram type detected for text');
   });
 });
 describe('when finding substring in array ', function () {