diff --git a/cypress/integration/rendering/sankey.spec.js b/cypress/integration/rendering/sankey.spec.js index 435ef8184..0a065e46c 100644 --- a/cypress/integration/rendering/sankey.spec.js +++ b/cypress/integration/rendering/sankey.spec.js @@ -1,10 +1,10 @@ import { imgSnapshotTest, renderGraph } from '../../helpers/util.js'; describe('Sankey Diagram', () => { - it('should render a simple sankey diagram', () => { + it('should render a simple example', () => { imgSnapshotTest( ` - sankey + sankey-beta a,b,10 `, diff --git a/demos/sankey.html b/demos/sankey.html index e597c408f..8429218b5 100644 --- a/demos/sankey.html +++ b/demos/sankey.html @@ -17,7 +17,7 @@

Sankey diagram demos

Energy flow

-      sankey
+      sankey-beta
       
       Agricultural 'waste',Bio-conversion,124.729
       Bio-conversion,Liquid,0.597
diff --git a/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.jison b/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.jison
index c981267a0..181953d95 100644
--- a/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.jison
+++ b/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.jison
@@ -24,7 +24,7 @@ NUM \d+(.\d+)?
 //--------------
 
 (<>|[\n;])+                            { return 'EOS'; } // end of statement is semicolon ; new line \n or end of file
-"sankey"                                    { return 'SANKEY'; }
+"sankey-beta"                               { return 'SANKEY'; }
 {TOKEN}                            { return 'NODE_ID'; }
 {NUM}                           { return 'AMOUNT'; }
 "->"                                        {
diff --git a/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.spec.js b/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.spec.js
index a85a8d5c0..a6efe62c1 100644
--- a/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.spec.js
+++ b/packages/mermaid/src/diagrams/sankey/parser/sankey-arrow.spec.js
@@ -3,7 +3,7 @@ import { parser } from './sankey-arrow.jison';
 import db from '../sankeyDB.js';
 // import { fail } from 'assert';
 
-describe('Sankey diagram', function () {
+describe('sankey-beta diagram', function () {
   // TODO - these examples should be put into ./parser/stateDiagram.spec.js
   describe('when parsing an info graph it', function () {
     beforeEach(function () {
@@ -13,14 +13,14 @@ describe('Sankey diagram', function () {
     });
 
     it('recognizes its type', () => {
-      const str = `sankey`;
+      const str = `sankey-beta`;
 
       parser.parse(str);
     });
 
     it('recognizes one flow', () => {
       const str = `
-      sankey
+      sankey-beta
       node_a -> 30 -> node_b -> 20 -> node_c
       `;
 
@@ -29,7 +29,7 @@ describe('Sankey diagram', function () {
 
     it('recognizes multiple flows', () => {
       const str = `
-      sankey
+      sankey-beta
       node_a -> 30 -> node_b -> 12 -> node_e
       node_c -> 30 -> node_d -> 12 -> node_e
       node_c -> 40 -> node_e -> 12 -> node_q
@@ -40,7 +40,7 @@ describe('Sankey diagram', function () {
 
     it('parses node as a string', () => {
       const str = `
-      sankey
+      sankey-beta
       "node a" -> 30 -> "node b" -> 12 -> "node e"
       "node c" -> 30 -> "node d" -> 12 -> "node e"
       "node c" -> 40 -> "node e" -> 12 -> "node q"
@@ -52,7 +52,7 @@ describe('Sankey diagram', function () {
     describe('while attributes parsing', () => {
       it('recognized node and attribute ids starting with numbers', () => {
         const str = `
-        sankey
+        sankey-beta
         1st -> 200 -> 2nd -> 180 -> 3rd;
         `;
 
@@ -61,7 +61,7 @@ describe('Sankey diagram', function () {
 
       it('parses different quotless variations', () => {
         const str = `
-        sankey
+        sankey-beta
         node[]
         
         node[attr=1]
@@ -77,9 +77,9 @@ describe('Sankey diagram', function () {
 
       it('parses strings as values', () => {
         const str = `
-        sankey
+        sankey-beta
         node[title="hello, how are you?"]
-        node[title="hello, mister \\"sankey\\", backslash for you \\\\"]
+        node[title="hello, mister \\"sankey-beta\\", backslash for you \\\\"]
         `;
 
         parser.parse(str);
@@ -87,7 +87,7 @@ describe('Sankey diagram', function () {
 
       it('parses real example', () => {
         const str = `
-        sankey
+        sankey-beta
 
         "Agricultural 'waste'"      ->      124.729  -> "Bio-conversion"
         "Bio-conversion"            ->      0.597    -> "Liquid"
diff --git a/packages/mermaid/src/diagrams/sankey/parser/sankey.jison b/packages/mermaid/src/diagrams/sankey/parser/sankey.jison
index de5b47709..b0d994eb3 100644
--- a/packages/mermaid/src/diagrams/sankey/parser/sankey.jison
+++ b/packages/mermaid/src/diagrams/sankey/parser/sankey.jison
@@ -27,7 +27,7 @@ TEXTDATA [\u0020-\u0021\u0023-\u002B\u002D-\u007E]
 
 %%
 
-"sankey"                              { this.pushState('csv'); return 'SANKEY'; }
+"sankey-beta"                         { this.pushState('csv'); return 'SANKEY'; }
 <>                           { return 'EOF' } // match end of file
 ({CRLF}|{LF})                     { return 'NEWLINE' }
 {COMMA}                           { return 'COMMA' }
diff --git a/packages/mermaid/src/diagrams/sankey/parser/sankey.spec.ts b/packages/mermaid/src/diagrams/sankey/parser/sankey.spec.ts
index 10a187622..1df607b63 100644
--- a/packages/mermaid/src/diagrams/sankey/parser/sankey.spec.ts
+++ b/packages/mermaid/src/diagrams/sankey/parser/sankey.spec.ts
@@ -19,7 +19,7 @@ describe('Sankey diagram', function () {
       const path = await import('path');
       const csv = path.resolve(__dirname, './energy.csv');
       const data = fs.readFileSync(csv, 'utf8');
-      const graphDefinition = prepareTextForParsing(cleanupComments('sankey\n\n ' + data));
+      const graphDefinition = prepareTextForParsing(cleanupComments('sankey-beta\n\n ' + data));
 
       parser.parse(graphDefinition);
     });
diff --git a/packages/mermaid/src/diagrams/sankey/sankeyDetector.ts b/packages/mermaid/src/diagrams/sankey/sankeyDetector.ts
index 6c0bcdae8..1045d7021 100644
--- a/packages/mermaid/src/diagrams/sankey/sankeyDetector.ts
+++ b/packages/mermaid/src/diagrams/sankey/sankeyDetector.ts
@@ -3,7 +3,7 @@ import type { DiagramDetector, ExternalDiagramDefinition } from '../../diagram-a
 const id = 'sankey';
 
 const detector: DiagramDetector = (txt) => {
-  return txt.match(/^\s*sankey/) !== null;
+  return txt.match(/^\s*sankey-beta/) !== null;
 };
 
 const loader = async () => {