Rename BlockDiagram to Block

packages/mermaid/src/config.type.ts

@@ -33,7 +33,7 @@ export interface MermaidConfig {
   gitGraph?: GitGraphDiagramConfig;
   c4?: C4DiagramConfig;
   sankey?: SankeyDiagramConfig;
-  blockDiagram?: BlockDiagramConfig;
+  block?: BlockDiagramConfig;
   dompurifyConfig?: DOMPurify.Config;
   wrap?: boolean;
   fontSize?: number;

packages/mermaid/src/diagram-api/diagram-orchestration.ts

@@ -19,6 +19,7 @@ import flowchartElk from '../diagrams/flowchart/elk/detector.js';
 import timeline from '../diagrams/timeline/detector.js';
 import mindmap from '../diagrams/mindmap/detector.js';
 import sankey from '../diagrams/sankey/sankeyDetector.js';
+import block from '../diagrams/block/blockDetector.js';
 import { registerLazyLoadedDiagrams } from './detectType.js';
 import { registerDiagram } from './diagramAPI.js';
 
@@ -81,6 +82,7 @@ export const addDiagrams = () => {
     state,
     journey,
     quadrantChart,
-    sankey
+    sankey,
+    block
   );
 };

packages/mermaid/src/diagrams/block/blockDB.ts

@@ -23,7 +23,7 @@ const clear = (): void => {
 };
 
 export default {
-  getConfig: () => configApi.getConfig().blockDiagram,
+  getConfig: () => configApi.getConfig().block,
 
   getAccTitle,
   setAccTitle,

packages/mermaid/src/diagrams/block/blockDetector.ts

@@ -1,9 +1,9 @@
 import type { DiagramDetector, ExternalDiagramDefinition } from '../../diagram-api/types.js';
 
-const id = 'sankey';
+const id = 'block';
 
 const detector: DiagramDetector = (txt) => {
-  return /^\s*blockDiagram-beta/.test(txt);
+  return /^\s*block-beta/.test(txt);
 };
 
 const loader = async () => {

packages/mermaid/src/diagrams/block/blockDiagram.ts

@@ -1,9 +1,9 @@
 import { DiagramDefinition } from '../../diagram-api/types.js';
 // @ts-ignore: jison doesn't export types
-import parser from './parser/sankey.jison';
+import parser from './parser/blockDiagram.jison';
 import db from './blockDB.js';
-import renderer from './blockDiagramRenderer.js';
-import { prepareTextForParsing } from './blockDiagramUtils.js';
+import renderer from './blockRenderer.js';
+import { prepareTextForParsing } from './blockUtils.js';
 
 const originalParse = parser.parse.bind(parser);
 parser.parse = (text: string) => originalParse(prepareTextForParsing(text));

packages/mermaid/src/diagrams/block/blockTypes.ts

@@ -0,0 +1,5 @@
+import type { DiagramDB } from '../../diagram-api/types.js';
+
+export interface BlockDB extends DiagramDB {
+  clear: () => void;
+}

packages/mermaid/src/diagrams/block/parser/block.jison

@@ -27,7 +27,7 @@ CRLF \u000D\u000A
 
 %%
 
-"blockDiagram-beta"                                             { return 'BLOCK_DIAGRAM_KEY'; }
+"block-beta"                                             { return 'BLOCK_DIAGRAM_KEY'; }
 // \s*\%\%.*                                                       { yy.getLogger().info('Found comment',yytext); }
 [\s]+                                                           { yy.getLogger().info('.', yytext); /* skip all whitespace */  }
 [\n]+ {yy.getLogger().info('_', yytext);                 /* skip all whitespace */   }

packages/mermaid/src/diagrams/block/parser/block.spec.ts

@@ -1,58 +1,58 @@
 // @ts-ignore: jison doesn't export types
-import blockDiagram from './blockDiagram.jison';
+import block from './block.jison';
 import db from '../blockDB.js';
 import { cleanupComments } from '../../../diagram-api/comments.js';
-import { prepareTextForParsing } from '../blockDiagramUtils.js';
+import { prepareTextForParsing } from '../blockUtils.js';
 import * as fs from 'fs';
 import * as path from 'path';
 
 describe('Sankey diagram', function () {
   describe('when parsing an block diagram graph it should handle > ', function () {
     beforeEach(function () {
-      blockDiagram.parser.yy = db;
-      blockDiagram.parser.yy.clear();
-      blockDiagram.parser.yy.getLogger = () => console;
+      block.parser.yy = db;
+      block.parser.yy.clear();
+      block.parser.yy.getLogger = () => console;
     });
 
     it('a diagram with a node', async () => {
-      const str = `blockDiagram-beta
+      const str = `block-beta
           id
       `;
 
-      blockDiagram.parse(str);
+      block.parse(str);
     });
     it('a diagram with multiple nodes', async () => {
-      const str = `blockDiagram-beta
+      const str = `block-beta
           id1
           id2
       `;
 
-      blockDiagram.parse(str);
+      block.parse(str);
     });
     it('a node with a square shape and a label', async () => {
-      const str = `blockDiagram-beta
+      const str = `block-beta
           id["A label"]
           id2`;
 
-      blockDiagram.parse(str);
+      block.parse(str);
     });
     it('a diagram with multiple nodes with edges', async () => {
-      const str = `blockDiagram-beta
+      const str = `block-beta
           id1["first"]  -->   id2["second"]
       `;
 
-      blockDiagram.parse(str);
+      block.parse(str);
     });
     // it('a diagram with column statements', async () => {
-    //   const str = `blockDiagram-beta
+    //   const str = `block-beta
     //       columns 1
     //       block1["Block 1"]
     //   `;
 
-    //   blockDiagram.parse(str);
+    //   block.parse(str);
     // });
     // it('a diagram with block hierarchies', async () => {
-    //   const str = `blockDiagram-beta
+    //   const str = `block-beta
     //     columns 1
     //     block1[Block 1]
 
@@ -63,10 +63,10 @@ describe('Sankey diagram', function () {
     //     end %% End the compound block
     //   `;
 
-    //   blockDiagram.parse(str);
+    //   block.parse(str);
     // });
     // it('a diagram with differernt column values in different blocks', async () => {
-    //   const str = `blockDiagram-beta
+    //   const str = `block-beta
     //     columns 1
     //     block1[Block 1]
 
@@ -77,7 +77,7 @@ describe('Sankey diagram', function () {
     //     end %% End the compound block
     //   `;
 
-    //   blockDiagram.parse(str);
+    //   block.parse(str);
 
     //   // Todo check that the different blocks have different column values
     // });