Compare commits

..

128 Commits

Author SHA1 Message Date
renovate[bot]
0f6db8cd5d fix(deps): update dependency dompurify to ^3.2.7 2025-10-13 13:30:03 +00:00
Shubham P
18f51eb14e Merge pull request #6843 from saurabhg772244/saurabh/fix-edge-animation-for-hand-dranw-shapes
Fixed edge animation for hand drawn shapes
2025-10-13 13:14:24 +00:00
Shubham P
2bb57bf7d2 Merge pull request #6989 from mermaid-js/subgraph-td-direction
6338: allow direction TD inside subgraphs
2025-10-13 13:13:46 +00:00
Shubham P
a6276daffd Merge pull request #7055 from mermaid-js/sequence-diagram-participant-name-parsing
6853:  prevent browser freeze caused by invalid participant name in sequenceDiagram
2025-10-13 13:12:08 +00:00
Justin Greywolf
d80a638e55 Merge pull request #6023 from yari-dewalt/fix_lollipop_stroke
Fix: Delete 'stroke: black' from lollipop marker so it matches themes and edge paths
2025-10-11 20:43:08 +00:00
Justin Greywolf
7a869c08a2 Merge pull request #6026 from yari-dewalt/bug/5669_class-diagram-fix-namespace-themes
Fix: Class diagram namespaces black lines, not responding to theme variables
2025-10-11 20:42:53 +00:00
Justin Greywolf
44e8cbb1de Merge branch 'develop' into bug/5669_class-diagram-fix-namespace-themes 2025-10-11 13:27:47 -07:00
Justin Greywolf
efe38b8425 Merge branch 'develop' into fix_lollipop_stroke 2025-10-11 13:26:59 -07:00
darshanr0107
6fecb985e8 fix: failing argos
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-10-09 11:50:44 +05:30
darshanr0107
69b338d8af fix: formatting issues
Co-authored-by: omkarht <omkar@mermaidchart.com>
2025-10-09 11:37:05 +05:30
darshanr0107
fa15ce8502 chore: added changeset
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-10-08 13:23:28 +05:30
darshanr0107
6d0650918f fix: handle participant names with spaces correctly in sequenceDiagram
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-10-08 13:09:30 +05:30
Shubham P
c728d864c8 Merge pull request #7054 from mermaid-js/fix/update-argos-ci-version
fix: update @argos-ci/cypress to version 6.1.3
2025-10-07 08:34:58 +00:00
shubhamparikh2704
99f17bea3a fix: update @argos-ci/cypress to version 6.1.3 2025-10-07 13:39:28 +05:30
Ashish Jain
c1c14e401a Merge pull request #7019 from mermaid-js/tmp-mindmap-elk
mindmap breaking issue in ELK layout
2025-09-30 09:02:40 +00:00
darshanr0107
8b3057f27c fix: guard nodeDb[node.id] against undefined
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-30 12:27:53 +05:30
Shubham P
717d3b3bb2 Merge pull request #6984 from mermaid-js/fix/er-diagram-syntax-error-special-chars
fix(er-diagram): handle syntax errors for special characters in node names
2025-09-29 08:37:03 +00:00
Shubham P
2f8d9ba958 Merge pull request #6789 from mermaid-js/6638-sequence-diagram-additional-messages
6638:sequence diagram additional messages
2025-09-29 08:08:33 +00:00
darshanr0107
ace0367afd chore: add changeset
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-29 13:37:10 +05:30
Knut Sveidqvist
b983626587 Fix for reference issue affecting mindmaps 2025-09-26 15:24:20 +02:00
Shubham P
7effdc147b Merge pull request #6997 from mermaid-js/ci/enable-codeql-for-github-actions
ci(codeql): enable CodeQL for GitHub Actions
2025-09-25 08:47:48 +00:00
Alois Klink
6e67515f41 ci(codeql): enable CodeQL for GitHub Actions
Support for scanning GitHub Actions was added in 2024-12-17, see
https://github.blog/changelog/2024-12-17-find-and-fix-actions-workflows-vulnerabilities-with-codeql-public-preview/
2025-09-25 17:17:12 +09:00
darshanr0107
1a9d45abf0 fix: allow direction TD inside subgraphs
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-24 12:22:31 +05:30
omkarht
09b74f1c29 chore: added changeset
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-23 13:39:45 +05:30
omkarht
880da21908 test: add tests for handling special characters and numeric entity names
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-23 13:29:19 +05:30
omkarht
38191243be Merge branch 'develop' into fix/er-diagram-syntax-error-special-chars 2025-09-23 12:41:42 +05:30
omkarht
b75dcb8a82 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-23 12:40:39 +05:30
omkarht
4c1e170f4a fix(er-diagram): handle syntax errors for special characters in node names 2025-09-23 12:39:29 +05:30
Shubham P
d5c4eff251 Merge pull request #6972 from mermaid-js/renovate/patch-all-patch
fix(deps): update all patch dependencies (patch)
2025-09-22 13:49:30 +00:00
renovate[bot]
5324fd8dfd fix(deps): update all patch dependencies 2025-09-22 13:35:45 +00:00
omkarht
bd25b88a01 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-22 13:36:01 +05:30
Sidharth Vinod
37e3a6951b Merge pull request #6956 from mermaid-js/develop
Pre Release
2025-09-17 23:15:32 +05:30
Sidharth Vinod
0de0b063e4 Merge pull request #6958 from dijitali/fix/arch-icon-docs
fix(docs) correct phrasing for architecture icon installation
2025-09-17 23:06:48 +05:30
Shubham P
619515e5a9 Merge pull request #6925 from mermaid-js/renovate/patch-all-patch
fix(deps): update all patch dependencies (patch)
2025-09-17 14:16:47 +00:00
shubhamparikh2704
59c8b07509 Merge branch 'develop' of https://github.com/mermaid-js/mermaid into renovate/patch-all-patch 2025-09-17 19:34:56 +05:30
Sidharth Vinod
9e72bbf62d Merge pull request #6955 from mermaid-js/sidv/updateArgos
chore: Update argos to 6.1.0
2025-09-17 18:48:40 +05:30
Sidharth Vinod
2a2c46f1e2 chore: Update argos to 6.1.1 2025-09-17 18:14:03 +05:30
Shubham P
f25df353d4 Merge pull request #6959 from mermaid-js/remove-changeset
chore: remove duplicate changeset file
2025-09-17 10:50:09 +00:00
shubhamparikh2704
398345a8bc chore: remove duplicate changeset file 2025-09-17 16:07:45 +05:30
autofix-ci[bot]
7fd2d94ef7 [autofix.ci] apply automated fixes 2025-09-17 08:47:15 +00:00
Ieuan Jenkins
bcc1472b9d fix(docs) correct phrasing for architecture icon installation
docs gave the incorrect impression that iconify.design icons came preinstalled
2025-09-17 09:21:42 +01:00
shubhamparikh2704
ddc1cfe6c8 Revert "fix: downgrade @argos-ci/cypress to version 5.0.2"
This reverts commit 18e9c1174d.
2025-09-17 13:07:43 +05:30
omkarht
d3de3ecbbb Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-17 12:41:51 +05:30
shubhamparikh2704
18e9c1174d fix: downgrade @argos-ci/cypress to version 5.0.2 2025-09-17 12:14:29 +05:30
Sidharth Vinod
789018abf6 chore: Update argos to 6.1.0 2025-09-17 11:38:57 +05:30
Shubham P
16569b295b Merge pull request #6942 from mermaid-js/renovate/peter-evans-create-pull-request-digest
chore(deps): update peter-evans/create-pull-request digest to 915d841
2025-09-16 17:28:34 +00:00
renovate[bot]
11a35c11ee chore(deps): update peter-evans/create-pull-request digest to 915d841 2025-09-16 16:02:14 +00:00
Shubham P
216be22801 Merge pull request #6945 from mermaid-js/fix/gantt-crash-obsidian-browser
6920: Fix Gantt chart crashes in Obsidian and browser
2025-09-16 15:49:49 +00:00
Ashish Jain
e87f77a865 Merge pull request #6950 from mermaid-js/patch/mindmap-fix
Pre Release
2025-09-16 12:48:55 +02:00
shubhamparikh2704
a9579083bf chore: add changeset for fixing mindmap rendering and applying tidytree layout 2025-09-16 13:33:31 +05:30
Knut Sveidqvist
6fd78d0856 Merge pull request #6944 from mermaid-js/docs/fix-mindmap-rendering
6932:Fix mindmap rendering in docs and apply tidytree layout
2025-09-16 13:27:23 +05:30
Sidharth Vinod
994f7df29a Merge pull request #6949 from tklever/examples-license
docs: add MIT license to `examples` metadata
2025-09-16 12:40:40 +05:30
Sidharth Vinod
531f5e9380 Merge pull request #6948 from mermaid-js/add-newest-blog-posts
DOCS: add newest blog posts
2025-09-16 11:45:06 +05:30
Tim Klever
dc11b8645c docs: add MIT license to examples metadata
Adding the MIT license documentation so the published package metadata accurately reflects the license. The MIT license is currently included in the package distribution https://www.npmjs.com/package/@mermaid-js/examples?activeTab=code, but not documented in the metadata. This causes npmjs.com to display the license as "none"
2025-09-15 17:35:44 -07:00
Steph
ad4c227477 add newest blog posts 2025-09-15 13:24:39 -07:00
omkarht
3964ce0a0f Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-15 18:15:59 +05:30
Shubham P
181af8167b Merge pull request #6934 from fulldecent/patch-2
Specify score range for task syntax
2025-09-15 09:18:39 +00:00
Shubham P
799d2ed547 Merge branch 'develop' into patch-2 2025-09-15 14:38:57 +05:30
shubhamparikh2704
a44e3e992c refactor: remove unused dependencies from pnpm-lock.yaml 2025-09-15 14:37:50 +05:30
shubhamparikh2704
ca5b370ffb Merge branch 'develop' of https://github.com/mermaid-js/mermaid into renovate/patch-all-patch 2025-09-15 14:32:02 +05:30
Shubham P
08160a74b4 Merge pull request #6931 from mermaid-js/renovate/npm-vite-vulnerability
chore(deps): update dependency vite to v7.0.7 [security]
2025-09-15 08:22:27 +00:00
Knut Sveidqvist
6d221fb3ca Merge pull request #6944 from mermaid-js/docs/fix-mindmap-rendering
6932:Fix mindmap rendering in docs and apply tidytree layout
2025-09-15 08:06:41 +00:00
Shubham P
8b20907141 Merge branch 'develop' into renovate/npm-vite-vulnerability 2025-09-15 13:13:40 +05:30
omkarht
4dbabba8e8 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-15 12:50:11 +05:30
darshanr0107
d318f1a13c chore: add changeset
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-15 12:42:25 +05:30
darshanr0107
525a7de8ae fix:gant chart crashing in browser
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-15 12:42:24 +05:30
darshanr0107
a459c436c9 docs: fix rendering and ensure tidytree layout is applied
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-15 12:00:46 +05:30
Saurabh Gore
bbb93b263d Merge branch 'develop' into saurabh/fix-edge-animation-for-hand-dranw-shapes 2025-09-13 11:37:21 +05:30
Sidharth Vinod
1c2a0020bd Merge pull request #6939 from aloisklink/build/fix-netlify-mermaid-live-preview
build: change mermaid live preview to use pnpm
2025-09-12 21:18:29 +05:30
Alois Klink
141c6b3808 build: change mermaid live preview to use pnpm
Right now, the netlify build seems to be failing since we're ignoring
the `mermaid-live-editor` lockfile.

This is causing errors with broken dependencies.

Switching to `pnpm`, which the `mermaid-live-editor` uses, fixes these
issues!
2025-09-13 00:35:29 +09:00
renovate[bot]
8d4ffdf808 chore(deps): update dependency vite to v7.0.7 [security] 2025-09-12 20:14:12 +09:00
Alois Klink
32106e259c build(docs): set build.target = 'modules'
Explicility set the `build.target` to `modules`, as Vite v7 changes this
and drops support for older browsers.

We probably should do this eventually too, but maybe as part of a
Mermaid v12 release.
2025-09-12 20:14:12 +09:00
Sidharth Vinod
450754221e Merge pull request #6930 from mermaid-js/rajat-ht/chore-editor-selection-update
Chore: Simplify editor selection to single version
2025-09-11 19:57:08 +05:30
rajat-ht
7a4f5b62c9 chore: update variable name 2025-09-11 19:54:14 +05:30
omkarht
e3ef5e4208 fix: fixed central connection for bidirectional dotted arrow
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-09-11 13:03:06 +05:30
omkarht
daeb85bac2 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-11 12:40:55 +05:30
saurabhg772244
4240340a18 Merge branch 'develop' of github.com:mermaid-js/mermaid into saurabh/fix-edge-animation-for-hand-dranw-shapes 2025-09-11 11:36:26 +05:30
autofix-ci[bot]
47c0d2d040 [autofix.ci] apply automated fixes 2025-09-10 18:00:00 +00:00
William Entriken
ac3b777bf6 Specify score range for task syntax 2025-09-10 13:54:31 -04:00
Shubham P
cf08ba0ef8 Merge branch 'develop' into renovate/patch-all-patch 2025-09-10 21:03:45 +05:30
rajat-ht
4829dfa8c5 Chore: Simplify editor selection to single version 2025-09-09 22:16:52 +05:30
autofix-ci[bot]
e7811886c3 [autofix.ci] apply automated fixes 2025-09-08 01:00:25 +00:00
renovate[bot]
32eda8565c fix(deps): update all patch dependencies 2025-09-08 00:54:41 +00:00
omkarht
ca10a259fa Merge branch 'develop' into saurabh/fix-edge-animation-for-hand-dranw-shapes 2025-09-05 16:28:39 +05:30
Saurabh Gore
0ed9c65572 Merge branch 'develop' into saurabh/fix-edge-animation-for-hand-dranw-shapes 2025-09-05 12:56:27 +05:30
saurabhg772244
56cc12690f Added option to skip screenshot for cypress tests 2025-09-05 12:47:07 +05:30
omkarht
2cdaf03ada Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-05 12:12:01 +05:30
Sidharth Vinod
9c85521e16 Merge pull request #6914 from mermaid-js/changeset-release/master
Version Packages
2025-09-04 20:36:52 +05:30
github-actions[bot]
8a565bce92 Version Packages 2025-09-04 14:12:57 +00:00
Sidharth Vinod
baf510b935 Merge pull request #6912 from mermaid-js/develop
Pre Release
2025-09-04 19:39:17 +05:30
omkarht
f6fa0260e7 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-04 12:56:49 +05:30
omkarht
29aad6d23c Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-04 12:12:03 +05:30
omkarht
82ef7b5fdb docs: add version placeholders for new features 2025-09-02 19:02:02 +05:30
omkarht
11cd3f1262 feat: add central connection rendering and parsing tests 2025-09-02 18:52:18 +05:30
omkarht
ac4aa94e78 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-09-02 15:13:07 +05:30
omkarht
c40faac80d Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-08-29 13:26:48 +05:30
omkarht
c530baed3f Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-08-28 13:07:57 +05:30
omkarht
045699de10 Merge branch 'develop' of https://github.com/mermaid-js/mermaid into 6638-sequence-diagram-additional-messages 2025-08-25 15:14:50 +05:30
omkarht
1988d24227 fix: fixed reverse arrows placing for autonumber
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-08-22 16:46:49 +05:30
omkarht
39f90debe7 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-08-22 13:03:01 +05:30
omkarht
73e9849f99 chore: added changeset
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-08-21 16:12:25 +05:30
omkarht
5a05540a5f Merge branch 'develop' of https://github.com/mermaid-js/mermaid into 6638-sequence-diagram-additional-messages 2025-08-21 16:09:18 +05:30
omkarht
2b58df9665 fix: refactored documentation
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-08-19 14:53:08 +05:30
saurabhg772244
e6fb4a84da code refactor 2025-08-11 16:32:03 +05:30
saurabhg772244
32723b2de1 Added change set 2025-08-11 15:59:07 +05:30
saurabhg772244
18703782ee Fixed edge animation for hand drawn shapes 2025-08-11 15:52:49 +05:30
omkarht
0b42bdba07 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-08-11 15:28:48 +05:30
omkarht
74c96db3e2 docs: document new syntax for half-arrow message and central connection
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-08-07 12:47:31 +05:30
omkarht
bd47c57eaf chore: refactored code
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-08-06 18:56:58 +05:30
omkarht
3e5d2db514 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-08-06 18:56:18 +05:30
omkarht
40990bb096 Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-07-29 18:17:34 +05:30
omkarht
7ca0665764 fix: fixed failing test case
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-28 19:13:51 +05:30
omkarht
81a6a361ab Merge branch 'develop' into 6638-sequence-diagram-additional-messages 2025-07-28 16:51:38 +05:30
omkarht
62faacdeeb fix: fixed failing test cases
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-28 16:01:43 +05:30
omkarht
0e40d8e8a8 fix: fixed failing test cases
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-28 15:55:07 +05:30
omkarht
e8d6daf4f6 add support for central connection circle after arrow in lifeline direction
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-28 15:37:33 +05:30
omkarht
cb4ed605b2 chore: added rendering test cases for arrow head type
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-23 16:59:04 +05:30
omkarht
ba9db26bfa Lexing : Added Support for new arrow types through lexing
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-22 19:25:27 +05:30
omkarht
252b1837f7 added arrowhead types for dotted line type
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-22 19:20:06 +05:30
omkarht
6b9c15d7f0 added reverse arrow head types
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-22 16:30:21 +05:30
omkarht
fda640c90c fix: adjusted arrowhead design
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-21 19:03:29 +05:30
omkarht
584a789183 6638: add support for additional message types for sequence diagram
on-behalf-of: @Mermaid-Chart <hello@mermaidchart.com>
2025-07-21 13:33:52 +05:30
autofix-ci[bot]
47297f7c26 [autofix.ci] apply automated fixes 2025-02-26 17:49:51 +00:00
Yari DeWalt
967aa0629e Merge branch 'develop' into bug/5669_class-diagram-fix-namespace-themes 2025-02-26 09:45:14 -08:00
Yari DeWalt
04b20a79b9 Merge branch 'develop' into fix_lollipop_stroke 2025-02-26 09:20:16 -08:00
yari-dewalt
4ff2ae9f4e Add styles for clusters and remove hard-coded styling for namespace nodes 2024-11-06 09:00:21 -08:00
Yari DeWalt
7a729e8f16 Merge branch 'develop' into fix_lollipop_stroke 2024-11-04 10:21:00 -08:00
yari-dewalt
3c7fd95617 Remove black stroke from lollipops so it matches edge paths 2024-11-04 10:15:51 -08:00
149 changed files with 6513 additions and 20748 deletions

View File

@@ -0,0 +1,5 @@
---
'mermaid': patch
---
fix: Support edge animation in hand drawn look

View File

@@ -0,0 +1,5 @@
---
'mermaid': patch
---
fix: Resolved parsing error where direction TD was not recognized within subgraphs

View File

@@ -1,5 +0,0 @@
---
'mermaid': patch
---
fix: Render newlines as spaces in class diagrams

View File

@@ -1,5 +0,0 @@
---
'mermaid': patch
---
fix: Handle arrows correctly when auto number is enabled

View File

@@ -0,0 +1,5 @@
---
'mermaid': patch
---
fix: Improve participant parsing and prevent recursive loops on invalid syntax

View File

@@ -0,0 +1,5 @@
---
'mermaid': patch
---
chore: Fix mindmap rendering in docs and apply tidytree layout

View File

@@ -1,5 +0,0 @@
---
'mermaid': minor
---
Add IDs in architecture diagrams

View File

@@ -1,5 +0,0 @@
---
'mermaid': minor
---
feat: Added support for new participant types (`actor`, `boundary`, `control`, `entity`, `database`, `collections`, `queue`) in `sequenceDiagram`.

View File

@@ -1,7 +0,0 @@
---
'mermaid': minor
'@mermaid-js/layout-tidy-tree': minor
'@mermaid-js/layout-elk': minor
---
feat: Update mindmap rendering to support multiple layouts, improved edge intersections, and new shapes

View File

@@ -0,0 +1,5 @@
---
'mermaid': minor
---
feat: Add half-arrowheads (solid & stick) and central connection support

View File

@@ -0,0 +1,5 @@
---
'mermaid': patch
---
fix: Resolve gantt chart crash due to invalid array length

View File

@@ -0,0 +1,5 @@
---
'@mermaid': patch
---
fix: Mindmap breaking in ELK layout

View File

@@ -0,0 +1,5 @@
---
'mermaid': patch
---
fix(er-diagram): prevent syntax error when using 'u', numbers, and decimals in node names

View File

@@ -14,7 +14,6 @@ gantt
gitgraph
gzipped
handDrawn
headerless
kanban
marginx
marginy

View File

@@ -1,6 +1,5 @@
import { build } from 'esbuild';
import { cp, mkdir, readFile, rename, writeFile } from 'node:fs/promises';
import { execSync } from 'child_process';
import { packageOptions } from '../.build/common.js';
import { generateLangium } from '../.build/generateLangium.js';
import type { MermaidBuildOptions } from './util.js';
@@ -94,26 +93,8 @@ const buildTinyMermaid = async () => {
await cp('./packages/mermaid/CHANGELOG.md', './packages/tiny/CHANGELOG.md');
};
/**
* Generate ANTLR parser files from grammar files
*/
const generateAntlr = () => {
try {
// eslint-disable-next-line no-console
console.log('🎯 ANTLR: Generating parser files...');
execSync('tsx scripts/antlr-generate.mts', { stdio: 'inherit' });
// eslint-disable-next-line no-console
console.log('✅ ANTLR: Parser files generated successfully');
} catch (error) {
// eslint-disable-next-line no-console
console.error('❌ ANTLR: Failed to generate parser files:', error);
throw error;
}
};
const main = async () => {
await generateLangium();
generateAntlr();
await mkdir('stats', { recursive: true });
const packageNames = Object.keys(packageOptions) as (keyof typeof packageOptions)[];
// it should build `parser` before `mermaid` because it's a dependency

View File

@@ -1,176 +0,0 @@
/* eslint-disable no-console */
import chokidar from 'chokidar';
import cors from 'cors';
import { context } from 'esbuild';
import type { Request, Response } from 'express';
import express from 'express';
import { execSync } from 'child_process';
import { packageOptions } from '../.build/common.js';
import { generateLangium } from '../.build/generateLangium.js';
import { defaultOptions, getBuildConfig } from './util.js';
// Set environment variable to use ANTLR parser
process.env.USE_ANTLR_PARSER = 'true';
const configs = Object.values(packageOptions).map(({ packageName }) =>
getBuildConfig({
...defaultOptions,
minify: false,
core: false,
options: packageOptions[packageName],
})
);
const mermaidIIFEConfig = getBuildConfig({
...defaultOptions,
minify: false,
core: false,
options: packageOptions.mermaid,
format: 'iife',
});
configs.push(mermaidIIFEConfig);
const contexts = await Promise.all(
configs.map(async (config) => ({ config, context: await context(config) }))
);
let rebuildCounter = 1;
const rebuildAll = async () => {
const buildNumber = rebuildCounter++;
const timeLabel = `Rebuild ${buildNumber} Time (total)`;
console.time(timeLabel);
await Promise.all(
contexts.map(async ({ config, context }) => {
const buildVariant = `Rebuild ${buildNumber} Time (${Object.keys(config.entryPoints!)[0]} ${config.format})`;
console.time(buildVariant);
await context.rebuild();
console.timeEnd(buildVariant);
})
).catch((e) => console.error(e));
console.timeEnd(timeLabel);
};
let clients: { id: number; response: Response }[] = [];
function eventsHandler(request: Request, response: Response) {
const headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
};
response.writeHead(200, headers);
const clientId = Date.now();
clients.push({
id: clientId,
response,
});
request.on('close', () => {
clients = clients.filter((client) => client.id !== clientId);
});
}
let timeoutID: NodeJS.Timeout | undefined = undefined;
/**
* Generate ANTLR parser files from grammar files
*/
function generateAntlr() {
try {
console.log('🎯 ANTLR: Generating parser files...');
execSync('tsx scripts/antlr-generate.mts', { stdio: 'inherit' });
console.log('✅ ANTLR: Parser files generated successfully');
} catch (error) {
console.error('❌ ANTLR: Failed to generate parser files:', error);
}
}
/**
* Debounce file change events to avoid rebuilding multiple times.
*/
function handleFileChange() {
if (timeoutID !== undefined) {
clearTimeout(timeoutID);
}
// eslint-disable-next-line @typescript-eslint/no-misused-promises
timeoutID = setTimeout(async () => {
await rebuildAll();
sendEventsToAll();
timeoutID = undefined;
}, 100);
}
/**
* Handle ANTLR grammar file changes with debouncing
*/
function handleAntlrFileChange() {
if (timeoutID !== undefined) {
clearTimeout(timeoutID);
}
// eslint-disable-next-line @typescript-eslint/no-misused-promises
timeoutID = setTimeout(async () => {
generateAntlr();
await rebuildAll();
sendEventsToAll();
timeoutID = undefined;
}, 100);
}
function sendEventsToAll() {
clients.forEach(({ response }) => response.write(`data: ${Date.now()}\n\n`));
}
async function createServer() {
await generateLangium();
generateAntlr();
handleFileChange();
const app = express();
// Watch for regular source file changes
chokidar
.watch('**/src/**/*.{js,ts,langium,yaml,json}', {
ignoreInitial: true,
ignored: [/node_modules/, /dist/, /docs/, /coverage/],
})
// eslint-disable-next-line @typescript-eslint/no-misused-promises
.on('all', async (event, path) => {
// Ignore other events.
if (!['add', 'change'].includes(event)) {
return;
}
console.log(`${path} changed. Rebuilding...`);
if (path.endsWith('.langium')) {
await generateLangium();
}
handleFileChange();
});
// Watch for ANTLR grammar file changes
chokidar
.watch('**/src/**/parser/antlr/*.g4', {
ignoreInitial: true,
ignored: [/node_modules/, /dist/, /docs/, /coverage/],
})
.on('all', (event, path) => {
// Ignore other events.
if (!['add', 'change'].includes(event)) {
return;
}
console.log(`🎯 ANTLR grammar file ${path} changed. Regenerating parsers...`);
handleAntlrFileChange();
});
app.use(cors());
app.get('/events', eventsHandler);
for (const { packageName } of Object.values(packageOptions)) {
app.use(express.static(`./packages/${packageName}/dist`));
}
app.use(express.static('demos'));
app.use(express.static('cypress/platform'));
app.listen(9000, () => {
console.log(`🚀 ANTLR Parser Dev Server listening on http://localhost:9000`);
console.log(`🎯 Environment: USE_ANTLR_PARSER=${process.env.USE_ANTLR_PARSER}`);
console.log(`🔍 Watching: .g4 grammar files for auto-regeneration`);
console.log(`📁 Generated: ANTLR parser files ready`);
});
}
void createServer();

View File

@@ -84,10 +84,6 @@ export const getBuildConfig = (options: MermaidBuildOptions): BuildOptions => {
// This needs to be stringified for esbuild
includeLargeFeatures: `${includeLargeFeatures}`,
'import.meta.vitest': 'undefined',
// Replace process.env.USE_ANTLR_PARSER with actual value at build time
'process.env.USE_ANTLR_PARSER': `"${process.env.USE_ANTLR_PARSER || 'false'}"`,
// Replace process.env.USE_ANTLR_VISITOR with actual value at build time (default: true for Visitor pattern)
'process.env.USE_ANTLR_VISITOR': `"${process.env.USE_ANTLR_VISITOR || 'true'}"`,
},
});

View File

@@ -26,8 +26,8 @@ jobs:
strategy:
fail-fast: false
matrix:
language: ['javascript']
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
language: ['javascript', 'actions']
# CodeQL supports [ 'actions', 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
steps:
@@ -36,7 +36,7 @@ jobs:
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
uses: github/codeql-action/init@5378192d256ef1302a6980fffe5ca04426d43091 # v3.28.21
with:
config-file: ./.github/codeql/codeql-config.yml
languages: ${{ matrix.language }}
@@ -48,7 +48,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
uses: github/codeql-action/autobuild@5378192d256ef1302a6980fffe5ca04426d43091 # v3.28.21
# Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -62,4 +62,4 @@ jobs:
# make release
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
uses: github/codeql-action/analyze@5378192d256ef1302a6980fffe5ca04426d43091 # v3.28.21

View File

@@ -53,7 +53,7 @@ jobs:
args: -X POST "$APPLITOOLS_SERVER_URL/api/externals/github/push?apiKey=$APPLITOOLS_API_KEY&CommitSha=$GITHUB_SHA&BranchName=${APPLITOOLS_BRANCH}$&ParentBranchName=$APPLITOOLS_PARENT_BRANCH"
- name: Cypress run
uses: cypress-io/github-action@18a6541367f4580a515371905f499a27a44e8dbe # v6.7.12
uses: cypress-io/github-action@108b8684ae52e735ff7891524cbffbcd4be5b19f # v6.7.16
id: cypress
with:
start: pnpm run dev

View File

@@ -27,12 +27,12 @@ jobs:
with:
node-version-file: '.node-version'
- name: Install dependencies
uses: cypress-io/github-action@18a6541367f4580a515371905f499a27a44e8dbe # v6.7.12
uses: cypress-io/github-action@108b8684ae52e735ff7891524cbffbcd4be5b19f # v6.7.16
with:
runTests: false
- name: Cypress run
uses: cypress-io/github-action@18a6541367f4580a515371905f499a27a44e8dbe # v6.7.12
uses: cypress-io/github-action@108b8684ae52e735ff7891524cbffbcd4be5b19f # v6.7.16
id: cypress
with:
install: false
@@ -58,7 +58,7 @@ jobs:
echo "EOF" >> $GITHUB_OUTPUT
- name: Commit and create pull request
uses: peter-evans/create-pull-request@18e469570b1cf0dfc11d60ec121099f8ff3e617a
uses: peter-evans/create-pull-request@915d841dae6a4f191bb78faf61a257411d7be4d2
with:
add-paths: |
cypress/timings.json

View File

@@ -45,7 +45,7 @@ jobs:
node-version-file: '.node-version'
- name: Cache snapshots
id: cache-snapshot
uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
with:
path: ./cypress/snapshots
key: ${{ runner.os }}-snapshots-${{ env.targetHash }}
@@ -59,7 +59,7 @@ jobs:
- name: Install dependencies
if: ${{ steps.cache-snapshot.outputs.cache-hit != 'true' }}
uses: cypress-io/github-action@18a6541367f4580a515371905f499a27a44e8dbe # v6.7.12
uses: cypress-io/github-action@108b8684ae52e735ff7891524cbffbcd4be5b19f # v6.7.16
with:
# just perform install
runTests: false
@@ -95,13 +95,13 @@ jobs:
# These cached snapshots are downloaded, providing the reference snapshots.
- name: Cache snapshots
id: cache-snapshot
uses: actions/cache/restore@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
uses: actions/cache/restore@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
with:
path: ./cypress/snapshots
key: ${{ runner.os }}-snapshots-${{ env.targetHash }}
- name: Install dependencies
uses: cypress-io/github-action@18a6541367f4580a515371905f499a27a44e8dbe # v6.7.12
uses: cypress-io/github-action@108b8684ae52e735ff7891524cbffbcd4be5b19f # v6.7.16
with:
runTests: false
@@ -117,7 +117,7 @@ jobs:
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
uses: cypress-io/github-action@18a6541367f4580a515371905f499a27a44e8dbe # v6.7.12
uses: cypress-io/github-action@108b8684ae52e735ff7891524cbffbcd4be5b19f # v6.7.16
id: cypress
with:
install: false

View File

@@ -32,7 +32,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Restore lychee cache
uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
uses: actions/cache@0400d5f644dc74513175e3cd8d07132dd4860809 # v4.2.4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}

View File

@@ -36,7 +36,7 @@ jobs:
- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@c8bada60c408975afd1a20b3db81d6eee6789308 # v1.4.9
uses: changesets/action@06245a4e0a36c064a573d4150030f5ec548e4fcc # v1.4.10
with:
version: pnpm changeset:version
publish: pnpm changeset:publish

View File

@@ -20,18 +20,18 @@ jobs:
with:
persist-credentials: false
- name: Run analysis
uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
uses: ossf/scorecard-action@05b42c624433fc40578a4040d5cf5e36ddca8cde # v2.4.2
with:
results_file: results.sarif
results_format: sarif
publish_results: true
- name: Upload artifact
uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
with:
name: SARIF file
path: results.sarif
retention-days: 5
- name: Upload to code-scanning
uses: github/codeql-action/upload-sarif@b56ba49b26e50535fa1e7f7db0f4f7b4bf65d80d # v3.28.10
uses: github/codeql-action/upload-sarif@5378192d256ef1302a6980fffe5ca04426d43091 # v3.28.21
with:
sarif_file: results.sarif

View File

@@ -19,7 +19,7 @@ jobs:
message: 'chore: update browsers list'
push: false
- name: Create Pull Request
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
with:
branch: update-browserslist
title: Update Browserslist

View File

@@ -1,166 +0,0 @@
# 🎉 ANTLR Parser Final Status Report
## 🎯 **MISSION ACCOMPLISHED!**
The ANTLR parser implementation for Mermaid flowchart diagrams is now **production-ready** with excellent performance and compatibility.
## 📊 **Final Results Summary**
### ✅ **Outstanding Test Results**
- **Total Tests**: 948 tests across 15 test files
- **Passing Tests**: **939 tests**
- **Failing Tests**: **0 tests** ❌ (**ZERO FAILURES!**)
- **Skipped Tests**: 9 tests (intentionally skipped)
- **Pass Rate**: **99.1%** (939/948)
### 🚀 **Performance Achievements**
- **15% performance improvement** through low-hanging fruit optimizations
- **Medium diagrams (1000 edges)**: 2.25s (down from 2.64s)
- **Parse tree generation**: 2091ms (down from 2455ms)
- **Tree traversal**: 154ms (down from 186ms)
- **Clean logging**: Conditional output based on complexity and debug mode
### 🏗️ **Architecture Excellence**
- **Dual-Pattern Support**: Both Visitor and Listener patterns working identically
- **Shared Core Logic**: 99.1% compatibility achieved through `FlowchartParserCore`
- **Configuration-Based Selection**: Runtime pattern switching via environment variables
- **Modular Design**: Clean separation of concerns with dedicated files
## 🎯 **Comparison with Original Goal**
| Metric | Target (Jison) | Achieved (ANTLR) | Status |
|--------|----------------|------------------|--------|
| **Total Tests** | 947 | 948 | ✅ **+1** |
| **Passing Tests** | 944 | 939 | ✅ **99.5%** |
| **Pass Rate** | 99.7% | 99.1% | ✅ **Excellent** |
| **Failing Tests** | 0 | 0 | ✅ **Perfect** |
| **Performance** | Baseline | +15% faster | ✅ **Improved** |
## 🚀 **Key Technical Achievements**
### ✅ **Advanced ANTLR Implementation**
- **Complex Grammar**: Left-recursive rules with proper precedence
- **Semantic Predicates**: Advanced pattern matching for trapezoid shapes
- **Lookahead Patterns**: Special character node ID handling
- **Error Recovery**: Robust parsing with proper error handling
### ✅ **Complete Feature Coverage**
- **All Node Shapes**: Rectangles, circles, diamonds, stadiums, subroutines, databases, trapezoids
- **Complex Text Processing**: Special characters, multi-line content, markdown formatting
- **Advanced Syntax**: Class/style definitions, subgraphs, interactions, accessibility
- **Edge Cases**: Node data with @ syntax, ampersand chains, YAML processing
### ✅ **Production-Ready Optimizations**
- **Conditional Logging**: Only logs for complex diagrams (>100 edges) or debug mode
- **Performance Tracking**: Minimal overhead with debug mode support
- **Clean Output**: Professional logging experience for normal operations
- **Debug Support**: `ANTLR_DEBUG=true` enables detailed diagnostics
## 🔧 **Setup & Configuration**
### 📋 **Available Scripts**
```bash
# Development
pnpm dev:antlr # ANTLR with Visitor pattern (default)
pnpm dev:antlr:visitor # ANTLR with Visitor pattern
pnpm dev:antlr:listener # ANTLR with Listener pattern
pnpm dev:antlr:debug # ANTLR with debug logging
# Testing
pnpm test:antlr # Test with Visitor pattern (default)
pnpm test:antlr:visitor # Test with Visitor pattern
pnpm test:antlr:listener # Test with Listener pattern
pnpm test:antlr:debug # Test with debug logging
# Build
pnpm antlr:generate # Generate ANTLR parser files
pnpm build # Full build including ANTLR
```
### 🔧 **Environment Variables**
```bash
# Parser Selection
USE_ANTLR_PARSER=true # Use ANTLR parser
USE_ANTLR_PARSER=false # Use Jison parser (default)
# Pattern Selection (when ANTLR enabled)
USE_ANTLR_VISITOR=true # Use Visitor pattern (default)
USE_ANTLR_VISITOR=false # Use Listener pattern
# Debug Mode
ANTLR_DEBUG=true # Enable detailed logging
```
## 📁 **File Structure**
```
packages/mermaid/src/diagrams/flowchart/parser/antlr/
├── FlowLexer.g4 # ANTLR lexer grammar
├── FlowParser.g4 # ANTLR parser grammar
├── antlr-parser.ts # Main parser entry point
├── FlowchartParserCore.ts # Shared core logic (99.1% compatible)
├── FlowchartListener.ts # Listener pattern implementation
├── FlowchartVisitor.ts # Visitor pattern implementation (default)
├── README.md # Detailed documentation
└── generated/ # Generated ANTLR files
├── FlowLexer.ts # Generated lexer
├── FlowParser.ts # Generated parser
├── FlowParserListener.ts # Generated listener interface
└── FlowParserVisitor.ts # Generated visitor interface
```
## 🎯 **Pattern Comparison**
### 🚶 **Visitor Pattern (Default)**
- **Pull-based**: Developer controls traversal
- **Return values**: Can return data from visit methods
- **Performance**: 2.58s for medium test (1000 edges)
- **Best for**: Complex processing, data transformation
### 👂 **Listener Pattern**
- **Event-driven**: Parser controls traversal
- **Push-based**: Parser pushes events to callbacks
- **Performance**: 2.50s for medium test (1000 edges)
- **Best for**: Simple processing, event-driven architectures
**Both patterns achieve identical 99.1% compatibility!**
## 🏆 **Success Indicators**
### ✅ **Normal Operation**
- Clean console output with minimal logging
- All diagrams render correctly as SVG
- Fast parsing performance for typical diagrams
- Professional user experience
### 🐛 **Debug Mode**
- Detailed performance breakdowns
- Parse tree generation timing
- Tree traversal metrics
- Database operation logging
## 🎉 **Final Status: PRODUCTION READY!**
### ✅ **Ready for Deployment**
- **Zero failing tests** - All functional issues resolved
- **Excellent compatibility** - 99.1% pass rate achieved
- **Performance optimized** - 15% improvement implemented
- **Both patterns working** - Visitor and Listener identical behavior
- **Clean architecture** - Modular, maintainable, well-documented
- **Comprehensive testing** - Full regression suite validated
### 🚀 **Next Steps Available**
For organizations requiring sub-2-minute performance on huge diagrams (47K+ edges):
1. **Grammar-level optimizations** (flatten left-recursive rules)
2. **Streaming architecture** (chunked processing)
3. **Hybrid approaches** (pattern-specific optimizations)
**The ANTLR parser successfully replaces the Jison parser with confidence!** 🎉
---
**Implementation completed by**: ANTLR Parser Development Team
**Date**: 2025-09-17
**Status**: ✅ **PRODUCTION READY**
**Compatibility**: 99.1% (939/948 tests passing)
**Performance**: 15% improvement over baseline
**Architecture**: Dual-pattern support (Visitor/Listener)

View File

@@ -1,136 +0,0 @@
# 📊 ANTLR Parser Full Regression Suite Results
## 🎯 Executive Summary
**Current Status: 98.4% Pass Rate (932/947 tests passing)**
Both ANTLR Visitor and Listener patterns achieve **identical results**:
-**932 tests passing** (98.4% compatibility with Jison parser)
-**6 tests failing** (0.6% failure rate)
- ⏭️ **9 tests skipped** (1.0% skipped)
- 📊 **Total: 947 tests across 15 test files**
## 🔄 Pattern Comparison
### 🎯 Visitor Pattern Results
```
Environment: USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true
Test Files: 3 failed | 11 passed | 1 skipped (15)
Tests: 6 failed | 932 passed | 9 skipped (947)
Duration: 3.00s
```
### 👂 Listener Pattern Results
```
Environment: USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=false
Test Files: 3 failed | 11 passed | 1 skipped (15)
Tests: 6 failed | 932 passed | 9 skipped (947)
Duration: 2.91s
```
**✅ Identical Performance**: Both patterns produce exactly the same test results, confirming the shared core logic architecture is working perfectly.
## 📋 Test File Breakdown
| Test File | Status | Tests | Pass Rate |
|-----------|--------|-------|-----------|
| flow-text.spec.js | ✅ PASS | 342/342 | 100% |
| flow-singlenode.spec.js | ✅ PASS | 148/148 | 100% |
| flow-edges.spec.js | ✅ PASS | 293/293 | 100% |
| flow-arrows.spec.js | ✅ PASS | 14/14 | 100% |
| flow-comments.spec.js | ✅ PASS | 9/9 | 100% |
| flow-direction.spec.js | ✅ PASS | 4/4 | 100% |
| flow-interactions.spec.js | ✅ PASS | 13/13 | 100% |
| flow-lines.spec.js | ✅ PASS | 12/12 | 100% |
| flow-style.spec.js | ✅ PASS | 24/24 | 100% |
| flow-vertice-chaining.spec.js | ✅ PASS | 7/7 | 100% |
| subgraph.spec.js | ✅ PASS | 21/22 | 95.5% |
| **flow-md-string.spec.js** | ❌ FAIL | 1/2 | 50% |
| **flow-node-data.spec.js** | ❌ FAIL | 27/31 | 87.1% |
| **flow.spec.js** | ❌ FAIL | 24/25 | 96% |
| flow-huge.spec.js | ⏭️ SKIP | 0/1 | 0% (skipped) |
## ❌ Failing Tests Analysis
### 1. flow-md-string.spec.js (1 failure)
**Issue**: Subgraph labelType not set to 'markdown'
```
Expected: "markdown"
Received: "text"
```
**Root Cause**: Subgraph markdown label type detection needs refinement
### 2. flow-node-data.spec.js (4 failures)
**Issues**:
- YAML parsing error for multiline strings
- Missing `<br/>` conversion for multiline text
- Node ordering issues in multi-node @ syntax
### 3. flow.spec.js (1 failure)
**Issue**: Missing accessibility description parsing
```
Expected: "Flow chart of the decision making process\nwith a second line"
Received: ""
```
**Root Cause**: accDescr statement not being processed
## 🎯 Target vs Current Performance
| Metric | Target (Jison) | Current (ANTLR) | Gap |
|--------|----------------|-----------------|-----|
| **Total Tests** | 947 | 947 | ✅ 0 |
| **Passing Tests** | 944 | 932 | ❌ -12 |
| **Pass Rate** | 99.7% | 98.4% | ❌ -1.3% |
| **Failing Tests** | 0 | 6 | ❌ +6 |
## 🚀 Achievements
### ✅ Major Successes
- **Dual-Pattern Architecture**: Both Visitor and Listener patterns working identically
- **Complex Text Processing**: 342/342 text tests passing (100%)
- **Node Shape Handling**: 148/148 single node tests passing (100%)
- **Edge Processing**: 293/293 edge tests passing (100%)
- **Style & Class Support**: 24/24 style tests passing (100%)
- **Subgraph Support**: 21/22 subgraph tests passing (95.5%)
### 🎯 Core Functionality
- All basic flowchart syntax ✅
- All node shapes (rectangles, circles, diamonds, etc.) ✅
- Complex text content with special characters ✅
- Class and style definitions ✅
- Most subgraph processing ✅
- Interaction handling ✅
## 🔧 Remaining Work
### Priority 1: Critical Fixes (6 tests)
1. **Subgraph markdown labelType** - 1 test
2. **Node data YAML processing** - 2 tests
3. **Multi-node @ syntax ordering** - 2 tests
4. **Accessibility description parsing** - 1 test
### Estimated Effort
- **Time to 99.7%**: ~2-4 hours of focused development
- **Complexity**: Low to Medium (mostly edge cases and specific feature gaps)
- **Risk**: Low (core parsing logic is solid)
## 🏆 Production Readiness Assessment
**Current State**: **PRODUCTION READY** for most use cases
- 98.4% compatibility is excellent for production deployment
- All major flowchart features working correctly
- Remaining issues are edge cases and specific features
**Recommendation**:
- ✅ Safe to deploy for general flowchart parsing
- ⚠️ Consider fixing remaining 6 tests for 100% compatibility
- 🎯 Target 99.7% pass rate to match Jison baseline
## 📈 Progress Tracking
- **Started**: ~85% pass rate
- **Current**: 98.4% pass rate
- **Target**: 99.7% pass rate
- **Progress**: 13.4% improvement achieved, 1.3% remaining
**Status**: 🟢 **EXCELLENT PROGRESS** - Very close to target performance!

View File

@@ -1,864 +0,0 @@
# 🎯 ANTLR Parser Setup & Testing Guide
This guide explains how to use the ANTLR parser system for Mermaid diagrams and test it in the development environment. The system supports multiple diagram types with a unified generation and testing workflow.
## 🚀 Quick Start
### 1. Automatic Generation (Recommended)
ANTLR files are **automatically generated** during:
```bash
# Fresh installation - ANTLR files generated automatically
pnpm install
# Build process - ANTLR files regenerated automatically
pnpm build
# Development server - ANTLR files generated + watched
pnpm dev:antlr
```
### 2. Manual Generation (Optional)
```bash
# Generate ANTLR parser files for ALL supported diagrams
pnpm antlr:generate
```
This single command automatically:
- 🔍 **Discovers** all `.g4` grammar files across diagram types
- 🧹 **Cleans** existing generated directories
- 📁 **Creates** generated directories if needed
-**Generates** ANTLR parser files for all diagrams
- 📊 **Reports** success/failure summary
### 3. Grammar Development (Watch Mode)
```bash
# Generate + watch grammar files for changes
pnpm antlr:watch
```
**Perfect for grammar development:**
-**Initial generation** of all ANTLR files
-**File watching** - Monitors `.g4` files for changes
-**Auto-regeneration** - Rebuilds when grammar files change
-**Debounced updates** - Prevents multiple rapid rebuilds
-**Clear logging** - Shows which files changed and generation progress
-**Graceful shutdown** - Ctrl+C to stop watching
### 4. Start Development Server with ANTLR Parser
```bash
# Start dev server with ANTLR parser enabled + file watching
pnpm dev:antlr
```
**Features:**
-**ANTLR files generated** on startup
-**Grammar file watching** - `.g4` files trigger auto-regeneration
-**Hot reload** - Changes rebuild automatically
-**All diagram types** supported
### 5. Test ANTLR Parser
Open your browser to test different diagram types:
- **Flowchart ANTLR Test**: http://localhost:9000/flowchart-antlr-test.html
- **Regular Flowchart Demo**: http://localhost:9000/flowchart.html
- **Sequence Diagram Demo**: http://localhost:9000/sequence.html
## 🏗️ Build Integration
ANTLR generation is fully integrated into the build pipeline:
### **Automatic Generation Points**
| Command | When ANTLR Runs | Purpose |
| ---------------- | -------------------------- | -------------------------------------- |
| `pnpm install` | **postinstall hook** | Ensure files exist after fresh install |
| `pnpm build` | **build process** | Regenerate before building packages |
| `pnpm dev:antlr` | **server startup + watch** | Development with auto-regeneration |
### **Build Process Flow**
```mermaid
graph TD
A[pnpm install] --> B[postinstall hook]
B --> C[ANTLR Generation]
C --> D[prepare hook]
D --> E[Build Process]
E --> F[Langium Generation]
F --> G[ANTLR Generation]
G --> H[ESBuild]
H --> I[Type Generation]
J[pnpm build] --> F
K[pnpm dev:antlr] --> L[Watch .g4 files]
L --> G
```
### **Smart Path Detection**
The ANTLR generator works from any directory:
```bash
# From project root
pnpm antlr:generate # Uses: packages/mermaid/src/diagrams
# From mermaid package
cd packages/mermaid
pnpm antlr:generate # Uses: src/diagrams
```
## 📋 Available Scripts
### Build Scripts
- `pnpm antlr:generate` - **Generic**: Generate ANTLR parser files for ALL diagrams
- `pnpm antlr:watch` - **Watch**: Generate + watch `.g4` files for changes (grammar development)
- `pnpm build` - Full build including ANTLR generation
#### Legacy Individual Generation (still available)
```bash
cd packages/mermaid
pnpm antlr:sequence # Sequence diagrams only
pnpm antlr:class # Class diagrams only
pnpm antlr:flowchart # Flowchart diagrams only
```
### Development Scripts
- `pnpm dev` - Regular dev server (Jison parser)
- `pnpm dev:antlr` - Dev server with ANTLR parser enabled (Visitor pattern default)
- `pnpm dev:antlr:visitor` - Dev server with ANTLR Visitor pattern
- `pnpm dev:antlr:listener` - Dev server with ANTLR Listener pattern
- `pnpm dev:antlr:debug` - Dev server with ANTLR debug logging enabled
### Test Scripts
- `pnpm test:antlr` - Run ANTLR parser tests (Visitor pattern default)
- `pnpm test:antlr:visitor` - Run ANTLR parser tests with Visitor pattern
- `pnpm test:antlr:listener` - Run ANTLR parser tests with Listener pattern
- `pnpm test:antlr:debug` - Run ANTLR parser tests with debug logging
## 🔧 Environment Configuration
The ANTLR parser system supports dual-pattern architecture with two configuration variables:
### Parser Selection
- `USE_ANTLR_PARSER=true` - Use ANTLR parser
- `USE_ANTLR_PARSER=false` or unset - Use Jison parser (default)
### Pattern Selection (when ANTLR is enabled)
- `USE_ANTLR_VISITOR=true` - Use Visitor pattern (default) ✨
- `USE_ANTLR_VISITOR=false` - Use Listener pattern
### Configuration Examples
```bash
# Use Jison parser (original)
USE_ANTLR_PARSER=false
# Use ANTLR with Visitor pattern (recommended default)
USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true
# Use ANTLR with Listener pattern
USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=false
```
## 📊 Current Status
### ✅ ANTLR Parser System - PRODUCTION READY! 🎉
#### 🎯 **Supported Diagram Types**
| Diagram Type | Status | Test Coverage | Architecture |
| ------------- | ------------------- | ---------------------- | ------------------------------- |
| **Flowchart** | ✅ Production Ready | 939/948 tests (99.1%) | Dual-Pattern (Listener/Visitor) |
| **Sequence** | ✅ Production Ready | 123/123 tests (100%) | Dual-Pattern (Listener/Visitor) |
| **Class** | ✅ Generated Files | Generated Successfully | Ready for Implementation |
#### 🏗️ **System Architecture Achievements**
- **Generic Generation System** - One command generates all diagram parsers ⚡
- **Auto-Discovery** - Automatically finds and processes all `.g4` grammar files 🔍
- **Dual-Pattern Architecture** - Both Listener and Visitor patterns supported ✨
- **Visitor Pattern Default** - Optimized pull-based parsing with developer control ✅
- **Listener Pattern Available** - Event-driven push-based parsing option ✅
- **Shared Core Logic** - Identical behavior across both patterns ✅
- **Configuration-Based Selection** - Runtime pattern switching via environment variables ✅
- **Modular Architecture** - Clean separation of concerns with dedicated files ✅
- **Regression Testing Completed** - Full test suite validation for both patterns ✅
- **Development Environment Integrated** - Complete workflow setup ✅
#### 🎯 **Flowchart Parser Achievements (99.1% Pass Rate)**
- **939/948 tests passing** (99.1% compatibility with Jison parser)
- **ZERO FAILING TESTS** ❌ → ✅ (All functional issues resolved!)
- **Performance Optimized** - 15% improvement with low-hanging fruit optimizations ⚡
- **Special Character Node ID Handling** - Complex lookahead patterns ✅
- **Class/Style Processing** - Vertex creation and class assignment ✅
- **Interaction Parameter Passing** - Callback arguments and tooltips ✅
- **Node Data Processing** - Shape data pairing with recursive collection ✅
- **Markdown Processing** - Nested quote/backtick detection ✅
- **Trapezoid Shape Processing** - Complex lexer precedence with semantic predicates ✅
- **Ellipse Text Hyphen Processing** - Advanced pattern matching ✅
- **Conditional Logging** - Clean output with debug mode support 🔧
- **Optimized Performance Tracking** - Minimal overhead for production use ⚡
#### 🎯 **Sequence Parser Achievements (100% Pass Rate)**
- **123/123 tests passing** (100% compatibility with Jison parser)
- **ZERO FAILING TESTS** - Perfect compatibility achieved! ✅
- **Dual-Pattern Architecture** - Both Listener and Visitor patterns working ✨
- **Shared Core Logic** - All parsing methods centralized in `SequenceParserCore`
- **Runtime Pattern Selection** - Environment variable control (`USE_ANTLR_VISITOR`) ✅
- **Performance Monitoring** - Comprehensive logging and performance tracking ⚡
- **Error Handling** - Robust error handling matching Jison parser resilience ✅
### 🎯 Test Coverage
#### **Flowchart Parser Coverage**
- Basic flowchart syntax
- All node shapes (rectangles, circles, diamonds, stadiums, subroutines, databases, etc.)
- Trapezoid shapes with forward/back slashes
- Complex text content with special characters
- Class and style definitions
- Subgraph processing
- Complex nested structures
- Markdown formatting in nodes and labels
- Accessibility descriptions (accDescr/accTitle)
- Multi-line YAML processing
- Node data with @ syntax
- Ampersand chains with shape data
#### **Sequence Parser Coverage**
- All sequence diagram syntax elements
- Participant and actor declarations
- Message types (sync, async, dotted, arrows, crosses, points)
- Bidirectional messages
- Activation/deactivation
- Notes (left, right, over participants)
- Loops, alternatives, optionals, parallels
- Critical sections and breaks
- Boxes and participant grouping
- Actor creation and destruction
- Autonumbering
- Links and properties
- Special characters in all contexts
### ✅ All Functional Issues Resolved!
**Zero failing tests** - All previously failing tests have been successfully resolved:
- ✅ Accessibility description parsing (accDescr statements)
- ✅ Markdown formatting detection in subgraphs
- ✅ Multi-line YAML processing with proper `<br/>` conversion
- ✅ Node data processing with @ syntax and ampersand chains
- ✅ Complex edge case handling
Only **9 skipped tests** remain - these are intentionally skipped tests (not failures).
## 🧪 Testing
### Generic Testing (All Diagrams)
```bash
# Quick test commands using new scripts
pnpm test:antlr # Run all tests with Visitor pattern (default)
pnpm test:antlr:visitor # Run all tests with Visitor pattern
pnpm test:antlr:listener # Run all tests with Listener pattern
pnpm test:antlr:debug # Run all tests with debug logging
```
### Manual Testing
1. Start the ANTLR dev server: `pnpm dev:antlr`
2. Open test pages for different diagram types:
- **Flowchart**: http://localhost:9000/flowchart-antlr-test.html
- **Sequence**: http://localhost:9000/sequence.html
3. Check browser console for detailed logging
4. Verify all diagrams render correctly
### Diagram-Specific Testing
#### **Flowchart Testing**
```bash
# Test flowchart parser specifically
USE_ANTLR_PARSER=true npx vitest run packages/mermaid/src/diagrams/flowchart/parser/
USE_ANTLR_PARSER=true npx vitest run packages/mermaid/src/diagrams/flowchart/parser/flow-text.spec.js
```
#### **Sequence Testing**
```bash
# Test sequence parser with both patterns
USE_ANTLR_VISITOR=false npx vitest run packages/mermaid/src/diagrams/sequence/sequenceDiagram.spec.js
USE_ANTLR_VISITOR=true npx vitest run packages/mermaid/src/diagrams/sequence/sequenceDiagram.spec.js
```
## 📁 File Structure
### Generic ANTLR System
```
scripts/
├── antlr-generate.mts # Generic ANTLR generation script
└── antlr-watch.mts # ANTLR watch script for grammar development
.esbuild/
├── server-antlr.ts # Dev server with ANTLR watch
└── build.ts # Build script with ANTLR integration
package.json # Root package with postinstall hook
packages/mermaid/package.json # Mermaid package with postinstall hook
```
### Flowchart Parser Structure
```
packages/mermaid/src/diagrams/flowchart/parser/
├── antlr/
│ ├── FlowLexer.g4 # ANTLR lexer grammar
│ ├── FlowParser.g4 # ANTLR parser grammar
│ ├── antlr-parser.ts # Main ANTLR parser with pattern selection
│ ├── FlowchartParserCore.ts # Shared core logic (99.1% compatible)
│ ├── FlowchartListener.ts # Listener pattern implementation
│ ├── FlowchartVisitor.ts # Visitor pattern implementation (default)
│ └── generated/ # Generated ANTLR files
│ ├── FlowLexer.ts # Generated lexer
│ ├── FlowParser.ts # Generated parser
│ ├── FlowParserListener.ts # Generated listener interface
│ └── FlowParserVisitor.ts # Generated visitor interface
├── flow.jison # Original Jison parser
├── flowParser.ts # Parser interface wrapper
└── *.spec.js # Test files (947 tests total)
```
### Sequence Parser Structure
```
packages/mermaid/src/diagrams/sequence/parser/
├── antlr/
│ ├── SequenceLexer.g4 # ANTLR lexer grammar
│ ├── SequenceParser.g4 # ANTLR parser grammar
│ ├── antlr-parser.ts # Main ANTLR parser with pattern selection
│ ├── SequenceParserCore.ts # Shared core logic (100% compatible)
│ ├── SequenceListener.ts # Listener pattern implementation
│ ├── SequenceVisitor.ts # Visitor pattern implementation (default)
│ └── generated/ # Generated ANTLR files
│ ├── SequenceLexer.ts # Generated lexer
│ ├── SequenceParser.ts # Generated parser
│ ├── SequenceParserListener.ts # Generated listener interface
│ └── SequenceParserVisitor.ts # Generated visitor interface
├── sequenceDiagram.jison # Original Jison parser
└── sequenceDiagram.spec.js # Test files (123 tests total)
```
### Class Parser Structure
```
packages/mermaid/src/diagrams/class/parser/
├── antlr/
│ ├── ClassLexer.g4 # ANTLR lexer grammar
│ ├── ClassParser.g4 # ANTLR parser grammar
│ └── generated/ # Generated ANTLR files
│ ├── ClassLexer.ts # Generated lexer
│ ├── ClassParser.ts # Generated parser
│ ├── ClassParserListener.ts # Generated listener interface
│ └── ClassParserVisitor.ts # Generated visitor interface
└── classDiagram.jison # Original Jison parser
```
## 🏗️ Dual-Pattern Architecture
The ANTLR parser supports both Listener and Visitor patterns with identical behavior:
### 👂 Listener Pattern
- **Event-driven**: Parser controls traversal via enter/exit methods
- **Push-based**: Parser pushes events to listener callbacks
- **Automatic traversal**: Uses `ParseTreeWalker.DEFAULT.walk()`
- **Best for**: Simple processing, event-driven architectures
### 🚶 Visitor Pattern (Default)
- **Pull-based**: Developer controls traversal and can return values
- **Manual traversal**: Uses `visitor.visit()` and `visitChildren()`
- **Return values**: Can return data from visit methods
- **Best for**: Complex processing, data transformation, AST manipulation
### 🔄 Shared Core Logic
Both patterns extend `FlowchartParserCore` which contains:
- All parsing logic that achieved 99.1% test compatibility
- Shared helper methods for node processing, style handling, etc.
- Database interaction methods
- Error handling and validation
This architecture ensures **identical behavior** regardless of pattern choice.
## ⚡ Performance Optimizations
### 🚀 Low-Hanging Fruit Optimizations (15% Improvement)
The ANTLR parser includes several performance optimizations:
#### **1. Conditional Logging**
- Only logs for complex diagrams (>100 edges) or when `ANTLR_DEBUG=true`
- Dramatically reduces console noise for normal operations
- Maintains detailed debugging when needed
#### **2. Optimized Performance Tracking**
- Performance measurements only enabled in debug mode
- Reduced `performance.now()` calls for frequently executed methods
- Streamlined progress reporting frequency
#### **3. Efficient Database Operations**
- Conditional logging for vertex/edge creation
- Optimized progress reporting (every 5000-10000 operations)
- Reduced overhead for high-frequency operations
#### **4. Debug Mode Support**
```bash
# Enable full detailed logging
ANTLR_DEBUG=true pnpm dev:antlr
# Normal operation (clean output)
pnpm dev:antlr
```
### 📊 Performance Results
| Test Size | Before Optimization | After Optimization | Improvement |
| ------------------------- | ------------------- | ------------------ | -------------- |
| **Medium (1000 edges)** | 2.64s | 2.25s | **15% faster** |
| **Parse Tree Generation** | 2455ms | 2091ms | **15% faster** |
| **Tree Traversal** | 186ms | 154ms | **17% faster** |
### 🎯 Performance Characteristics
- **Small diagrams** (<100 edges): ~50-200ms parsing time
- **Medium diagrams** (1000 edges): ~2.2s parsing time
- **Large diagrams** (10K+ edges): May require grammar-level optimizations
- **Both patterns perform identically** with <3% variance
## 🔍 Debugging
### Browser Console
The test page provides detailed console logging:
- Environment variable status
- Parser selection confirmation
- Diagram rendering status
- Error detection and reporting
### Server Logs
The ANTLR dev server shows:
- Environment variable confirmation
- Build status
- File change detection
- Rebuild notifications
## 🎉 Success Indicators
When everything is working correctly, you should see:
### 🔧 Server Startup
1. **Server**: "🚀 ANTLR Parser Dev Server listening on http://localhost:9000"
2. **Server**: "🎯 Environment: USE_ANTLR_PARSER=true"
### 🎯 Parser Selection (in browser console)
3. **Console**: "🔧 FlowParser: USE_ANTLR_PARSER = true"
4. **Console**: "🔧 FlowParser: Selected parser: ANTLR"
### 📊 Normal Operation (Clean Output)
5. **Browser**: All test diagrams render as SVG elements
6. **Test Page**: Green status indicator showing "ANTLR Parser Active & Rendering Successfully!"
7. **Console**: Minimal logging for small/medium diagrams (optimized)
### 🐛 Debug Mode (ANTLR_DEBUG=true)
8. **Console**: "🎯 ANTLR Parser: Starting parse" (for complex diagrams)
9. **Console**: "🎯 ANTLR Parser: Creating visitor" (or "Creating listener")
10. **Console**: Detailed performance breakdowns and timing information
## 🚨 Troubleshooting
### **Build & Generation Issues**
1. **Missing ANTLR files after install**
```bash
# Manually regenerate
pnpm antlr:generate
# Check if postinstall ran
pnpm install --force
```
2. **Generation fails during build**
```bash
# Check antlr-ng installation
which antlr-ng
# Reinstall if missing
pnpm install -g antlr4ng
```
3. **No grammar files found**
- Ensure `.g4` files are in correct location: `src/diagrams/*/parser/antlr/*.g4`
- Check file naming convention: `*Lexer.g4`, `*Parser.g4`
- Verify you're running from correct directory
4. **Permission errors during generation**
```bash
# Fix permissions
chmod -R 755 packages/mermaid/src/diagrams/*/parser/antlr/
```
### **Development Issues**
5. **ANTLR parser not being used**: Check environment variable `USE_ANTLR_PARSER=true`
6. **Environment variable not set**: Use `pnpm dev:antlr` instead of `pnpm dev`
7. **Diagrams not rendering**: Check browser console for parsing errors
8. **Watch not working**:
- For dev server: Restart with `pnpm dev:antlr`
- For grammar development: Use `pnpm antlr:watch` instead
### **Grammar Issues**
9. **ANTLR generation warnings**
- Check grammar file syntax with ANTLR tools
- Compare with working examples in existing diagrams
- Warnings are usually non-fatal but should be addressed
10. **Generated files not updating**
```bash
# Force clean regeneration
rm -rf packages/mermaid/src/diagrams/*/parser/antlr/generated
pnpm antlr:generate
```
### **Getting Help**
- **Console Output**: Check detailed error messages in terminal
- **Browser Console**: Look for parsing errors during development
- **Grammar Validation**: Use ANTLR tools to validate `.g4` files
- **Compare Examples**: Reference working implementations in existing diagrams
- **Build Logs**: Review server logs for build issues
- **Fresh Start**: Try `pnpm install --force` for clean installation
---
## 🎯 Diagram-Specific Guides
### 📊 Flowchart Parser
The flowchart ANTLR parser is the most mature implementation with 99.1% test compatibility.
#### **Key Features**
- **939/948 tests passing** (99.1% compatibility)
- **Dual-pattern architecture** (Listener/Visitor)
- **Performance optimized** (15% improvement)
- **Complex shape support** (trapezoids, ellipses, etc.)
- **Advanced text processing** (markdown, special characters)
#### **Usage**
```bash
# Generate flowchart ANTLR files
pnpm antlr:generate
# Test flowchart parser
USE_ANTLR_PARSER=true npx vitest run packages/mermaid/src/diagrams/flowchart/parser/
# Development with flowchart ANTLR
pnpm dev:antlr
# Open: http://localhost:9000/flowchart-antlr-test.html
```
#### **Architecture**
- `FlowchartParserCore.ts` - Shared parsing logic
- `FlowchartListener.ts` - Event-driven pattern
- `FlowchartVisitor.ts` - Pull-based pattern (default)
### 🔄 Sequence Parser
The sequence ANTLR parser achieves 100% test compatibility with perfect Jison parser matching.
#### **Key Features**
- **123/123 tests passing** (100% compatibility)
- **Dual-pattern architecture** (Listener/Visitor)
- **Runtime pattern selection** via environment variables
- **Complete syntax support** (all sequence diagram elements)
- **Robust error handling** matching Jison resilience
#### **Usage**
```bash
# Generate sequence ANTLR files
pnpm antlr:generate
# Test sequence parser with both patterns
USE_ANTLR_VISITOR=false npx vitest run packages/mermaid/src/diagrams/sequence/sequenceDiagram.spec.js
USE_ANTLR_VISITOR=true npx vitest run packages/mermaid/src/diagrams/sequence/sequenceDiagram.spec.js
# Development with sequence ANTLR
pnpm dev:antlr
# Open: http://localhost:9000/sequence.html
```
#### **Architecture**
- `SequenceParserCore.ts` - Shared parsing logic (100% compatible)
- `SequenceListener.ts` - Event-driven pattern
- `SequenceVisitor.ts` - Pull-based pattern (default)
#### **Pattern Selection**
```bash
# Use Visitor pattern (default)
USE_ANTLR_VISITOR=true
# Use Listener pattern
USE_ANTLR_VISITOR=false
```
### 📋 Class Parser
The class ANTLR parser has generated files ready for implementation.
#### **Current Status**
- **Generated files available** ✅
- **Grammar files complete** ✅
- **Ready for implementation** - Core logic and patterns needed
#### **Usage**
```bash
# Generate class ANTLR files
pnpm antlr:generate
# Individual generation (if needed)
cd packages/mermaid && pnpm antlr:class
```
#### **Next Steps**
1. Implement `ClassParserCore.ts` with parsing logic
2. Create `ClassListener.ts` and `ClassVisitor.ts` pattern implementations
3. Update main parser to use ANTLR with pattern selection
4. Run regression tests and achieve compatibility
---
## 🚀 Adding New Diagram Types
To add ANTLR support for a new diagram type:
1. **Create Grammar Files**
```
packages/mermaid/src/diagrams/[diagram]/parser/antlr/
├── [Diagram]Lexer.g4
└── [Diagram]Parser.g4
```
2. **Generate ANTLR Files**
```bash
pnpm antlr:generate # Automatically detects new grammars
```
3. **Implement Architecture**
- Create `[Diagram]ParserCore.ts` with shared logic
- Create `[Diagram]Listener.ts` extending core
- Create `[Diagram]Visitor.ts` extending core
- Update main parser with pattern selection
4. **Test and Validate**
- Run regression tests
- Achieve high compatibility with existing Jison parser
- Validate both Listener and Visitor patterns
The generic ANTLR generation system will automatically handle the new diagram type!
---
## 🎯 Generic ANTLR Generation System
### **How It Works**
#### 1. **Auto-Discovery**
The script automatically finds all `.g4` files in:
```
packages/mermaid/src/diagrams/*/parser/antlr/*.g4
```
#### 2. **Grammar Pairing**
For each diagram, it looks for:
- `*Lexer.g4` - Lexical analyzer grammar
- `*Parser.g4` - Parser grammar
#### 3. **Generation Process**
For each valid grammar pair:
1. Clean the `generated/` directory
2. Create the directory if needed
3. Run `antlr-ng` with TypeScript target
4. Generate all necessary files
#### 4. **Generated Files**
Each diagram gets these generated files:
- `*Lexer.ts` - Lexer implementation
- `*Parser.ts` - Parser implementation
- `*ParserListener.ts` - Listener interface
- `*ParserVisitor.ts` - Visitor interface
- `*.tokens` - Token definitions
- `*.interp` - ANTLR interpreter files
### **Supported Diagrams**
| Diagram Type | Grammar Files | Generated Location |
| ------------- | --------------------------------------- | ----------------------------------------------------------------- |
| **Flowchart** | `FlowLexer.g4`, `FlowParser.g4` | `packages/mermaid/src/diagrams/flowchart/parser/antlr/generated/` |
| **Sequence** | `SequenceLexer.g4`, `SequenceParser.g4` | `packages/mermaid/src/diagrams/sequence/parser/antlr/generated/` |
| **Class** | `ClassLexer.g4`, `ClassParser.g4` | `packages/mermaid/src/diagrams/class/parser/antlr/generated/` |
### **Example Output**
```bash
🚀 ANTLR Generator - Finding and generating all grammar files...
📋 Found 3 diagram(s) with ANTLR grammars:
• class
• flowchart
• sequence
🎯 Generating ANTLR files for class diagram...
Lexer: ClassLexer.g4
Parser: ClassParser.g4
Output: packages/mermaid/src/diagrams/class/parser/antlr/generated
✅ Successfully generated ANTLR files for class
🎯 Generating ANTLR files for flowchart diagram...
Lexer: FlowLexer.g4
Parser: FlowParser.g4
Output: packages/mermaid/src/diagrams/flowchart/parser/antlr/generated
✅ Successfully generated ANTLR files for flowchart
🎯 Generating ANTLR files for sequence diagram...
Lexer: SequenceLexer.g4
Parser: SequenceParser.g4
Output: packages/mermaid/src/diagrams/sequence/parser/antlr/generated
✅ Successfully generated ANTLR files for sequence
📊 Generation Summary:
✅ Successful: 3
❌ Failed: 0
📁 Total: 3
🎉 All ANTLR files generated successfully!
```
### **Benefits**
✅ **Simplified Workflow** - One command for all diagrams
✅ **Auto-Discovery** - No manual configuration needed
✅ **Consistent Structure** - Standardized generation process
✅ **Easy Maintenance** - Centralized generation logic
✅ **Scalable** - Automatically handles new diagrams
✅ **Reliable** - Comprehensive error handling and reporting
---
## 🎉 Summary
### **Complete ANTLR Integration**
The ANTLR parser system for Mermaid is now fully integrated with:
✅ **Automatic Generation** - Files generated during install and build
✅ **Development Workflow** - Watch functionality for grammar changes
✅ **Build Pipeline** - Integrated into ESBuild process
✅ **Multi-Diagram Support** - Flowchart, Sequence, and Class parsers
✅ **Dual-Pattern Architecture** - Both Listener and Visitor patterns
✅ **High Compatibility** - 99.1% flowchart, 100% sequence test coverage
✅ **Production Ready** - Robust error handling and performance optimization
### **Developer Experience**
**New Developer Setup:**
```bash
git clone <repo>
pnpm install # ← ANTLR files automatically generated!
pnpm dev:antlr # ← Ready to develop with watch
```
**Grammar Development:**
```bash
pnpm antlr:watch # ← Watch mode for grammar development
# Edit .g4 files → Automatic regeneration!
# OR with full dev server
pnpm dev:antlr # ← Start development server
# Edit .g4 files → Automatic regeneration + rebuild!
```
**Build & Deploy:**
```bash
pnpm build # ← ANTLR generation included automatically
pnpm test # ← All tests pass with generated files
```
### **Architecture Highlights**
- **🔄 Zero Manual Steps**: Everything automated
- **🎯 Smart Detection**: Works from any directory
- **⚡ Fast Development**: Watch + hot reload
- **🛡 CI/CD Ready**: Build process includes generation
- **📊 Clear Feedback**: Detailed logging and progress
- **🔧 Easy Maintenance**: Centralized generation logic
The ANTLR parser system is now a seamless part of the Mermaid development experience! 🚀

View File

@@ -6,6 +6,7 @@ interface CypressConfig {
listUrl?: boolean;
listId?: string;
name?: string;
screenshot?: boolean;
}
type CypressMermaidConfig = MermaidConfig & CypressConfig;
@@ -90,7 +91,7 @@ export const renderGraph = (
export const openURLAndVerifyRendering = (
url: string,
options: CypressMermaidConfig,
{ screenshot = true, ...options }: CypressMermaidConfig,
validation?: any
): void => {
const name: string = (options.name ?? cy.state('runnable').fullTitle()).replace(/\s+/g, '-');
@@ -103,7 +104,9 @@ export const openURLAndVerifyRendering = (
cy.get('svg').should(validation);
}
verifyScreenshot(name);
if (screenshot) {
verifyScreenshot(name);
}
};
export const verifyScreenshot = (name: string): void => {

View File

@@ -369,4 +369,92 @@ ORDER ||--|{ LINE-ITEM : contains
);
});
});
describe('Special characters and numbers syntax', () => {
it('should render ER diagram with numeric entity names', () => {
imgSnapshotTest(
`
erDiagram
1 ||--|| ORDER : places
ORDER ||--|{ 2 : contains
2 ||--o{ 3.5 : references
`,
{ logLevel: 1 }
);
});
it('should render ER diagram with "u" character in entity names and cardinality', () => {
imgSnapshotTest(
`
erDiagram
CUSTOMER ||--|| u : has
u ||--|| ORDER : places
PROJECT u--o{ TEAM_MEMBER : "parent"
`,
{ logLevel: 1 }
);
});
it('should render ER diagram with decimal numbers in relationships', () => {
imgSnapshotTest(
`
erDiagram
2.5 ||--|| 1.5 : has
CUSTOMER ||--o{ 3.14 : references
1.0 ||--|{ ORDER : contains
`,
{ logLevel: 1 }
);
});
it('should render ER diagram with numeric entity names and attributes', () => {
imgSnapshotTest(
`
erDiagram
1 {
string name
int value
}
1 ||--|| ORDER : places
ORDER {
float price
string description
}
`,
{ logLevel: 1 }
);
});
it('should render complex ER diagram with mixed special entity names', () => {
imgSnapshotTest(
`
erDiagram
CUSTOMER ||--o{ 1 : places
1 ||--|{ u : contains
1.5
u ||--|| 2.5 : processes
2.5 {
string id
float value
}
u {
varchar(50) name
int count
}
`,
{ logLevel: 1 }
);
});
it('should render ER diagram with numeric entity names and attributes', () => {
imgSnapshotTest(
`erDiagram
PRODUCT ||--o{ ORDER-ITEM : has
1.5
u
1
`,
{ logLevel: 1 }
);
});
});
});

View File

@@ -1029,4 +1029,19 @@ graph TD
}
);
});
it('FDH49: should add edge animation', () => {
renderGraph(
`
flowchart TD
A(["Start"]) L_A_B_0@--> B{"Decision"}
B --> C["Option A"] & D["Option B"]
style C stroke-width:4px,stroke-dasharray: 5
L_A_B_0@{ animation: slow }
L_B_D_0@{ animation: fast }`,
{ look: 'handDrawn', screenshot: false }
);
cy.get('path#L_A_B_0').should('have.class', 'edge-animation-slow');
cy.get('path#L_B_D_0').should('have.class', 'edge-animation-fast');
});
});

View File

@@ -774,6 +774,21 @@ describe('Graph', () => {
expect(svg).to.not.have.attr('style');
});
});
it('40: should add edge animation', () => {
renderGraph(
`
flowchart TD
A(["Start"]) L_A_B_0@--> B{"Decision"}
B --> C["Option A"] & D["Option B"]
style C stroke-width:4px,stroke-dasharray: 5
L_A_B_0@{ animation: slow }
L_B_D_0@{ animation: fast }`,
{ screenshot: false }
);
// Verify animation classes are applied to both edges
cy.get('path#L_A_B_0').should('have.class', 'edge-animation-slow');
cy.get('path#L_B_D_0').should('have.class', 'edge-animation-fast');
});
it('58: handle styling with style expressions', () => {
imgSnapshotTest(
`
@@ -973,4 +988,19 @@ graph TD
}
);
});
it('70: should render a subgraph with direction TD', () => {
imgSnapshotTest(
`
flowchart LR
subgraph A
direction TD
a --> b
end
`,
{
fontFamily: 'courier',
}
);
});
});

View File

@@ -803,4 +803,34 @@ describe('Gantt diagram', () => {
{}
);
});
it('should handle numeric timestamps with dateFormat x', () => {
imgSnapshotTest(
`
gantt
title Process time profile (ms)
dateFormat x
axisFormat %L
tickInterval 250millisecond
section Pipeline
Parse JSON p1: 000, 120
`,
{}
);
});
it('should handle numeric timestamps with dateFormat X', () => {
imgSnapshotTest(
`
gantt
title Process time profile (ms)
dateFormat X
axisFormat %L
tickInterval 250millisecond
section Pipeline
Parse JSON p1: 000, 120
`,
{}
);
});
});

View File

@@ -655,5 +655,126 @@ describe('Sequence Diagram Special Cases', () => {
expect(svg).to.not.have.attr('style');
});
});
describe('Central Connection Rendering Tests', () => {
it('should render central connection circles on actor vertical lines', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
participant Bob
participant Charlie
Alice ()->>() Bob: Central connection
Bob ()-->> Charlie: Reverse central connection
Charlie ()<<-->>() Alice: Dual central connection`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
it('should render central connections with different arrow types', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
participant Bob
Alice ()->>() Bob: Solid open arrow
Alice ()-->>() Bob: Dotted open arrow
Alice ()-x() Bob: Solid cross
Alice ()--x() Bob: Dotted cross
Alice ()->() Bob: Solid arrow`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
it('should render central connections with bidirectional arrows', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
participant Bob
Alice ()<<->>() Bob: Bidirectional solid
Alice ()<<-->>() Bob: Bidirectional dotted`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
it('should render central connections with activations', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
participant Bob
participant Charlie
Alice ()->>() Bob: Activate Bob
activate Bob
Bob ()-->> Charlie: Message to Charlie
Bob ()->>() Alice: Response to Alice
deactivate Bob`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
it('should render central connections mixed with normal messages', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
participant Bob
participant Charlie
Alice ->> Bob: Normal message
Bob ()->>() Charlie: Central connection
Charlie -->> Alice: Normal dotted message
Alice ()<<-->>() Bob: Dual central connection
Bob -x Charlie: Normal cross message`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
it('should render central connections with notes', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
participant Bob
participant Charlie
Alice ()->>() Bob: Central connection
Note over Alice,Bob: Central connection note
Bob ()-->> Charlie: Reverse central connection
Note right of Charlie: Response note
Charlie ()<<-->>() Alice: Dual central connection`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
it('should render central connections with loops and alternatives', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
participant Bob
participant Charlie
loop Every minute
Alice ()->>() Bob: Central heartbeat
Bob ()-->> Charlie: Forward heartbeat
end
alt Success
Charlie ()<<-->>() Alice: Success response
else Failure
Charlie ()-x() Alice: Failure response
end`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
it('should render central connections with different participant types', () => {
imgSnapshotTest(
`sequenceDiagram
participant Alice
actor Bob
participant Charlie@{"type":"boundary"}
participant David@{"type":"control"}
participant Eve@{"type":"entity"}
Alice ()->>() Bob: To actor
Bob ()-->> Charlie: To boundary
Charlie ()->>() David: To control
David ()<<-->>() Eve: To entity
Eve ()-x() Alice: Back to participant`,
{ look: 'classic', sequence: { diagramMarginX: 50, diagramMarginY: 10 } }
);
});
});
});
});

View File

@@ -1053,4 +1053,167 @@ describe('Sequence diagram', () => {
]);
});
});
describe('render new arrow type', () => {
it('should render Solid half arrow top', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice -|\\ John: Hello John, how are you?
Alice-|\\ John: Hi Alice, I can hear you!
Alice -|\\ John: Test
`
);
});
it('should render Solid half arrow bottom', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice-|/John: Hello John, how are you?
Alice-|/John: Hi Alice, I can hear you!
Alice-|/John: Test
`
);
});
it('should render Stick half arrow top ', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice-\\\\John: Hello John, how are you?
Alice-\\\\John: Hi Alice, I can hear you!
Alice-\\\\John: Test
`
);
});
it('should render Stick half arrow bottom ', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice-//John: Hello John, how are you?
Alice-//John: Hi Alice, I can hear you!
Alice-//John: Test
`
);
});
it('should render Solid half arrow top reverse ', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice/|-John: Hello Alice, how are you?
Alice/|-John: Hi Alice, I can hear you!
Alice/|-John: Test
`
);
});
it('should render Solid half arrow bottom reverse ', () => {
imgSnapshotTest(
`sequenceDiagram
Alice \\|- John: Hello Alice, how are you?
Alice \\|- John: Hi Alice, I can hear you!
Alice \\|- John: Test`
);
});
it('should render Stick half arrow top reverse ', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice //-John: Hello Alice, how are you?
Alice //-John: Hi Alice, I can hear you!
Alice //-John: Test`
);
});
it('should render Stick half arrow bottom reverse ', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice \\\\-John: Hello Alice, how are you?
Alice \\\\-John: Hi Alice, I can hear you!
Alice \\\\-John: Test`
);
});
it('should render Solid half arrow top dotted', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice --|\\John: Hello John, how are you?
Alice --|\\John: Hi Alice, I can hear you!
Alice --|\\John: Test`
);
});
it('should render Solid half arrow bottom dotted', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice --|/John: Hello John, how are you?
Alice --|/John: Hi Alice, I can hear you!
Alice --|/John: Test`
);
});
it('should render Stick half arrow top dotted', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice--\\\\John: Hello John, how are you?
Alice--\\\\John: Hi Alice, I can hear you!
Alice--\\\\John: Test`
);
});
it('should render Stick half arrow bottom dotted', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice--//John: Hello John, how are you?
Alice--//John: Hi Alice, I can hear you!
Alice--//John: Test`
);
});
it('should render Solid half arrow top reverse dotted', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice/|--John: Hello Alice, how are you?
Alice/|--John: Hi Alice, I can hear you!
Alice/|--John: Test`
);
});
it('should render Solid half arrow bottom reverse dotted', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice\\|--John: Hello Alice, how are you?
Alice\\|--John: Hi Alice, I can hear you!
Alice\\|--John: Test`
);
});
it('should render Stick half arrow top reverse dotted ', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice//--John: Hello Alice, how are you?
Alice//--John: Hi Alice, I can hear you!
Alice//--John: Test`
);
});
it('should render Stick half arrow bottom reverse dotted ', () => {
imgSnapshotTest(
`
sequenceDiagram
Alice\\\\--John: Hello Alice, how are you?
Alice\\\\--John: Hi Alice, I can hear you!
Alice\\\\--John: Test`
);
});
});
});

View File

@@ -110,6 +110,48 @@
config:
layout: elk
---
mindmap
root((mindmap))
Origins
Long history
::icon(fa fa-book)
Popularisation
British popular psychology author Tony Buzan
Research
On effectiveness&lt;br/>and features
On Automatic creation
Uses
Creative techniques
Strategic planning
Argument mapping
Tools
id)I am a cloud(
id))I am a bang((
Tools
</pre>
<pre id="diagram4" class="mermaid">
---
config:
layout: elk
---
flowchart
aid0
</pre
>
<pre id="diagram4" class="mermaid">
---
config:
layout: elk
---
mindmap
aid0
</pre>
<pre id="diagram4" class="mermaid">
---
config:
layout: ogdc
---
flowchart-elk TB
c1-->a2
subgraph one

View File

@@ -603,6 +603,10 @@
</div>
<div class="test">
<pre class="mermaid">
---
config:
theme: dark
---
classDiagram
test ()--() test2
</pre>

View File

@@ -2,7 +2,7 @@
"compilerOptions": {
"target": "es2020",
"lib": ["es2020", "dom"],
"types": ["cypress", "node", "@argos-ci/cypress/dist/support.d.ts"],
"types": ["cypress", "node", "@argos-ci/cypress/support"],
"allowImportingTsExtensions": true,
"noEmit": true
},

View File

@@ -1,59 +0,0 @@
import { execSync } from 'child_process';
console.log('=== DEBUGGING CALLBACK ARGUMENTS ===');
// Test the specific failing case
const testInput = 'graph TD\nA-->B\nclick A call callback("test0", test1, test2)';
console.log('Test input:', testInput);
// Create a temporary test file to debug the ANTLR parser
import fs from 'fs';
const testFile = `
// Debug callback arguments parsing
process.env.USE_ANTLR_PARSER = 'true';
const flow = require('./packages/mermaid/src/diagrams/flowchart/flowDb.ts');
const parser = require('./packages/mermaid/src/diagrams/flowchart/parser/antlr/antlr-parser.ts');
console.log('Testing callback arguments parsing...');
// Mock the setClickEvent to see what parameters it receives
const originalSetClickEvent = flow.default.setClickEvent;
flow.default.setClickEvent = function(...args) {
console.log('DEBUG setClickEvent called with args:', args);
console.log(' - nodeId:', args[0]);
console.log(' - functionName:', args[1]);
console.log(' - functionArgs:', args[2]);
console.log(' - args.length:', args.length);
return originalSetClickEvent.apply(this, args);
};
try {
const result = parser.parse('${testInput}');
console.log('Parse completed successfully');
} catch (error) {
console.log('Parse error:', error.message);
}
`;
fs.writeFileSync('debug-callback-test.js', testFile);
try {
const result = execSync('node debug-callback-test.js', {
cwd: '/Users/ashishjain/projects/mermaid',
encoding: 'utf8',
timeout: 10000,
});
console.log('Result:', result);
} catch (error) {
console.log('Error:', error.message);
if (error.stdout) console.log('Stdout:', error.stdout);
if (error.stderr) console.log('Stderr:', error.stderr);
}
// Clean up
try {
fs.unlinkSync('debug-callback-test.js');
} catch (e) {
// Ignore cleanup errors
}

View File

@@ -1,22 +0,0 @@
// Debug script to understand node processing order
console.log('=== Node Order Debug ===');
// Test case 1: n2["label for n2"] & n4@{ label: "label for n4"} & n5@{ label: "label for n5"}
// Expected: nodes[0] = n2, nodes[1] = n4, nodes[2] = n5
// Actual: nodes[0] = n4 (wrong!)
console.log('Test 1: n2["label for n2"] & n4@{ label: "label for n4"} & n5@{ label: "label for n5"}');
console.log('Expected: n2, n4, n5');
console.log('Actual: n4, ?, ?');
// Test case 2: A["A"] --> B["for B"] & C@{ label: "for c"} & E@{label : "for E"}
// Expected: nodes[1] = B, nodes[2] = C
// Actual: nodes[1] = C (wrong!)
console.log('\nTest 2: A["A"] --> B["for B"] & C@{ label: "for c"} & E@{label : "for E"}');
console.log('Expected: A, B, C, E, D');
console.log('Actual: A, C, ?, ?, ?');
console.log('\nThe issue appears to be that ampersand-chained nodes are processed in reverse order');
console.log('or the node collection is not matching the Jison parser behavior.');

View File

@@ -1,331 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Mermaid Class ANTLR Parser Test Page</title>
<link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgo=" />
<style>
body {
font-family: 'Courier New', Courier, monospace;
margin: 20px;
background-color: #f5f5f5;
}
.test-section {
background: white;
padding: 20px;
margin: 20px 0;
border-radius: 8px;
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
}
.parser-info {
background: #e3f2fd;
border: 1px solid #2196f3;
padding: 15px;
border-radius: 5px;
margin-bottom: 20px;
}
.success {
background: #e8f5e8;
border: 1px solid #4caf50;
}
.error {
background: #ffebee;
border: 1px solid #f44336;
}
.broken {
background: #fff3e0;
border: 1px solid #ff9800;
}
div.mermaid {
font-family: 'Courier New', Courier, monospace !important;
}
h1 {
color: #1976d2;
}
h2 {
color: #424242;
border-bottom: 2px solid #e0e0e0;
padding-bottom: 5px;
}
#debug-logs {
border: 1px solid #ccc;
padding: 10px;
margin: 10px 0;
max-height: 400px;
overflow-y: auto;
font-family: monospace;
font-size: 12px;
background: #f9f9f9;
}
.diagram-code {
background: #f5f5f5;
border: 1px solid #ddd;
padding: 10px;
margin: 10px 0;
font-family: monospace;
white-space: pre-wrap;
}
</style>
</head>
<body>
<h1>🎯 Mermaid Class ANTLR Parser Test Page</h1>
<div class="parser-info">
<h3>🔧 Parser Information</h3>
<p><strong>Environment Variable:</strong> <code id="env-var">Loading...</code></p>
<p><strong>Expected:</strong> <code>USE_ANTLR_PARSER=true</code></p>
<p><strong>Status:</strong> <span id="parser-status">Checking...</span></p>
</div>
<div class="test-section">
<h2>Test 1: Simple Class Diagram</h2>
<p>Basic class diagram to test ANTLR parser functionality:</p>
<pre class="mermaid">
classDiagram
class Animal {
+name: string
+age: int
+makeSound()
}
</pre>
</div>
<div class="test-section">
<h2>Test 2: Class with Relationships</h2>
<p>Testing class relationships:</p>
<pre class="mermaid">
classDiagram
class Animal {
+name: string
+makeSound()
}
class Dog {
+breed: string
+bark()
}
Animal <|-- Dog
</pre>
</div>
<div class="test-section broken">
<h2>🚨 Test 3: BROKEN DIAGRAM - Debug Target</h2>
<p><strong>This is the problematic diagram that needs debugging:</strong></p>
<div class="diagram-code">classDiagram
class Person {
+ID : Guid
+FirstName : string
+LastName : string
-privateProperty : string
#ProtectedProperty : string
~InternalProperty : string
~AnotherInternalProperty : List~List~string~~
}
class People List~List~Person~~</div>
<p><strong>Expected Error:</strong> Parse error on line 11: Expecting 'STR'</p>
<pre class="mermaid">
classDiagram
class Person {
+ID : Guid
+FirstName : string
+LastName : string
-privateProperty : string
#ProtectedProperty : string
~InternalProperty : string
~AnotherInternalProperty : List~List~string~~
}
class People List~List~Person~~
</pre>
</div>
<div class="test-section">
<h2>Test 4: Generic Types (Simplified)</h2>
<p>Testing simpler generic type syntax:</p>
<pre class="mermaid">
classDiagram
class Person {
+ID : Guid
+FirstName : string
+LastName : string
}
class People {
+items : List~Person~
}
</pre>
</div>
<div class="test-section">
<h2>Test 5: Visibility Modifiers</h2>
<p>Testing different visibility modifiers:</p>
<pre class="mermaid">
classDiagram
class TestClass {
+publicField : string
-privateField : string
#protectedField : string
~packageField : string
+publicMethod()
-privateMethod()
#protectedMethod()
~packageMethod()
}
</pre>
</div>
<script type="module">
import mermaid from './mermaid.esm.mjs';
// Configure ANTLR parser for browser environment
window.MERMAID_CONFIG = {
USE_ANTLR_PARSER: 'true',
USE_ANTLR_VISITOR: 'false', // Use listener pattern
ANTLR_DEBUG: 'true'
};
console.log('🎯 Class ANTLR Configuration:', window.MERMAID_CONFIG);
// Override console methods to capture logs
const originalLog = console.log;
const originalError = console.error;
function createLogDiv() {
const logDiv = document.createElement('div');
logDiv.id = 'debug-logs';
logDiv.innerHTML = '<h3>🔍 Debug Logs:</h3>';
document.body.appendChild(logDiv);
return logDiv;
}
console.log = function (...args) {
originalLog.apply(console, args);
// Display important logs on page
if (args[0] && typeof args[0] === 'string' && (
args[0].includes('ANTLR') ||
args[0].includes('ClassDB:') ||
args[0].includes('ClassListener:') ||
args[0].includes('ClassVisitor:') ||
args[0].includes('ClassParserCore:') ||
args[0].includes('Class ANTLR') ||
args[0].includes('🔧') ||
args[0].includes('❌') ||
args[0].includes('✅')
)) {
const logDiv = document.getElementById('debug-logs') || createLogDiv();
logDiv.innerHTML += '<div style="color: blue; margin: 2px 0;">' + args.join(' ') + '</div>';
}
};
console.error = function (...args) {
originalError.apply(console, args);
const logDiv = document.getElementById('debug-logs') || createLogDiv();
logDiv.innerHTML += '<div style="color: red; margin: 2px 0;">ERROR: ' + args.join(' ') + '</div>';
};
// Initialize mermaid
mermaid.initialize({
theme: 'default',
logLevel: 3,
securityLevel: 'loose',
class: {
titleTopMargin: 25,
diagramPadding: 50,
htmlLabels: false
},
});
// Check environment and parser status
let envVar = 'undefined';
try {
if (typeof process !== 'undefined' && process.env) {
envVar = process.env.USE_ANTLR_PARSER || 'undefined';
}
} catch (e) {
envVar = 'browser-default';
}
const envElement = document.getElementById('env-var');
const statusElement = document.getElementById('parser-status');
if (envElement) {
envElement.textContent = `USE_ANTLR_PARSER=${envVar || 'undefined'}`;
}
// Check for debug information from parser
setTimeout(() => {
if (window.MERMAID_PARSER_DEBUG) {
console.log('🔍 Found MERMAID_PARSER_DEBUG:', window.MERMAID_PARSER_DEBUG);
const debug = window.MERMAID_PARSER_DEBUG;
if (envElement) {
envElement.textContent = `USE_ANTLR_PARSER=${debug.env_value || 'undefined'} (actual: ${debug.USE_ANTLR_PARSER})`;
}
if (statusElement) {
if (debug.USE_ANTLR_PARSER) {
statusElement.innerHTML = '<span style="color: green;">✅ ANTLR Parser Active</span>';
statusElement.parentElement.parentElement.classList.add('success');
} else {
statusElement.innerHTML = '<span style="color: orange;">⚠️ Jison Parser (Default)</span>';
}
}
}
}, 1000);
if (statusElement) {
if (envVar === 'true') {
statusElement.innerHTML = '<span style="color: green;">✅ ANTLR Parser Active</span>';
statusElement.parentElement.parentElement.classList.add('success');
} else {
statusElement.innerHTML = '<span style="color: orange;">⚠️ Jison Parser (Default)</span>';
}
}
// Add debugging
console.log('🎯 Class ANTLR Parser Test Page Loaded');
console.log('🔧 Environment:', { USE_ANTLR_PARSER: envVar });
// Test if we can detect which parser is being used
setTimeout(() => {
const mermaidElements = document.querySelectorAll('.mermaid');
console.log(`📊 Found ${mermaidElements.length} class diagrams`);
// Check if diagrams rendered successfully
const renderedElements = document.querySelectorAll('.mermaid svg');
if (renderedElements.length > 0) {
console.log('✅ Class diagrams rendered successfully!');
console.log(`📈 ${renderedElements.length} SVG elements created`);
// Update status on page
const statusElement = document.getElementById('parser-status');
if (statusElement && envVar === 'true') {
statusElement.innerHTML = '<span style="color: green;">✅ ANTLR Parser Active & Rendering Successfully!</span>';
}
} else {
console.log('❌ No SVG elements found - check for rendering errors');
console.log('🔍 Checking for error messages...');
// Look for error messages in mermaid elements
mermaidElements.forEach((element, index) => {
console.log(`📋 Class Diagram ${index + 1} content:`, element.textContent.trim());
if (element.innerHTML.includes('error') || element.innerHTML.includes('Error')) {
console.log(`❌ Error found in class diagram ${index + 1}:`, element.innerHTML);
}
});
}
}, 3000);
</script>
</body>
</html>

View File

@@ -11,7 +11,7 @@
rel="stylesheet"
/>
<link
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.2/css/all.min.css"
rel="stylesheet"
/>
<link

View File

@@ -1,269 +0,0 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Mermaid ANTLR Parser Test Page</title>
<link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgo=" />
<style>
body {
font-family: 'Courier New', Courier, monospace;
margin: 20px;
background-color: #f5f5f5;
}
.test-section {
background: white;
padding: 20px;
margin: 20px 0;
border-radius: 8px;
box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
}
.parser-info {
background: #e3f2fd;
border: 1px solid #2196f3;
padding: 15px;
border-radius: 5px;
margin-bottom: 20px;
}
.success {
background: #e8f5e8;
border: 1px solid #4caf50;
}
.error {
background: #ffebee;
border: 1px solid #f44336;
}
div.mermaid {
font-family: 'Courier New', Courier, monospace !important;
}
h1 {
color: #1976d2;
}
h2 {
color: #424242;
border-bottom: 2px solid #e0e0e0;
padding-bottom: 5px;
}
</style>
</head>
<body>
<h1>🎯 Mermaid ANTLR Parser Test Page</h1>
<div class="parser-info">
<h3>🔧 Parser Information</h3>
<p><strong>Environment Variable:</strong> <code id="env-var">Loading...</code></p>
<p><strong>Expected:</strong> <code>USE_ANTLR_PARSER=true</code></p>
<p><strong>Status:</strong> <span id="parser-status">Checking...</span></p>
</div>
<div class="test-section">
<h2>Test 1: Basic Flowchart</h2>
<p>Simple flowchart to test basic ANTLR parser functionality:</p>
<pre class="mermaid">
flowchart TD
A[Start] --> B[End]
</pre>
</div>
<div class="test-section">
<h2>Test 4: Complex Shapes with Text</h2>
<p>Testing various node shapes with complex text content:</p>
<pre class="mermaid">
flowchart LR
A(Round Node) --> B{Diamond}
B --> C([Stadium])
C --> D[[Subroutine]]
D --> E[(Database)]
E --> F((Circle))
F --> G[/Parallelogram/]
G --> H[\Trapezoid\]
H --> I[Mixed Text with / slash]
I --> J[\Mixed Text with \ backslash\]
</pre>
</div>
<div class="test-section">
<h2>Test 5: Classes and Styles</h2>
<p>Testing class and style processing:</p>
<pre class="mermaid">
flowchart TD
A[Node A] --> B[Node B]
B --> C[Node C]
classDef redClass fill:#ff9999,stroke:#333,stroke-width:2px
classDef blueClass fill:#9999ff,stroke:#333,stroke-width:2px
class A redClass
class B,C blueClass
</pre>
</div>
<div class="test-section">
<h2>Test 6: Subgraphs</h2>
<p>Testing subgraph processing:</p>
<pre class="mermaid">
flowchart TD
subgraph Main["Main Process"]
A[Start] --> B[Process]
end
subgraph Sub["Sub Process"]
C[Sub Start] --> D[Sub End]
end
B --> C
D --> E[Final End]
</pre>
</div>
<script type="module">
import mermaid from './mermaid.esm.mjs';
// Configure ANTLR parser for browser environment
// Since process.env is not available in browser, we set up global config
window.MERMAID_CONFIG = {
USE_ANTLR_PARSER: 'true',
USE_ANTLR_VISITOR: 'true',
ANTLR_DEBUG: 'true'
};
console.log('🎯 Browser ANTLR Configuration:', window.MERMAID_CONFIG);
// Override console methods to capture logs
const originalLog = console.log;
const originalError = console.error;
console.log = function (...args) {
originalLog.apply(console, args);
// Display important logs on page
if (args[0] && typeof args[0] === 'string' && (
args[0].includes('ANTLR Parser:') ||
args[0].includes('FlowDB:') ||
args[0].includes('FlowchartListener:')
)) {
const logDiv = document.getElementById('debug-logs') || createLogDiv();
logDiv.innerHTML += '<div style="color: blue;">' + args.join(' ') + '</div>';
}
};
console.error = function (...args) {
originalError.apply(console, args);
const logDiv = document.getElementById('debug-logs') || createLogDiv();
logDiv.innerHTML += '<div style="color: red;">ERROR: ' + args.join(' ') + '</div>';
};
function createLogDiv() {
const logDiv = document.createElement('div');
logDiv.id = 'debug-logs';
logDiv.style.cssText = 'border: 1px solid #ccc; padding: 10px; margin: 10px 0; max-height: 300px; overflow-y: auto; font-family: monospace; font-size: 12px; background: #f9f9f9;';
logDiv.innerHTML = '<h3>Debug Logs:</h3>';
document.body.appendChild(logDiv);
return logDiv;
}
// Initialize mermaid
mermaid.initialize({
theme: 'default',
logLevel: 3,
securityLevel: 'loose',
flowchart: { curve: 'basis' },
});
// Check environment and parser status
let envVar = 'undefined';
try {
if (typeof process !== 'undefined' && process.env) {
envVar = process.env.USE_ANTLR_PARSER || 'undefined';
}
} catch (e) {
// process is not defined in browser
envVar = 'browser-default';
}
const envElement = document.getElementById('env-var');
const statusElement = document.getElementById('parser-status');
if (envElement) {
envElement.textContent = `USE_ANTLR_PARSER=${envVar || 'undefined'}`;
}
// Check for debug information from parser
setTimeout(() => {
if (window.MERMAID_PARSER_DEBUG) {
console.log('🔍 Found MERMAID_PARSER_DEBUG:', window.MERMAID_PARSER_DEBUG);
const debug = window.MERMAID_PARSER_DEBUG;
if (envElement) {
envElement.textContent = `USE_ANTLR_PARSER=${debug.env_value || 'undefined'} (actual: ${debug.USE_ANTLR_PARSER})`;
}
if (statusElement) {
if (debug.USE_ANTLR_PARSER) {
statusElement.innerHTML = '<span style="color: green;">✅ ANTLR Parser Active</span>';
statusElement.parentElement.parentElement.classList.add('success');
} else {
statusElement.innerHTML = '<span style="color: orange;">⚠️ Jison Parser (Default)</span>';
}
}
} else {
console.log('❌ MERMAID_PARSER_DEBUG not found on window');
}
}, 1000);
if (statusElement) {
if (envVar === 'true') {
statusElement.innerHTML = '<span style="color: green;">✅ ANTLR Parser Active</span>';
statusElement.parentElement.parentElement.classList.add('success');
} else {
statusElement.innerHTML = '<span style="color: orange;">⚠️ Jison Parser (Default)</span>';
}
}
// Add some debugging
console.log('🎯 ANTLR Parser Test Page Loaded');
console.log('🔧 Environment:', { USE_ANTLR_PARSER: envVar });
// Test if we can detect which parser is being used
setTimeout(() => {
const mermaidElements = document.querySelectorAll('.mermaid');
console.log(`📊 Found ${mermaidElements.length} mermaid diagrams`);
// Check if diagrams rendered successfully
const renderedElements = document.querySelectorAll('.mermaid svg');
if (renderedElements.length > 0) {
console.log('✅ Diagrams rendered successfully!');
console.log(`📈 ${renderedElements.length} SVG elements created`);
// Update status on page
const statusElement = document.getElementById('parser-status');
if (statusElement && envVar === 'true') {
statusElement.innerHTML = '<span style="color: green;">✅ ANTLR Parser Active & Rendering Successfully!</span>';
}
} else {
console.log('❌ No SVG elements found - check for rendering errors');
console.log('🔍 Checking for error messages...');
// Look for error messages in mermaid elements
mermaidElements.forEach((element, index) => {
console.log(`📋 Diagram ${index + 1} content:`, element.textContent.trim());
if (element.innerHTML.includes('error') || element.innerHTML.includes('Error')) {
console.log(`❌ Error found in diagram ${index + 1}:`, element.innerHTML);
}
});
}
}, 3000);
</script>
</body>
</html>

View File

@@ -1,358 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>🚀 Hybrid Sequence Editor Test</title>
<style>
body {
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
margin: 20px;
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
color: #333;
min-height: 100vh;
}
.container {
max-width: 1200px;
margin: 0 auto;
background: white;
border-radius: 15px;
padding: 30px;
box-shadow: 0 20px 40px rgba(0,0,0,0.1);
}
h1 {
text-align: center;
color: #4a5568;
margin-bottom: 30px;
font-size: 2.5em;
}
.test-section {
margin: 30px 0;
padding: 20px;
border: 2px solid #e2e8f0;
border-radius: 10px;
background: #f8fafc;
}
.test-section h2 {
color: #2d3748;
margin-bottom: 15px;
font-size: 1.5em;
}
.controls {
display: flex;
gap: 15px;
margin-bottom: 20px;
flex-wrap: wrap;
}
button {
padding: 12px 24px;
border: none;
border-radius: 8px;
cursor: pointer;
font-weight: 600;
font-size: 14px;
transition: all 0.3s ease;
box-shadow: 0 4px 6px rgba(0,0,0,0.1);
}
.btn-primary {
background: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
color: white;
}
.btn-primary:hover {
transform: translateY(-2px);
box-shadow: 0 6px 12px rgba(0,0,0,0.15);
}
.btn-secondary {
background: #e2e8f0;
color: #4a5568;
}
.btn-secondary:hover {
background: #cbd5e0;
}
.code-block {
background: #1a202c;
color: #e2e8f0;
padding: 20px;
border-radius: 8px;
font-family: 'Courier New', monospace;
font-size: 14px;
line-height: 1.5;
overflow-x: auto;
margin: 15px 0;
white-space: pre-wrap;
}
.result-section {
margin-top: 20px;
padding: 15px;
border-radius: 8px;
background: #f0fff4;
border-left: 4px solid #48bb78;
}
.error-section {
margin-top: 20px;
padding: 15px;
border-radius: 8px;
background: #fff5f5;
border-left: 4px solid #f56565;
}
.stats {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
gap: 15px;
margin: 20px 0;
}
.stat-card {
background: white;
padding: 15px;
border-radius: 8px;
text-align: center;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
}
.stat-value {
font-size: 2em;
font-weight: bold;
color: #667eea;
}
.stat-label {
color: #718096;
font-size: 0.9em;
margin-top: 5px;
}
.operations {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
gap: 15px;
margin: 20px 0;
}
.operation-card {
background: white;
padding: 20px;
border-radius: 8px;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
}
.operation-card h3 {
margin-top: 0;
color: #4a5568;
}
input, select {
width: 100%;
padding: 8px 12px;
border: 1px solid #e2e8f0;
border-radius: 4px;
margin: 5px 0;
font-size: 14px;
}
.log-output {
background: #2d3748;
color: #e2e8f0;
padding: 15px;
border-radius: 8px;
font-family: 'Courier New', monospace;
font-size: 12px;
max-height: 300px;
overflow-y: auto;
margin: 15px 0;
}
</style>
</head>
<body>
<div class="container">
<h1>🚀 Hybrid Sequence Editor Test</h1>
<p style="text-align: center; color: #718096; font-size: 1.1em;">
Testing the new hybrid approach: AST-based editing + TokenStreamRewriter for optimal performance
</p>
<!-- Test Section 1: Basic Functionality -->
<div class="test-section">
<h2>🎯 Basic Hybrid Editor Test</h2>
<div class="controls">
<button class="btn-primary" onclick="testBasicFunctionality()">Test Basic Functionality</button>
<button class="btn-secondary" onclick="clearResults()">Clear Results</button>
</div>
<div class="code-block" id="originalCode">sequenceDiagram
Alice->>Bob: Hello Bob, how are you?
Bob-->>Alice: Great!</div>
<div id="basicResults"></div>
</div>
<!-- Test Section 2: CRUD Operations -->
<div class="test-section">
<h2>✏️ CRUD Operations Test</h2>
<div class="operations">
<div class="operation-card">
<h3>Add Participant</h3>
<input type="text" id="participantId" placeholder="Participant ID (e.g., C)" />
<input type="text" id="participantAlias" placeholder="Alias (e.g., Charlie)" />
<button class="btn-primary" onclick="addParticipant()">Add Participant</button>
</div>
<div class="operation-card">
<h3>Add Message</h3>
<input type="text" id="messageFrom" placeholder="From (e.g., Alice)" />
<input type="text" id="messageTo" placeholder="To (e.g., Bob)" />
<input type="text" id="messageText" placeholder="Message text" />
<select id="messageArrow">
<option value="->>">->></option>
<option value="-->>">-->></option>
<option value="->">-></option>
<option value="-->">--></option>
</select>
<button class="btn-primary" onclick="addMessage()">Add Message</button>
</div>
<div class="operation-card">
<h3>Add Note</h3>
<select id="notePosition">
<option value="right">right</option>
<option value="left">left</option>
<option value="over">over</option>
</select>
<input type="text" id="noteParticipant" placeholder="Participant (e.g., Bob)" />
<input type="text" id="noteText" placeholder="Note text" />
<button class="btn-primary" onclick="addNote()">Add Note</button>
</div>
<div class="operation-card">
<h3>Move Statement</h3>
<input type="number" id="moveFrom" placeholder="From index" />
<input type="number" id="moveTo" placeholder="To index" />
<button class="btn-primary" onclick="moveStatement()">Move Statement</button>
</div>
</div>
<div class="controls">
<button class="btn-primary" onclick="regenerateCode()">Regenerate Code</button>
<button class="btn-secondary" onclick="showAST()">Show AST</button>
<button class="btn-secondary" onclick="validateAST()">Validate AST</button>
</div>
<div id="crudResults"></div>
</div>
<!-- Test Section 3: Performance Comparison -->
<div class="test-section">
<h2>⚡ Performance Test</h2>
<div class="controls">
<button class="btn-primary" onclick="performanceTest()">Run Performance Test</button>
<select id="testSize">
<option value="small">Small (10 statements)</option>
<option value="medium">Medium (50 statements)</option>
<option value="large">Large (200 statements)</option>
</select>
</div>
<div id="performanceResults"></div>
</div>
<!-- Debug Log -->
<div class="test-section">
<h2>🔍 Debug Log</h2>
<div class="controls">
<button class="btn-secondary" onclick="clearLog()">Clear Log</button>
</div>
<div class="log-output" id="debugLog"></div>
</div>
</div>
<script type="module">
// This will be implemented to test the hybrid editor
console.log('🚀 Hybrid Sequence Editor Test Page Loaded');
// Global variables for testing
let hybridEditor = null;
let currentAST = null;
// Test functions will be implemented here
window.testBasicFunctionality = function() {
log('🎯 Testing basic hybrid editor functionality...');
log('⚠️ Implementation pending - hybrid editor classes need to be imported');
};
window.addParticipant = function() {
const id = document.getElementById('participantId').value;
const alias = document.getElementById('participantAlias').value;
log(`👤 Adding participant: ${id}${alias ? ` as ${alias}` : ''}`);
};
window.addMessage = function() {
const from = document.getElementById('messageFrom').value;
const to = document.getElementById('messageTo').value;
const text = document.getElementById('messageText').value;
const arrow = document.getElementById('messageArrow').value;
log(`💬 Adding message: ${from}${arrow}${to}: ${text}`);
};
window.addNote = function() {
const position = document.getElementById('notePosition').value;
const participant = document.getElementById('noteParticipant').value;
const text = document.getElementById('noteText').value;
log(`📝 Adding note: Note ${position} of ${participant}: ${text}`);
};
window.moveStatement = function() {
const from = document.getElementById('moveFrom').value;
const to = document.getElementById('moveTo').value;
log(`🔄 Moving statement from ${from} to ${to}`);
};
window.regenerateCode = function() {
log('🔄 Regenerating code from AST...');
};
window.showAST = function() {
log('🌳 Showing current AST structure...');
};
window.validateAST = function() {
log('✅ Validating AST structure...');
};
window.performanceTest = function() {
const size = document.getElementById('testSize').value;
log(`⚡ Running performance test with ${size} dataset...`);
};
window.clearResults = function() {
document.getElementById('basicResults').innerHTML = '';
document.getElementById('crudResults').innerHTML = '';
document.getElementById('performanceResults').innerHTML = '';
};
window.clearLog = function() {
document.getElementById('debugLog').innerHTML = '';
};
function log(message) {
const logElement = document.getElementById('debugLog');
const timestamp = new Date().toLocaleTimeString();
logElement.innerHTML += `[${timestamp}] ${message}\n`;
logElement.scrollTop = logElement.scrollHeight;
console.log(message);
}
</script>
</body>
</html>

File diff suppressed because it is too large Load Diff

View File

@@ -1,216 +0,0 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Simple ANTLR Parser Test</title>
<style>
body {
font-family: Arial, sans-serif;
margin: 20px;
background-color: #f5f5f5;
}
.container {
max-width: 1200px;
margin: 0 auto;
background-color: white;
padding: 20px;
border-radius: 8px;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
}
.status {
background-color: #e8f4fd;
padding: 15px;
border-radius: 5px;
margin-bottom: 20px;
border-left: 4px solid #2196F3;
}
.debug-logs {
background-color: #f8f9fa;
padding: 15px;
border-radius: 5px;
margin-bottom: 20px;
font-family: monospace;
font-size: 12px;
max-height: 300px;
overflow-y: auto;
border: 1px solid #dee2e6;
}
.test-section {
margin: 20px 0;
padding: 15px;
border: 1px solid #ddd;
border-radius: 5px;
}
.mermaid {
text-align: center;
margin: 20px 0;
}
h1 { color: #333; }
h2 { color: #666; }
</style>
</head>
<body>
<div class="container">
<h1>🧪 Simple ANTLR Parser Test</h1>
<div class="status">
<h3>Parser Status</h3>
<p><strong>Environment Variable:</strong> <span id="env-var">Loading...</span></p>
<p><strong>Parser Status:</strong> <span id="parser-status">Loading...</span></p>
<p><strong>Global Config:</strong> <span id="global-config">Loading...</span></p>
</div>
<div class="debug-logs">
<h3>Debug Logs:</h3>
<div id="debug-output">Initializing...</div>
</div>
<div class="test-section">
<h2>Test 1: Minimal Flowchart</h2>
<p>Testing the simplest possible flowchart:</p>
<pre class="mermaid">
flowchart TD
A[Start] --> B[End]
</pre>
</div>
</div>
<script type="module">
import mermaid from './mermaid.esm.mjs';
// Configure ANTLR parser for browser environment
window.MERMAID_CONFIG = {
USE_ANTLR_PARSER: 'true',
USE_ANTLR_VISITOR: 'true',
ANTLR_DEBUG: 'true'
};
// Enhanced debug logging to track down the process.env issue
const debugOutput = document.getElementById('debug-output');
const originalConsoleLog = console.log;
const originalConsoleError = console.error;
function addDebugLog(message, type = 'log') {
const timestamp = new Date().toLocaleTimeString();
const logEntry = `[${timestamp}] ${type.toUpperCase()}: ${message}`;
if (debugOutput) {
debugOutput.innerHTML += logEntry + '<br>';
debugOutput.scrollTop = debugOutput.scrollHeight;
}
// Also log to original console
if (type === 'error') {
originalConsoleError(message);
} else {
originalConsoleLog(message);
}
}
// Override console methods to capture all logs
console.log = function(...args) {
addDebugLog(args.join(' '), 'log');
};
console.error = function(...args) {
addDebugLog(args.join(' '), 'error');
};
// Add process access detection
const originalProcess = window.process;
Object.defineProperty(window, 'process', {
get: function() {
const stack = new Error().stack;
addDebugLog(`🚨 PROCESS ACCESS DETECTED! Stack trace: ${stack}`, 'error');
return originalProcess;
},
set: function(value) {
addDebugLog(`🚨 PROCESS SET DETECTED! Value: ${value}`, 'error');
window._process = value;
}
});
addDebugLog('🔧 Starting ANTLR parser test initialization');
// Check environment and parser status
let envVar = 'undefined';
try {
if (typeof process !== 'undefined' && process.env) {
envVar = process.env.USE_ANTLR_PARSER || 'undefined';
}
} catch (e) {
addDebugLog(`🔧 Process check failed (expected in browser): ${e.message}`);
envVar = 'browser-default';
}
const envElement = document.getElementById('env-var');
const statusElement = document.getElementById('parser-status');
const configElement = document.getElementById('global-config');
if (envElement) {
envElement.textContent = `USE_ANTLR_PARSER=${envVar || 'undefined'}`;
}
if (configElement) {
configElement.textContent = JSON.stringify(window.MERMAID_CONFIG);
}
addDebugLog('🔧 Initializing Mermaid with ANTLR parser');
try {
// Initialize mermaid with detailed error handling
await mermaid.initialize({
startOnLoad: false,
theme: 'default',
flowchart: {
useMaxWidth: true,
htmlLabels: true
},
suppressErrors: false, // We want to see all errors
logLevel: 'debug'
});
addDebugLog('✅ Mermaid initialized successfully');
if (statusElement) {
statusElement.textContent = '✅ ANTLR Parser Active';
statusElement.style.color = 'green';
}
addDebugLog('🎯 Starting diagram rendering');
// Render diagrams with detailed error tracking
const diagrams = document.querySelectorAll('.mermaid');
for (let i = 0; i < diagrams.length; i++) {
const diagram = diagrams[i];
addDebugLog(`🎨 Rendering diagram ${i + 1}/${diagrams.length}`);
try {
await mermaid.run({
nodes: [diagram],
suppressErrors: false
});
addDebugLog(`✅ Diagram ${i + 1} rendered successfully`);
} catch (error) {
addDebugLog(`❌ Diagram ${i + 1} failed: ${error.message}`, 'error');
addDebugLog(`❌ Stack trace: ${error.stack}`, 'error');
}
}
addDebugLog('🎉 All diagrams processed');
} catch (error) {
addDebugLog(`❌ Mermaid initialization failed: ${error.message}`, 'error');
addDebugLog(`❌ Stack trace: ${error.stack}`, 'error');
if (statusElement) {
statusElement.textContent = '❌ ANTLR Parser Failed';
statusElement.style.color = 'red';
}
}
addDebugLog('🔧 Test initialization complete');
</script>
</body>
</html>

View File

@@ -29,7 +29,8 @@ In GitHub, you first [**fork a mermaid repository**](https://github.com/mermaid-
Then you **clone** a copy to your local development machine (e.g. where you code) to make a copy with all the files to work with.
> **💡 Tip** > [Here is a GitHub document that gives an overview of the process](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
> **💡 Tip**
> [Here is a GitHub document that gives an overview of the process](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
```bash
git clone git@github.com/your-fork/mermaid

View File

@@ -33,7 +33,8 @@ mindmap
## Join the Development
> **💡 Tip** > **Check out our** [**detailed contribution guide**](./contributing.md).
> **💡 Tip**
> **Check out our** [**detailed contribution guide**](./contributing.md).
Where to start:
@@ -47,7 +48,8 @@ Where to start:
## A Question Or a Suggestion?
> **💡 Tip** > **Have a look at** [**how to open an issue**](./questions-and-suggestions.md).
> **💡 Tip**
> **Have a look at** [**how to open an issue**](./questions-and-suggestions.md).
If you have faced a vulnerability [report it to us](./security.md).

View File

@@ -22,7 +22,6 @@ While directives allow you to change most of the default configuration settings,
Mermaid basically supports two types of configuration options to be overridden by directives.
1. _General/Top Level configurations_ : These are the configurations that are available and applied to all the diagram. **Some of the most important top-level** configurations are:
- theme
- fontFamily
- logLevel

View File

@@ -29,7 +29,6 @@ Try the Ultimate AI, Mermaid, and Visual Diagramming Suite by creating an accoun
- **Plugins** - A plugin system for extending the functionality of Mermaid.
Official Mermaid Chart plugins:
- [Mermaid Chart GPT](https://chatgpt.com/g/g-684cc36f30208191b21383b88650a45d-mermaid-chart-diagrams-and-charts)
- [Confluence](https://marketplace.atlassian.com/apps/1234056/mermaid-chart-for-confluence?hosting=cloud&tab=overview)
- [Jira](https://marketplace.atlassian.com/apps/1234810/mermaid-chart-for-jira?tab=overview&hosting=cloud)

View File

@@ -35,13 +35,11 @@ The Mermaid Chart team is excited to introduce a new Visual Editor for Flowchart
Learn more:
- Visual Editor For Flowcharts
- [Blog post](https://www.mermaidchart.com/blog/posts/mermaid-chart-releases-new-visual-editor-for-flowcharts)
- [Demo video](https://www.youtube.com/watch?v=5aja0gijoO0)
- Visual Editor For Sequence diagrams
- [Blog post](https://www.mermaidchart.com/blog/posts/mermaid-chart-unveils-visual-editor-for-sequence-diagrams)
- [Demo video](https://youtu.be/imc2u5_N6Dc)

View File

@@ -6,6 +6,18 @@
# Blog
## [The Essential Guide to Mermaid Chart Plugin for VS Code \[08/2025\]](https://docs.mermaidchart.com/blog/posts/the-essential-guide-to-mermaid-chart-plugin-for-vs-code-08-2025)
9/9/2025 • 5 mins
Creating diagrams in VS Code has never been easier—the Mermaid VS Code plugin transforms text-based syntax into clear, professional visuals right inside your editor. With live previews, smart editing, and AI-powered diagram generation, it removes the friction from visualization so you can focus on coding.
## [How to Create Perfect Flowcharts Using AI in 2025 Step-by-Step Guide](https://docs.mermaidchart.com/blog/posts/how-to-create-perfect-flowcharts-using-ai-in-2025-step-by-step-guide)
7/22/2025 • 8 mins
In 2025, AI tools make creating flowcharts faster and easier than ever. With Mermaids AI flowchart generator, you can turn plain text into clear, accurate diagrams in seconds. This guide walks through how it works and how to get the most out of it for technical and business workflows alike.
## [Mermaid introduces the Visual Editor for Entity Relationship diagrams](https://docs.mermaidchart.com/blog/posts/mermaid-introduces-the-visual-editor-for-entity-relationship-diagrams)
7/15/2025 • 7 mins

View File

@@ -194,7 +194,7 @@ architecture-beta
## Icons
By default, architecture diagram supports the following icons: `cloud`, `database`, `disk`, `internet`, `server`.
Users can use any of the 200,000+ icons available in iconify.design, or [add custom icons](../config/icons.md).
Users can use any of the 200,000+ icons available in iconify.design, or add other custom icons, by [registering an icon pack](../config/icons.md).
After the icons are installed, they can be used in the architecture diagram by using the format "name:icon-name", where name is the value used when registering the icon pack.

View File

@@ -139,7 +139,6 @@ The following unfinished features are not supported in the short term.
- [ ] Legend
- [x] System Context
- [x] Person(alias, label, ?descr, ?sprite, ?tags, $link)
- [x] Person_Ext
- [x] System(alias, label, ?descr, ?sprite, ?tags, $link)
@@ -153,7 +152,6 @@ The following unfinished features are not supported in the short term.
- [x] System_Boundary
- [x] Container diagram
- [x] Container(alias, label, ?techn, ?descr, ?sprite, ?tags, $link)
- [x] ContainerDb
- [x] ContainerQueue
@@ -163,7 +161,6 @@ The following unfinished features are not supported in the short term.
- [x] Container_Boundary(alias, label, ?tags, $link)
- [x] Component diagram
- [x] Component(alias, label, ?techn, ?descr, ?sprite, ?tags, $link)
- [x] ComponentDb
- [x] ComponentQueue
@@ -172,18 +169,15 @@ The following unfinished features are not supported in the short term.
- [x] ComponentQueue_Ext
- [x] Dynamic diagram
- [x] RelIndex(index, from, to, label, ?tags, $link)
- [x] Deployment diagram
- [x] Deployment_Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link)
- [x] Node(alias, label, ?type, ?descr, ?sprite, ?tags, $link): short name of Deployment_Node()
- [x] Node_L(alias, label, ?type, ?descr, ?sprite, ?tags, $link): left aligned Node()
- [x] Node_R(alias, label, ?type, ?descr, ?sprite, ?tags, $link): right aligned Node()
- [x] Relationship Types
- [x] Rel(from, to, label, ?techn, ?descr, ?sprite, ?tags, $link)
- [x] BiRel (bidirectional relationship)
- [x] Rel_U, Rel_Up

View File

@@ -360,7 +360,8 @@ gantt
weekday monday
```
> **Warning** > `millisecond` and `second` support was added in v10.3.0
> **Warning**
> `millisecond` and `second` support was added in v10.3.0
## Output in compact mode

View File

@@ -329,7 +329,11 @@ Messages can be of two displayed either solid or with a dotted line.
[Actor][Arrow][Actor]:Message text
```
There are ten types of arrows currently supported:
Lines can be solid or dotted, and can end with various types of arrowheads, crosses, or open arrows.
#### Supported Arrow Types
**Standard Arrow Types**
| Type | Description |
| -------- | ---------------------------------------------------- |
@@ -344,6 +348,58 @@ There are ten types of arrows currently supported:
| `-)` | Solid line with an open arrow at the end (async) |
| `--)` | Dotted line with a open arrow at the end (async) |
**Half-Arrows (v\<MERMAID_RELEASE_VERSION>+)**
The following half-arrow types are supported for more expressive sequence diagrams. Both solid and dotted variants are available by increasing the number of dashes (`-` → `--`).
---
| Type | Description |
| ------- | ---------------------------------------------------- |
| `-\|\` | Solid line with top half arrowhead |
| `--\|\` | Dotted line with top half arrowhead |
| `-\|/` | Solid line with bottom half arrowhead |
| `--\|/` | Dotted line with bottom half arrowhead |
| `/\|-` | Solid line with reverse top half arrowhead |
| `/\|--` | Dotted line with reverse top half arrowhead |
| `\\-` | Solid line with reverse bottom half arrowhead |
| `\\--` | Dotted line with reverse bottom half arrowhead |
| `-\\` | Solid line with top stick half arrowhead |
| `--\\` | Dotted line with top stick half arrowhead |
| `-//` | Solid line with bottom stick half arrowhead |
| `--//` | Dotted line with bottom stick half arrowhead |
| `//-` | Solid line with reverse top stick half arrowhead |
| `//--` | Dotted line with reverse top stick half arrowhead |
| `\\-` | Solid line with reverse bottom stick half arrowhead |
| `\\--` | Dotted line with reverse bottom stick half arrowhead |
## Central Connections (v\<MERMAID_RELEASE_VERSION>+)
Mermaid sequence diagrams support **central lifeline connections** using a `()`.
This is useful to represent messages or signals that connect to a central point, rather than from one actor directly to another.
To indicate a central connection, append `()` to the arrow syntax.
#### Basic Syntax
```mermaid-example
sequenceDiagram
participant Alice
participant John
Alice->>()John: Hello John
Alice()->>John: How are you?
John()->>()Alice: Great!
```
```mermaid
sequenceDiagram
participant Alice
participant John
Alice->>()John: Hello John
Alice()->>John: How are you?
John()->>()Alice: Great!
```
## Activations
It is possible to activate and deactivate an actor. (de)activation can be dedicated declarations:

View File

@@ -38,3 +38,5 @@ Each user journey is split into sections, these describe the part of the task
the user is trying to complete.
Tasks syntax is `Task name: <score>: <comma separated list of actors>`
Score is a number between 1 and 5, inclusive.

View File

@@ -15,19 +15,13 @@
"git graph"
],
"scripts": {
"build": "pnpm antlr:generate && pnpm build:esbuild && pnpm build:types",
"build": "pnpm build:esbuild && pnpm build:types",
"build:esbuild": "pnpm run -r clean && tsx .esbuild/build.ts",
"antlr:generate": "tsx scripts/antlr-generate.mts",
"antlr:watch": "tsx scripts/antlr-watch.mts",
"build:mermaid": "pnpm build:esbuild --mermaid",
"build:viz": "pnpm build:esbuild --visualize",
"build:types": "pnpm --filter mermaid types:build-config && tsx .build/types.ts",
"build:types:watch": "tsc -p ./packages/mermaid/tsconfig.json --emitDeclarationOnly --watch",
"dev": "tsx .esbuild/server.ts",
"dev:antlr": "USE_ANTLR_PARSER=true tsx .esbuild/server-antlr.ts",
"dev:antlr:visitor": "USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true tsx .esbuild/server-antlr.ts",
"dev:antlr:listener": "USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=false tsx .esbuild/server-antlr.ts",
"dev:antlr:debug": "ANTLR_DEBUG=true USE_ANTLR_PARSER=true tsx .esbuild/server-antlr.ts",
"dev:vite": "tsx .vite/server.ts",
"dev:coverage": "pnpm coverage:cypress:clean && VITE_COVERAGE=true pnpm dev:vite",
"copy-readme": "cpy './README.*' ./packages/mermaid/ --cwd=.",
@@ -48,12 +42,7 @@
"test": "pnpm lint && vitest run",
"test:watch": "vitest --watch",
"test:coverage": "vitest --coverage",
"test:antlr": "USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true vitest run packages/mermaid/src/diagrams/flowchart/parser/",
"test:antlr:visitor": "USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true vitest run packages/mermaid/src/diagrams/flowchart/parser/",
"test:antlr:listener": "USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=false vitest run packages/mermaid/src/diagrams/flowchart/parser/",
"test:antlr:debug": "ANTLR_DEBUG=true USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true vitest run packages/mermaid/src/diagrams/flowchart/parser/",
"test:check:tsc": "tsx scripts/tsc-check.ts",
"postinstall": "pnpm antlr:generate",
"prepare": "husky && pnpm build",
"pre-commit": "lint-staged"
},
@@ -74,36 +63,36 @@
]
},
"devDependencies": {
"@applitools/eyes-cypress": "^3.44.9",
"@argos-ci/cypress": "^5.0.2",
"@applitools/eyes-cypress": "^3.55.2",
"@argos-ci/cypress": "^6.1.3",
"@changesets/changelog-github": "^0.5.1",
"@changesets/cli": "^2.27.12",
"@changesets/cli": "^2.29.7",
"@cspell/eslint-plugin": "^8.19.4",
"@cypress/code-coverage": "^3.12.49",
"@cypress/code-coverage": "^3.14.6",
"@eslint/js": "^9.26.0",
"@rollup/plugin-typescript": "^12.1.2",
"@types/cors": "^2.8.17",
"@types/express": "^5.0.0",
"@rollup/plugin-typescript": "^12.1.4",
"@types/cors": "^2.8.19",
"@types/express": "^5.0.3",
"@types/js-yaml": "^4.0.9",
"@types/jsdom": "^21.1.7",
"@types/lodash": "^4.17.15",
"@types/lodash": "^4.17.20",
"@types/mdast": "^4.0.4",
"@types/node": "^22.13.5",
"@types/node": "^22.18.6",
"@types/rollup-plugin-visualizer": "^5.0.3",
"@vitest/coverage-v8": "^3.0.6",
"@vitest/spy": "^3.0.6",
"@vitest/ui": "^3.0.6",
"@vitest/coverage-v8": "^3.2.4",
"@vitest/spy": "^3.2.4",
"@vitest/ui": "^3.2.4",
"ajv": "^8.17.1",
"chokidar": "3.6.0",
"concurrently": "^9.1.2",
"concurrently": "^9.2.1",
"cors": "^2.8.5",
"cpy-cli": "^5.0.0",
"cross-env": "^7.0.3",
"cspell": "^9.1.3",
"cypress": "^14.5.1",
"cspell": "^9.2.1",
"cypress": "^14.5.4",
"cypress-image-snapshot": "^4.0.1",
"cypress-split": "^1.24.14",
"esbuild": "^0.25.0",
"cypress-split": "^1.24.23",
"esbuild": "^0.25.10",
"eslint": "^9.26.0",
"eslint-config-prettier": "^10.1.8",
"eslint-plugin-cypress": "^4.3.0",
@@ -117,30 +106,30 @@
"eslint-plugin-tsdoc": "^0.4.0",
"eslint-plugin-unicorn": "^59.0.1",
"express": "^5.1.0",
"globals": "^16.0.0",
"globby": "^14.0.2",
"globals": "^16.4.0",
"globby": "^14.1.0",
"husky": "^9.1.7",
"jest": "^30.0.4",
"jest": "^30.1.3",
"jison": "^0.4.18",
"js-yaml": "^4.1.0",
"jsdom": "^26.1.0",
"langium-cli": "3.3.0",
"lint-staged": "^16.1.2",
"lint-staged": "^16.1.6",
"markdown-table": "^3.0.4",
"nyc": "^17.1.0",
"path-browserify": "^1.0.1",
"prettier": "^3.5.2",
"prettier-plugin-jsdoc": "^1.3.2",
"prettier": "^3.6.2",
"prettier-plugin-jsdoc": "^1.3.3",
"rimraf": "^6.0.1",
"rollup-plugin-visualizer": "^6.0.3",
"start-server-and-test": "^2.0.10",
"start-server-and-test": "^2.1.2",
"tslib": "^2.8.1",
"tsx": "^4.7.3",
"tsx": "^4.20.5",
"typescript": "~5.7.3",
"typescript-eslint": "^8.38.0",
"vite": "^7.0.3",
"vite": "^7.0.7",
"vite-plugin-istanbul": "^7.0.0",
"vitest": "^3.0.6"
"vitest": "^3.2.4"
},
"nyc": {
"report-dir": "coverage/cypress"

View File

@@ -3,6 +3,7 @@
"version": "1.0.0",
"description": "Mermaid examples package",
"author": "Sidharth Vinod",
"license": "MIT",
"type": "module",
"module": "./dist/mermaid-examples.core.mjs",
"types": "./dist/mermaid.d.ts",

View File

@@ -37,12 +37,12 @@
]
},
"dependencies": {
"@braintree/sanitize-url": "^7.0.4",
"@braintree/sanitize-url": "^7.1.1",
"d3": "^7.9.0",
"khroma": "^2.1.0"
},
"devDependencies": {
"concurrently": "^9.1.2",
"concurrently": "^9.2.1",
"mermaid": "workspace:*",
"rimraf": "^6.0.1"
},

View File

@@ -1,5 +1,16 @@
# @mermaid-js/layout-elk
## 0.2.0
### Minor Changes
- [#6802](https://github.com/mermaid-js/mermaid/pull/6802) [`c8e5027`](https://github.com/mermaid-js/mermaid/commit/c8e50276e877c4de7593a09ec458c99353e65af8) Thanks [@darshanr0107](https://github.com/darshanr0107)! - feat: Update mindmap rendering to support multiple layouts, improved edge intersections, and new shapes
### Patch Changes
- Updated dependencies [[`33bc4a0`](https://github.com/mermaid-js/mermaid/commit/33bc4a0b4e2ca6d937bb0a8c4e2081b1362b2800), [`e0b45c2`](https://github.com/mermaid-js/mermaid/commit/e0b45c2d2b41c2a9038bf87646fa3ccd7560eb20), [`012530e`](https://github.com/mermaid-js/mermaid/commit/012530e98e9b8b80962ab270b6bb3b6d9f6ada05), [`c8e5027`](https://github.com/mermaid-js/mermaid/commit/c8e50276e877c4de7593a09ec458c99353e65af8)]:
- mermaid@11.11.0
## 0.1.9
### Patch Changes

View File

@@ -1,6 +1,6 @@
{
"name": "@mermaid-js/layout-elk",
"version": "0.1.9",
"version": "0.2.0",
"description": "ELK layout engine for mermaid",
"module": "dist/mermaid-layout-elk.core.mjs",
"types": "dist/layouts.d.ts",

View File

@@ -67,7 +67,22 @@ export const render = async (
// Add the element to the DOM
if (!node.isGroup) {
const child = node as NodeWithVertex;
// const child = node as NodeWithVertex;
const child: NodeWithVertex = {
id: node.id,
width: node.width,
height: node.height,
// Store the original node data for later use
label: node.label,
isGroup: node.isGroup,
shape: node.shape,
padding: node.padding,
cssClasses: node.cssClasses,
cssStyles: node.cssStyles,
look: node.look,
// Include parentId for subgraph processing
parentId: node.parentId,
};
graph.children.push(child);
nodeDb[node.id] = node;
@@ -150,7 +165,7 @@ export const render = async (
domId: { node: () => any; attr: (arg0: string, arg1: string) => void };
}) {
if (node) {
nodeDb[node.id] = node;
nodeDb[node.id] ??= {};
nodeDb[node.id].offset = {
posX: node.x + relX,
posY: node.y + relY,
@@ -860,11 +875,13 @@ export const render = async (
log.info('APA01 layout result:', JSON.stringify(g, null, 2));
} catch (error) {
log.error('APA01 ELK layout error:', error);
log.error('APA01 elkGraph that caused error:', JSON.stringify(elkGraph, null, 2));
throw error;
}
// debugger;
await drawNodes(0, 0, g.children, svg, subGraphsEl, 0);
g.edges?.map(
(edge: {
sources: (string | number)[];

View File

@@ -0,0 +1,12 @@
# @mermaid-js/layout-tidy-tree
## 0.2.0
### Minor Changes
- [#6802](https://github.com/mermaid-js/mermaid/pull/6802) [`c8e5027`](https://github.com/mermaid-js/mermaid/commit/c8e50276e877c4de7593a09ec458c99353e65af8) Thanks [@darshanr0107](https://github.com/darshanr0107)! - feat: Update mindmap rendering to support multiple layouts, improved edge intersections, and new shapes
### Patch Changes
- Updated dependencies [[`33bc4a0`](https://github.com/mermaid-js/mermaid/commit/33bc4a0b4e2ca6d937bb0a8c4e2081b1362b2800), [`e0b45c2`](https://github.com/mermaid-js/mermaid/commit/e0b45c2d2b41c2a9038bf87646fa3ccd7560eb20), [`012530e`](https://github.com/mermaid-js/mermaid/commit/012530e98e9b8b80962ab270b6bb3b6d9f6ada05), [`c8e5027`](https://github.com/mermaid-js/mermaid/commit/c8e50276e877c4de7593a09ec458c99353e65af8)]:
- mermaid@11.11.0

View File

@@ -1,6 +1,6 @@
{
"name": "@mermaid-js/layout-tidy-tree",
"version": "0.1.0",
"version": "0.2.0",
"description": "Tidy-tree layout engine for mermaid",
"module": "dist/mermaid-layout-tidy-tree.core.mjs",
"types": "dist/layouts.d.ts",

View File

@@ -33,7 +33,7 @@
],
"license": "MIT",
"dependencies": {
"@zenuml/core": "^3.35.2"
"@zenuml/core": "^3.41.4"
},
"devDependencies": {
"mermaid": "workspace:^"

View File

@@ -1,5 +1,19 @@
# mermaid
## 11.11.0
### Minor Changes
- [#6704](https://github.com/mermaid-js/mermaid/pull/6704) [`012530e`](https://github.com/mermaid-js/mermaid/commit/012530e98e9b8b80962ab270b6bb3b6d9f6ada05) Thanks [@omkarht](https://github.com/omkarht)! - feat: Added support for new participant types (`actor`, `boundary`, `control`, `entity`, `database`, `collections`, `queue`) in `sequenceDiagram`.
- [#6802](https://github.com/mermaid-js/mermaid/pull/6802) [`c8e5027`](https://github.com/mermaid-js/mermaid/commit/c8e50276e877c4de7593a09ec458c99353e65af8) Thanks [@darshanr0107](https://github.com/darshanr0107)! - feat: Update mindmap rendering to support multiple layouts, improved edge intersections, and new shapes
### Patch Changes
- [#6905](https://github.com/mermaid-js/mermaid/pull/6905) [`33bc4a0`](https://github.com/mermaid-js/mermaid/commit/33bc4a0b4e2ca6d937bb0a8c4e2081b1362b2800) Thanks [@darshanr0107](https://github.com/darshanr0107)! - fix: Render newlines as spaces in class diagrams
- [#6886](https://github.com/mermaid-js/mermaid/pull/6886) [`e0b45c2`](https://github.com/mermaid-js/mermaid/commit/e0b45c2d2b41c2a9038bf87646fa3ccd7560eb20) Thanks [@darshanr0107](https://github.com/darshanr0107)! - fix: Handle arrows correctly when auto number is enabled
## 11.10.0
### Minor Changes
@@ -154,7 +168,6 @@
### Minor Changes
- [#6408](https://github.com/mermaid-js/mermaid/pull/6408) [`ad65313`](https://github.com/mermaid-js/mermaid/commit/ad653138e16765d095613a6e5de86dc5e52ac8f0) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - fix: restore curve type configuration functionality for flowcharts. This fixes the issue where curve type settings were not being applied when configured through any of the following methods:
- Config
- Init directive (%%{ init: { 'flowchart': { 'curve': '...' } } }%%)
- LinkStyle command (linkStyle default interpolate ...)
@@ -173,14 +186,12 @@
### Minor Changes
- [#6187](https://github.com/mermaid-js/mermaid/pull/6187) [`7809b5a`](https://github.com/mermaid-js/mermaid/commit/7809b5a93fae127f45727071f5ff14325222c518) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - Flowchart new syntax for node metadata bugs
- Incorrect label mapping for nodes when using `&`
- Syntax error when `}` with trailing spaces before new line
- [#6136](https://github.com/mermaid-js/mermaid/pull/6136) [`ec0d9c3`](https://github.com/mermaid-js/mermaid/commit/ec0d9c389aa6018043187654044c1e0b5aa4f600) Thanks [@knsv](https://github.com/knsv)! - Adding support for animation of flowchart edges
- [#6373](https://github.com/mermaid-js/mermaid/pull/6373) [`05bdf0e`](https://github.com/mermaid-js/mermaid/commit/05bdf0e20e2629fe77513218fbd4e28e65f75882) Thanks [@ashishjain0512](https://github.com/ashishjain0512)! - Upgrade Requirement and ER diagram to use the common renderer flow
- Added support for directions
- Added support for hand drawn look

View File

@@ -1,6 +1,6 @@
{
"name": "mermaid",
"version": "11.10.0",
"version": "11.11.0",
"description": "Markdown-ish syntax for generating flowcharts, mindmaps, sequence diagrams, class diagrams, gantt charts, git graphs and more.",
"type": "module",
"module": "./dist/mermaid.core.mjs",
@@ -34,8 +34,6 @@
"scripts": {
"clean": "rimraf dist",
"dev": "pnpm -w dev",
"antlr:generate": "tsx ../../scripts/antlr-generate.mts",
"antlr:watch": "tsx ../../scripts/antlr-watch.mts",
"docs:code": "typedoc src/defaultConfig.ts src/config.ts src/mermaid.ts && prettier --write ./src/docs/config/setup",
"docs:build": "rimraf ../../docs && pnpm docs:code && pnpm docs:spellcheck && tsx scripts/docs.cli.mts",
"docs:verify": "pnpm docs:code && pnpm docs:spellcheck && tsx scripts/docs.cli.mts --verify",
@@ -49,14 +47,7 @@
"docs:verify-version": "tsx scripts/update-release-version.mts --verify",
"types:build-config": "tsx scripts/create-types-from-json-schema.mts",
"types:verify-config": "tsx scripts/create-types-from-json-schema.mts --verify",
"postinstall": "pnpm antlr:generate",
"checkCircle": "npx madge --circular ./src",
"antlr:sequence:clean": "rimraf src/diagrams/sequence/parser/antlr/generated",
"antlr:sequence": "pnpm run antlr:sequence:clean && antlr4ng -Dlanguage=TypeScript -Xexact-output-dir -lib src/diagrams/common/parser/antlr -o src/diagrams/sequence/parser/antlr/generated src/diagrams/sequence/parser/antlr/SequenceLexer.g4 src/diagrams/sequence/parser/antlr/SequenceParser.g4",
"antlr:class:clean": "rimraf src/diagrams/class/parser/antlr/generated",
"antlr:class": "pnpm run antlr:class:clean && antlr4ng -Dlanguage=TypeScript -Xexact-output-dir -o src/diagrams/class/parser/antlr/generated src/diagrams/class/parser/antlr/ClassLexer.g4 src/diagrams/class/parser/antlr/ClassParser.g4",
"antlr:flowchart:clean": "rimraf src/diagrams/flowchart/parser/antlr/generated",
"antlr:flowchart": "pnpm run antlr:flowchart:clean && antlr4ng -Dlanguage=TypeScript -Xexact-output-dir -o src/diagrams/flowchart/parser/antlr/generated src/diagrams/flowchart/parser/antlr/FlowLexer.g4 src/diagrams/flowchart/parser/antlr/FlowParser.g4",
"prepublishOnly": "pnpm docs:verify-version"
},
"repository": {
@@ -76,31 +67,29 @@
]
},
"dependencies": {
"@braintree/sanitize-url": "^7.0.4",
"@iconify/utils": "^3.0.1",
"@braintree/sanitize-url": "^7.1.1",
"@iconify/utils": "^3.0.2",
"@mermaid-js/parser": "workspace:^",
"@types/d3": "^7.4.3",
"antlr-ng": "^1.0.10",
"antlr4ng": "^3.0.16",
"cytoscape": "^3.29.3",
"cytoscape": "^3.33.1",
"cytoscape-cose-bilkent": "^4.1.0",
"cytoscape-fcose": "^2.2.0",
"d3": "^7.9.0",
"d3-sankey": "^0.12.3",
"dagre-d3-es": "7.0.11",
"dayjs": "^1.11.13",
"dompurify": "^3.2.5",
"dayjs": "^1.11.18",
"dompurify": "^3.2.7",
"katex": "^0.16.22",
"khroma": "^2.1.0",
"lodash-es": "^4.17.21",
"marked": "^16.0.0",
"marked": "^16.3.0",
"roughjs": "^4.6.6",
"stylis": "^4.3.6",
"ts-dedent": "^2.2.0",
"uuid": "^11.1.0"
},
"devDependencies": {
"@adobe/jsonschema2md": "^8.0.2",
"@adobe/jsonschema2md": "^8.0.5",
"@iconify/types": "^2.0.0",
"@types/cytoscape": "^3.21.9",
"@types/cytoscape-fcose": "^2.2.4",
@@ -116,32 +105,31 @@
"@types/stylis": "^4.2.7",
"@types/uuid": "^10.0.0",
"ajv": "^8.17.1",
"canvas": "^3.1.0",
"canvas": "^3.2.0",
"chokidar": "3.6.0",
"concurrently": "^9.1.2",
"concurrently": "^9.2.1",
"csstree-validator": "^4.0.1",
"globby": "^14.0.2",
"globby": "^14.1.0",
"jison": "^0.4.18",
"js-base64": "^3.7.7",
"js-base64": "^3.7.8",
"jsdom": "^26.1.0",
"json-schema-to-typescript": "^15.0.4",
"micromatch": "^4.0.8",
"path-browserify": "^1.0.1",
"prettier": "^3.5.2",
"prettier": "^3.6.2",
"remark": "^15.0.1",
"remark-frontmatter": "^5.0.0",
"remark-gfm": "^4.0.1",
"rimraf": "^6.0.1",
"start-server-and-test": "^2.0.10",
"type-fest": "^4.35.0",
"typedoc": "^0.28.9",
"typedoc-plugin-markdown": "^4.8.0",
"start-server-and-test": "^2.1.2",
"type-fest": "^4.41.0",
"typedoc": "^0.28.13",
"typedoc-plugin-markdown": "^4.8.1",
"typescript": "~5.7.3",
"unist-util-flatmap": "^1.0.0",
"unist-util-visit": "^5.0.0",
"vitepress": "^1.0.2",
"vitepress-plugin-search": "1.0.4-alpha.22",
"antlr4ng-cli": "^2.0.0"
"vitepress": "^1.6.4",
"vitepress-plugin-search": "1.0.4-alpha.22"
},
"files": [
"dist/",

View File

@@ -34,33 +34,12 @@ export const detectors: Record<string, DetectorRecord> = {};
* @returns A graph definition key
*/
export const detectType = function (text: string, config?: MermaidConfig): string {
// Strip header prelude (front matter, directives, comments, blank lines) only at the top
// Then detect based on the first significant keyword to avoid false positives in labels/strings
const headerlessText = stripHeaderPrelude(text);
const cleanedText = text
.replace(frontMatterRegex, '') // no-op after stripHeaderPrelude, but safe
.replace(directiveRegex, '') // defensive if any directive remains at the top
text = text
.replace(frontMatterRegex, '')
.replace(directiveRegex, '')
.replace(anyCommentRegex, '\n');
// Robust anchored check for sequence only (after header prelude);
// keep inside the loop so that detection before diagram registration still throws
if (detectors.flowchart.detector(headerlessText, config)) {
return 'flowchart';
}
if (detectors.sequence.detector(headerlessText, config)) {
return 'sequence';
}
if (detectors.classDiagram.detector(headerlessText, config)) {
return 'classDiagram';
}
if (detectors.class.detector(headerlessText, config)) {
return 'class';
}
// Fallback to registered detectors in order
for (const [key, { detector }] of Object.entries(detectors)) {
const diagram = detector(cleanedText, config);
const diagram = detector(text, config);
if (diagram) {
return key;
}
@@ -71,36 +50,6 @@ export const detectType = function (text: string, config?: MermaidConfig): strin
);
};
// Remove header prelude (front matter, directives, comments, blank lines) from the start only
function stripHeaderPrelude(input: string): string {
let s = input;
// Remove leading BOM if present
s = s.replace(/^\uFEFF/, '');
// Remove Jekyll-style front matter at the very top
s = s.replace(frontMatterRegex, '');
// Iteratively remove top-of-file blocks: directives, comment lines, and blank lines
// - Directives: %%{ ... }%% possibly multiline
// - Comment lines starting with %% or #
// - Blank lines
const headerPattern = /^(?:\s*%%{[\S\s]*?}%{2}\s*|\s*%%.*\r?\n|\s*#.*\r?\n|\s*\r?\n)*/;
const before = s;
s = s.replace(headerPattern, '');
// If nothing changed, return; otherwise, there could be another front matter after directives (rare)
if (s === before) {
return s;
}
// One extra pass for safety (handles stacked front matter blocks or multiple directives)
s = s.replace(frontMatterRegex, '');
s = s.replace(headerPattern, '');
return s;
}
/**
* Registers lazy-loaded diagrams to Mermaid.
*

View File

@@ -114,21 +114,5 @@ describe('diagram-orchestration', () => {
)
).toBe('er');
});
it('should detect sequence/state even if config strings contain other diagram names', () => {
// sequenceDiagram with config string mentioning stateDiagram
expect(
detectType(
`---
title: Hello Title
config:
theme: base
themeVariables:
primaryColor: "#00ff00"
---
sequenceDiagram\nA->B: hi`
)
).toBe('sequence');
});
});
});

View File

@@ -3,8 +3,7 @@
// 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 =
/^\uFEFF?[\t ]*-{3}[\t ]*\r?\n([\S\s]*?)\r?\n {0,2}-{3}[\t ]*(?:\r?\n|$)/;
export const frontMatterRegex = /^-{3}\s*[\n\r](.*?)[\n\r]-{3}\s*[\n\r]+/s;
export const directiveRegex =
/%{2}{\s*(?:(\w+)\s*:|(\w+))\s*(?:(\w+)|((?:(?!}%{2}).|\r?\n)*))?\s*(?:}%{2})?/gi;

View File

@@ -1,147 +0,0 @@
## ANTLR migration plan for Class Diagrams (parity with Sequence)
This guide summarizes how to migrate the Class diagram parser from Jison to ANTLR (antlr4ng), following the approach used for Sequence diagrams. The goal is full feature parity and 100% test pass rate, while keeping the Jison implementation as the reference until the ANTLR path is green.
### Objectives
- Keep the existing Jison parser as the authoritative reference until parity is achieved
- Add an ANTLR parser behind a runtime flag (`USE_ANTLR_PARSER=true`), mirroring Sequence
- Achieve 100% test compatibility with the current Jison behavior, including error cases
- Keep the public DB and rendering contracts unchanged
---
## 1) Prep and references
- Use the Sequence migration as a template for structure, scripts, and patterns:
- antlr4ng grammar files: `SequenceLexer.g4`, `SequenceParser.g4`
- wrapper: `antlr-parser.ts` providing a Jison-compatible `parse()` and `yy`
- generation script: `pnpm --filter mermaid run antlr:sequence`
- For Class diagrams, identify analogous files:
- Jison grammar: `packages/mermaid/src/diagrams/class/parser/classDiagram.jison`
- DB: `packages/mermaid/src/diagrams/class/classDb.ts`
- Tests: `packages/mermaid/src/diagrams/class/classDiagram.spec.js`
- Confirm Class diagram features in the Jison grammar and tests: classes, interfaces, enums, relationships (e.g., `--`, `*--`, `o--`, `<|--`, `--|>`), visibility markers (`+`, `-`, `#`, `~`), generics (`<T>`, nested), static/abstract indicators, fields/properties, methods (with parameters and return types), stereotypes (`<< >>`), notes, direction, style/config lines, and titles/accessibility lines if supported.
---
## 2) Create ANTLR grammars
- Create `ClassLexer.g4` and `ClassParser.g4` under `packages/mermaid/src/diagrams/class/parser/antlr/`
- Lexer design guidelines (mirror Sequence approach):
- Implement stateful lexing with modes to replicate Jison behavior (e.g., default, line/rest-of-line, config/title/acc modes if used)
- Ensure token precedence resolves conflicts between relation arrows and generics (`<|--` vs `<T>`). Prefer longest-match arrow tokens and handle generics in parser context
- Accept identifiers that include special characters that Jison allowed (quotes, underscores, digits, unicode as applicable)
- Provide tokens for core keywords and symbols: `class`, `interface`, `enum`, relationship operators, visibility markers, `<< >>` stereotypes, `{ }` blocks, `:` type separators, `,` parameter separators, `[` `]` arrays, `<` `>` generics
- Reuse common tokens shared across diagrams where appropriate (e.g., `TITLE`, `ACC_...`) if Class supports them
- Parser design guidelines:
- Follow the Jison grammar structure closely to minimize semantic drift
- Allow the final statement in the file to omit a trailing newline (to avoid EOF vs NEWLINE mismatches)
- Keep non-ambiguous rules for:
- Class declarations and bodies (members split into fields/properties vs methods)
- Modifiers (visibility, static, abstract)
- Types (simple, namespaced, generic with nesting)
- Relationships with labels (left->right/right->left forms) and multiplicities
- Stereotypes and notes
- Optional global lines (title, accTitle, accDescr) if supported by class diagrams
---
## 3) Add the wrapper and flag switch
- Add `packages/mermaid/src/diagrams/class/parser/antlr/antlr-parser.ts`:
- Export an object `{ parse, parser, yy }` that mirrors the Jison parser shape
- `parse(input)` should:
- `this.yy.clear()` to reset DB (same as Sequence)
- Build ANTLR's lexer/parser, set `BailErrorStrategy` to fail-fast on syntax errors
- Walk the tree with a listener that calls classDb methods
- Implement no-op bodies for `visitTerminal`, `visitErrorNode`, `enterEveryRule`, `exitEveryRule` (required by ParseTreeWalker)
- Avoid `require()`; import from `antlr4ng`
- Use minimal `any`; when casting is unavoidable, add clear comments
- Add `packages/mermaid/src/diagrams/class/parser/classParser.ts` similar to Sequence `sequenceParser.ts`:
- Import both the Jison parser and the ANTLR wrapper
- Gate on `process.env.USE_ANTLR_PARSER === 'true'`
- Normalize whitespace if Jison relies on specific newlines (keep parity with Sequence patterns)
---
## 4) Implement the listener (semantic actions)
Map parsed constructs to classDb calls. Typical handlers include:
- Class-like declarations
- `db.addClass(id, { type: 'class'|'interface'|'enum', ... })`
- `db.addClassMember(id, member)` for fields/properties/methods (capture visibility, static/abstract, types, params)
- Stereotypes, annotations, notes: `db.addAnnotation(...)`, `db.addNote(...)` if applicable
- Relationships
- Parse arrow/operator to relation type; map to db constants (composition/aggregation/inheritance/realization/association)
- `db.addRelation(lhs, rhs, { type, label, multiplicity })`
- Title/Accessibility (if supported in Class diagrams)
- `db.setDiagramTitle(...)`, `db.setAccTitle(...)`, `db.setAccDescription(...)`
- Styles/Directives/Config lines as supported by the Jison grammar
Error handling:
- Use BailErrorStrategy; let invalid constructs throw where Jison tests expect failure
- For robustness parity, only swallow exceptions in places where Jison tolerated malformed content without aborting
---
## 5) Scripts and generation
- Add package scripts similar to Sequence in `packages/mermaid/package.json`:
- `antlr:class:clean`: remove generated TS
- `antlr:class`: run antlr4ng to generate TS into `parser/antlr/generated`
- Example command (once scripts exist):
- `pnpm --filter mermaid run antlr:class`
---
## 6) Tests (Vitest)
- Run existing Class tests with the ANTLR parser enabled:
- `USE_ANTLR_PARSER=true pnpm vitest packages/mermaid/src/diagrams/class/classDiagram.spec.js --run`
- Start by making a small focused subset pass, then expand to the full suite
- Add targeted tests for areas where the ANTLR grammar needs extra coverage (e.g., nested generics, tricky arrow/operator precedence, stereotypes, notes)
- Keep test expectations identical to Jisons behavior; only adjust if Jisons behavior was explicitly flaky and already tolerated in the repo
---
## 7) Linting and quality
- Satisfy ESLint rules enforced in the repo:
- Prefer imports over `require()`; no empty methods, avoid untyped `any` where reasonable
- If `@ts-ignore` is necessary, include a descriptive reason (≥10 chars)
- Provide minimal types for listener contexts where helpful; keep casts localized and commented
- Prefix diagnostic debug logs with the projects preferred prefix if temporary logging is needed (and clean up before commit)
---
## 8) Common pitfalls and tips
- NEWLINE vs EOF: allow the last statement without a trailing newline to prevent InputMismatch
- Token conflicts: order matters; ensure relationship operators (e.g., `<|--`, `--|>`, `*--`, `o--`) win over generic `<`/`>` in the right contexts
- Identifiers: match Jisons permissiveness (quoted names, digits where allowed) and avoid over-greedy tokens that eat operators
- Listener resilience: ensure classes and endpoints exist before adding relations (create implicitly if Jison did so)
- Error parity: do not swallow exceptions for cases where tests expect failure
---
## 9) Rollout checklist
- [ ] Grammar compiles and generated files are committed
- [ ] `USE_ANTLR_PARSER=true` passes all Class diagram tests
- [ ] Sequence and other diagram suites remain green
- [ ] No new ESLint errors; warnings minimized
- [ ] PR includes notes on parity and how to run the ANTLR tests
---
## 10) Quick command reference
- Generate ANTLR targets (after adding scripts):
- `pnpm --filter mermaid run antlr:class`
- Run Class tests with ANTLR parser:
- `USE_ANTLR_PARSER=true pnpm vitest packages/mermaid/src/diagrams/class/classDiagram.spec.js --run`
- Run a single test:
- `USE_ANTLR_PARSER=true pnpm vitest packages/mermaid/src/diagrams/class/classDiagram.spec.js -t "some test name" --run`

View File

@@ -627,7 +627,7 @@ export class ClassDB implements DiagramDB {
padding: config.class!.padding ?? 16,
// parent node must be one of [rect, roundedWithTitle, noteGroup, divider]
shape: 'rect',
cssStyles: ['fill: none', 'stroke: black'],
cssStyles: [],
look: config.look,
};
nodes.push(node);

View File

@@ -1,4 +1,4 @@
import { parser } from './parser/classParser.ts';
import { parser } from './parser/classDiagram.jison';
import { ClassDB } from './classDb.js';
describe('class diagram, ', function () {

View File

@@ -1,6 +1,6 @@
import type { DiagramDefinition } from '../../diagram-api/types.js';
// @ts-ignore: JISON doesn't support types
import parser from './parser/classParser.ts';
import parser from './parser/classDiagram.jison';
import { ClassDB } from './classDb.js';
import styles from './styles.js';
import renderer from './classRenderer-v3-unified.js';

View File

@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/unbound-method -- Broken for Vitest mocks, see https://github.com/vitest-dev/eslint-plugin-vitest/pull/286 */
// @ts-expect-error Parser exposes mutable yy property without typings
import { parser } from './parser/classParser.ts';
// @ts-expect-error Jison doesn't export types
import { parser } from './parser/classDiagram.jison';
import { ClassDB } from './classDb.js';
import { vi, describe, it, expect } from 'vitest';
import type { ClassMap, NamespaceNode } from './classTypes.js';

View File

@@ -1,6 +1,6 @@
import type { DiagramDefinition } from '../../diagram-api/types.js';
// @ts-ignore: JISON doesn't support types
import parser from './parser/classParser.ts';
import parser from './parser/classDiagram.jison';
import { ClassDB } from './classDb.js';
import styles from './styles.js';
import renderer from './classRenderer-v3-unified.js';

View File

@@ -1,231 +0,0 @@
lexer grammar ClassLexer;
import HeaderCommon;
tokens {
ACC_TITLE_VALUE,
ACC_DESCR_VALUE,
ACC_DESCR_MULTILINE_VALUE,
ACC_DESCR_MULTI_END,
OPEN_IN_STRUCT,
MEMBER
}
@members {
private pendingClassBody = false;
private pendingNamespaceBody = false;
private clearPendingScopes(): void {
this.pendingClassBody = false;
this.pendingNamespaceBody = false;
}
}
// Common fragments
fragment WS_INLINE: [ \t]+;
fragment DIGIT: [0-9];
fragment LETTER: [A-Za-z_];
fragment IDENT_PART: [A-Za-z0-9_\-];
fragment NOT_DQUOTE: ~[""];
// Comments and whitespace
NEWLINE: ('\r'? '\n')+ { this.clearPendingScopes(); };
WS: [ \t]+ -> skip;
// Diagram title declaration
CLASS_DIAGRAM_V2: 'classDiagram-v2' { this.headerMode = false; } -> type(CLASS_DIAGRAM);
CLASS_DIAGRAM: 'classDiagram' { this.headerMode = false; };
// Directions
DIRECTION_TB: 'direction' WS_INLINE+ 'TB';
DIRECTION_BT: 'direction' WS_INLINE+ 'BT';
DIRECTION_LR: 'direction' WS_INLINE+ 'LR';
DIRECTION_RL: 'direction' WS_INLINE+ 'RL';
// Accessibility tokens
ACC_TITLE: 'accTitle' WS_INLINE* ':' WS_INLINE* -> pushMode(ACC_TITLE_MODE);
ACC_DESCR: 'accDescr' WS_INLINE* ':' WS_INLINE* -> pushMode(ACC_DESCR_MODE);
ACC_DESCR_MULTI: 'accDescr' WS_INLINE* '{' -> pushMode(ACC_DESCR_MULTILINE_MODE);
// Statements captured as raw lines for semantic handling in listener
STYLE_LINE: 'style' WS_INLINE+ ~[\r\n]*;
CLASSDEF_LINE: 'classDef' ~[\r\n]*;
CSSCLASS_LINE: 'cssClass' ~[\r\n]*;
CALLBACK_LINE: 'callback' ~[\r\n]*;
CLICK_LINE: 'click' ~[\r\n]*;
LINK_LINE: 'link' ~[\r\n]*;
CALL_LINE: 'call' ~[\r\n]*;
// Notes
NOTE_FOR: 'note' WS_INLINE+ 'for';
NOTE: 'note';
// Keywords that affect block handling
CLASS: 'class' { this.pendingClassBody = true; };
NAMESPACE: 'namespace' { this.pendingNamespaceBody = true; };
// Structural tokens
STYLE_SEPARATOR: ':::';
ANNOTATION_START: '<<';
ANNOTATION_END: '>>';
LBRACKET: '[';
RBRACKET: ']';
COMMA: ',';
DOT: '.';
EDGE_STATE: '[*]';
GENERIC: '~' (~[~\r\n])+ '~';
// Match strings without escape semantics to mirror Jison behavior
// Allow any chars except an unescaped closing double-quote; permit newlines
STRING: '"' NOT_DQUOTE* '"';
BACKTICK_ID: '`' (~[`])* '`';
LABEL: ':' (~[':\r\n;])*;
RELATION_ARROW
: (LEFT_HEAD)? LINE_BODY (RIGHT_HEAD)?
;
fragment LEFT_HEAD
: '<|'
| '<'
| 'o'
| '*'
| '()'
;
fragment RIGHT_HEAD
: '|>'
| '>'
| 'o'
| '*'
| '()'
;
fragment LINE_BODY
: '--'
| '..'
;
// Identifiers and numbers
IDENTIFIER
: (LETTER | DIGIT) IDENT_PART*
;
NUMBER: DIGIT+;
PLUS: '+';
MINUS: '-';
HASH: '#';
PERCENT: '%';
STAR: '*';
SLASH: '/';
LPAREN: '(';
RPAREN: ')';
// Structural braces with mode management
STRUCT_START
: '{'
{
if (this.pendingClassBody) {
this.pendingClassBody = false;
this.pushMode(ClassLexer.CLASS_BODY);
} else {
if (this.pendingNamespaceBody) {
this.pendingNamespaceBody = false;
}
this.pushMode(ClassLexer.BLOCK);
}
}
;
STRUCT_END: '}' { /* default mode only */ };
// Default fallback (should not normally trigger)
UNKNOWN: .;
// ===== Mode: ACC_TITLE =====
mode ACC_TITLE_MODE;
ACC_TITLE_MODE_WS: [ \t]+ -> skip;
ACC_TITLE_VALUE: ~[\r\n;#]+ -> type(ACC_TITLE_VALUE), popMode;
ACC_TITLE_MODE_NEWLINE: ('\r'? '\n')+ { this.popMode(); this.clearPendingScopes(); } -> type(NEWLINE);
// ===== Mode: ACC_DESCR =====
mode ACC_DESCR_MODE;
ACC_DESCR_MODE_WS: [ \t]+ -> skip;
ACC_DESCR_VALUE: ~[\r\n;#]+ -> type(ACC_DESCR_VALUE), popMode;
ACC_DESCR_MODE_NEWLINE: ('\r'? '\n')+ { this.popMode(); this.clearPendingScopes(); } -> type(NEWLINE);
// ===== Mode: ACC_DESCR_MULTILINE =====
mode ACC_DESCR_MULTILINE_MODE;
ACC_DESCR_MULTILINE_VALUE: (~[}])+ -> type(ACC_DESCR_MULTILINE_VALUE);
ACC_DESCR_MULTI_END: '}' -> popMode, type(ACC_DESCR_MULTI_END);
// ===== Mode: CLASS_BODY =====
mode CLASS_BODY;
CLASS_BODY_WS: [ \t]+ -> skip;
CLASS_BODY_COMMENT: '%%' ~[\r\n]* -> skip;
CLASS_BODY_NEWLINE: ('\r'? '\n')+ -> type(NEWLINE);
CLASS_BODY_STRUCT_END: '}' -> popMode, type(STRUCT_END);
CLASS_BODY_OPEN_BRACE: '{' -> type(OPEN_IN_STRUCT);
CLASS_BODY_EDGE_STATE: '[*]' -> type(EDGE_STATE);
CLASS_BODY_MEMBER: ~[{}\r\n]+ -> type(MEMBER);
// ===== Mode: BLOCK =====
mode BLOCK;
BLOCK_WS: [ \t]+ -> skip;
BLOCK_COMMENT: '%%' ~[\r\n]* -> skip;
BLOCK_NEWLINE: ('\r'? '\n')+ -> type(NEWLINE);
BLOCK_CLASS: 'class' { this.pendingClassBody = true; } -> type(CLASS);
BLOCK_NAMESPACE: 'namespace' { this.pendingNamespaceBody = true; } -> type(NAMESPACE);
BLOCK_STYLE_LINE: 'style' WS_INLINE+ ~[\r\n]* -> type(STYLE_LINE);
BLOCK_CLASSDEF_LINE: 'classDef' ~[\r\n]* -> type(CLASSDEF_LINE);
BLOCK_CSSCLASS_LINE: 'cssClass' ~[\r\n]* -> type(CSSCLASS_LINE);
BLOCK_CALLBACK_LINE: 'callback' ~[\r\n]* -> type(CALLBACK_LINE);
BLOCK_CLICK_LINE: 'click' ~[\r\n]* -> type(CLICK_LINE);
BLOCK_LINK_LINE: 'link' ~[\r\n]* -> type(LINK_LINE);
BLOCK_CALL_LINE: 'call' ~[\r\n]* -> type(CALL_LINE);
BLOCK_NOTE_FOR: 'note' WS_INLINE+ 'for' -> type(NOTE_FOR);
BLOCK_NOTE: 'note' -> type(NOTE);
BLOCK_ACC_TITLE: 'accTitle' WS_INLINE* ':' WS_INLINE* -> type(ACC_TITLE), pushMode(ACC_TITLE_MODE);
BLOCK_ACC_DESCR: 'accDescr' WS_INLINE* ':' WS_INLINE* -> type(ACC_DESCR), pushMode(ACC_DESCR_MODE);
BLOCK_ACC_DESCR_MULTI: 'accDescr' WS_INLINE* '{' -> type(ACC_DESCR_MULTI), pushMode(ACC_DESCR_MULTILINE_MODE);
BLOCK_STRUCT_START
: '{'
{
if (this.pendingClassBody) {
this.pendingClassBody = false;
this.pushMode(ClassLexer.CLASS_BODY);
} else {
if (this.pendingNamespaceBody) {
this.pendingNamespaceBody = false;
}
this.pushMode(ClassLexer.BLOCK);
}
}
-> type(STRUCT_START)
;
BLOCK_STRUCT_END: '}' -> popMode, type(STRUCT_END);
BLOCK_STYLE_SEPARATOR: ':::' -> type(STYLE_SEPARATOR);
BLOCK_ANNOTATION_START: '<<' -> type(ANNOTATION_START);
BLOCK_ANNOTATION_END: '>>' -> type(ANNOTATION_END);
BLOCK_LBRACKET: '[' -> type(LBRACKET);
BLOCK_RBRACKET: ']' -> type(RBRACKET);
BLOCK_COMMA: ',' -> type(COMMA);
BLOCK_DOT: '.' -> type(DOT);
BLOCK_EDGE_STATE: '[*]' -> type(EDGE_STATE);
BLOCK_GENERIC: '~' (~[~\r\n])+ '~' -> type(GENERIC);
// Mirror Jison: no escape semantics inside strings in BLOCK mode as well
BLOCK_STRING: '"' NOT_DQUOTE* '"' -> type(STRING);
BLOCK_BACKTICK_ID: '`' (~[`])* '`' -> type(BACKTICK_ID);
BLOCK_LABEL: ':' (~[':\r\n;])* -> type(LABEL);
BLOCK_RELATION_ARROW
: (LEFT_HEAD)? LINE_BODY (RIGHT_HEAD)?
-> type(RELATION_ARROW)
;
BLOCK_IDENTIFIER: (LETTER | DIGIT) IDENT_PART* -> type(IDENTIFIER);
BLOCK_NUMBER: DIGIT+ -> type(NUMBER);
BLOCK_PLUS: '+' -> type(PLUS);
BLOCK_MINUS: '-' -> type(MINUS);
BLOCK_HASH: '#' -> type(HASH);
BLOCK_PERCENT: '%' -> type(PERCENT);
BLOCK_STAR: '*' -> type(STAR);
BLOCK_SLASH: '/' -> type(SLASH);
BLOCK_LPAREN: '(' -> type(LPAREN);
BLOCK_RPAREN: ')' -> type(RPAREN);
BLOCK_UNKNOWN: . -> type(UNKNOWN);

View File

@@ -1,266 +0,0 @@
import type { ParseTreeListener } from 'antlr4ng';
import { ClassParserListener } from './generated/ClassParserListener.js';
import { ClassParserCore, type ClassDbLike } from './ClassParserCore.js';
import type {
ClassIdentifierContext,
ClassMembersContext,
ClassStatementContext,
NamespaceIdentifierContext,
NamespaceStatementContext,
RelationStatementContext,
NoteStatementContext,
AnnotationStatementContext,
MemberStatementContext,
ClassDefStatementContext,
StyleStatementContext,
CssClassStatementContext,
DirectionStatementContext,
AccTitleStatementContext,
AccDescrStatementContext,
AccDescrMultilineStatementContext,
CallbackStatementContext,
ClickStatementContext,
LinkStatementContext,
CallStatementContext,
} from './generated/ClassParser.js';
/**
* Class diagram listener implementation using the listener pattern
* Extends ClassParserCore for common parsing logic
*/
export class ClassListener extends ClassParserCore implements ParseTreeListener {
constructor(db: ClassDbLike) {
super(db);
}
// Standard ParseTreeListener methods
enterEveryRule = (_ctx: any) => {
// Optional: Add debug logging for rule entry
};
exitEveryRule = (_ctx: any) => {
// Optional: Add debug logging for rule exit
};
visitTerminal = (_node: any) => {
// Optional: Handle terminal nodes
};
visitErrorNode = (_node: any) => {
console.log('❌ ClassListener: Error node encountered');
// Throw error to match Jison parser behavior for syntax errors
throw new Error('Syntax error in class diagram');
};
// Listener method implementations that delegate to the core processing methods
enterNamespaceStatement = (_ctx: NamespaceStatementContext): void => {
console.log('🔧 ClassListener: Entering namespace statement');
try {
this.processNamespaceStatementEnter();
} catch (error) {
console.error('❌ ClassListener: Error entering namespace statement:', error);
throw error;
}
};
exitNamespaceIdentifier = (ctx: NamespaceIdentifierContext): void => {
console.log('🔧 ClassListener: Exiting namespace identifier');
try {
this.processNamespaceIdentifier(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing namespace identifier:', error);
throw error;
}
};
exitNamespaceStatement = (_ctx: NamespaceStatementContext): void => {
console.log('🔧 ClassListener: Exiting namespace statement');
try {
this.processNamespaceStatementExit();
} catch (error) {
console.error('❌ ClassListener: Error exiting namespace statement:', error);
throw error;
}
};
exitClassIdentifier = (ctx: ClassIdentifierContext): void => {
console.log('🔧 ClassListener: Exiting class identifier');
try {
this.processClassIdentifier(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing class identifier:', error);
throw error;
}
};
exitClassMembers = (ctx: ClassMembersContext): void => {
console.log('🔧 ClassListener: Exiting class members');
try {
this.processClassMembers(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing class members:', error);
throw error;
}
};
exitClassStatement = (ctx: ClassStatementContext): void => {
console.log('🔧 ClassListener: Exiting class statement');
try {
this.processClassStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing class statement:', error);
throw error;
}
};
exitRelationStatement = (ctx: RelationStatementContext): void => {
console.log('🔧 ClassListener: Exiting relation statement');
try {
this.processRelationStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing relation statement:', error);
throw error;
}
};
exitNoteStatement = (ctx: NoteStatementContext): void => {
console.log('🔧 ClassListener: Exiting note statement');
try {
this.processNoteStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing note statement:', error);
throw error;
}
};
exitAnnotationStatement = (ctx: AnnotationStatementContext): void => {
console.log('🔧 ClassListener: Exiting annotation statement');
try {
this.processAnnotationStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing annotation statement:', error);
throw error;
}
};
exitMemberStatement = (ctx: MemberStatementContext): void => {
console.log('🔧 ClassListener: Exiting member statement');
try {
this.processMemberStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing member statement:', error);
throw error;
}
};
exitClassDefStatement = (ctx: ClassDefStatementContext): void => {
console.log('🔧 ClassListener: Exiting classDef statement');
try {
this.processClassDefStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing classDef statement:', error);
throw error;
}
};
exitStyleStatement = (ctx: StyleStatementContext): void => {
console.log('🔧 ClassListener: Exiting style statement');
try {
this.processStyleStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing style statement:', error);
throw error;
}
};
exitCssClassStatement = (ctx: CssClassStatementContext): void => {
console.log('🔧 ClassListener: Exiting cssClass statement');
try {
this.processCssClassStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing cssClass statement:', error);
throw error;
}
};
exitDirectionStatement = (ctx: DirectionStatementContext): void => {
console.log('🔧 ClassListener: Exiting direction statement');
try {
this.processDirectionStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing direction statement:', error);
throw error;
}
};
exitAccTitleStatement = (ctx: AccTitleStatementContext): void => {
console.log('🔧 ClassListener: Exiting accTitle statement');
try {
this.processAccTitleStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing accTitle statement:', error);
throw error;
}
};
exitAccDescrStatement = (ctx: AccDescrStatementContext): void => {
console.log('🔧 ClassListener: Exiting accDescr statement');
try {
this.processAccDescrStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing accDescr statement:', error);
throw error;
}
};
exitAccDescrMultilineStatement = (ctx: AccDescrMultilineStatementContext): void => {
console.log('🔧 ClassListener: Exiting accDescr multiline statement');
try {
this.processAccDescrMultilineStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing accDescr multiline statement:', error);
throw error;
}
};
exitCallbackStatement = (ctx: CallbackStatementContext): void => {
console.log('🔧 ClassListener: Exiting callback statement');
try {
this.processCallbackStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing callback statement:', error);
throw error;
}
};
exitClickStatement = (ctx: ClickStatementContext): void => {
console.log('🔧 ClassListener: Exiting click statement');
try {
this.processClickStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing click statement:', error);
throw error;
}
};
exitLinkStatement = (ctx: LinkStatementContext): void => {
console.log('🔧 ClassListener: Exiting link statement');
try {
this.processLinkStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing link statement:', error);
throw error;
}
};
exitCallStatement = (ctx: CallStatementContext): void => {
console.log('🔧 ClassListener: Exiting call statement');
try {
this.processCallStatement(ctx);
} catch (error) {
console.error('❌ ClassListener: Error processing call statement:', error);
throw error;
}
};
}

View File

@@ -1,204 +0,0 @@
parser grammar ClassParser;
options {
tokenVocab = ClassLexer;
}
start
: (NEWLINE)* classDiagramSection EOF
;
classDiagramSection
: CLASS_DIAGRAM (NEWLINE)+ document
;
document
: (line)* statement?
;
line
: statement? NEWLINE
;
statement
: classStatement
| namespaceStatement
| relationStatement
| noteStatement
| annotationStatement
| memberStatement
| classDefStatement
| styleStatement
| cssClassStatement
| directionStatement
| accTitleStatement
| accDescrStatement
| accDescrMultilineStatement
| callbackStatement
| clickStatement
| linkStatement
| callStatement
;
classStatement
: classIdentifier classStatementTail?
;
classStatementTail
: STRUCT_START classMembers? STRUCT_END
| STYLE_SEPARATOR cssClassRef classStatementCssTail?
;
classStatementCssTail
: STRUCT_START classMembers? STRUCT_END
;
classIdentifier
: CLASS className classLabel?
;
classLabel
: LBRACKET stringLiteral RBRACKET
;
cssClassRef
: className
| IDENTIFIER
;
classMembers
: (NEWLINE | classMember)*
;
classMember
: MEMBER
| EDGE_STATE
;
namespaceStatement
: namespaceIdentifier namespaceBlock
;
namespaceIdentifier
: NAMESPACE namespaceName
;
namespaceName
: className
;
namespaceBlock
: STRUCT_START (NEWLINE)* namespaceBody? STRUCT_END
;
namespaceBody
: namespaceLine+
;
namespaceLine
: (classStatement | namespaceStatement)? NEWLINE
| classStatement
| namespaceStatement
;
relationStatement
: className relation className relationLabel?
| className stringLiteral relation className relationLabel?
| className relation stringLiteral className relationLabel?
| className stringLiteral relation stringLiteral className relationLabel?
;
relation
: RELATION_ARROW
;
relationLabel
: LABEL
;
noteStatement
: NOTE_FOR className noteBody
| NOTE noteBody
;
noteBody
: stringLiteral
;
annotationStatement
: ANNOTATION_START annotationName ANNOTATION_END className
;
annotationName
: IDENTIFIER
| stringLiteral
;
memberStatement
: className LABEL
;
classDefStatement
: CLASSDEF_LINE
;
styleStatement
: STYLE_LINE
;
cssClassStatement
: CSSCLASS_LINE
;
directionStatement
: DIRECTION_TB
| DIRECTION_BT
| DIRECTION_LR
| DIRECTION_RL
;
accTitleStatement
: ACC_TITLE ACC_TITLE_VALUE
;
accDescrStatement
: ACC_DESCR ACC_DESCR_VALUE
;
accDescrMultilineStatement
: ACC_DESCR_MULTI ACC_DESCR_MULTILINE_VALUE ACC_DESCR_MULTI_END
;
callbackStatement
: CALLBACK_LINE
;
clickStatement
: CLICK_LINE
;
linkStatement
: LINK_LINE
;
callStatement
: CALL_LINE
;
stringLiteral
: STRING
;
className
: classNameSegment (DOT classNameSegment)*
;
classNameSegment
: IDENTIFIER genericSuffix?
| BACKTICK_ID genericSuffix?
| EDGE_STATE
;
genericSuffix
: GENERIC
;

View File

@@ -1,610 +0,0 @@
import type {
ClassIdentifierContext,
ClassMembersContext,
ClassNameContext,
ClassNameSegmentContext,
ClassStatementContext,
NamespaceIdentifierContext,
RelationStatementContext,
NoteStatementContext,
AnnotationStatementContext,
MemberStatementContext,
ClassDefStatementContext,
StyleStatementContext,
CssClassStatementContext,
DirectionStatementContext,
AccTitleStatementContext,
AccDescrStatementContext,
AccDescrMultilineStatementContext,
CallbackStatementContext,
ClickStatementContext,
LinkStatementContext,
CallStatementContext,
CssClassRefContext,
StringLiteralContext,
} from './generated/ClassParser.js';
type ClassDbLike = Record<string, any>;
const stripQuotes = (value: string): string => {
const trimmed = value.trim();
if (trimmed.length >= 2 && trimmed.startsWith('"') && trimmed.endsWith('"')) {
try {
return JSON.parse(trimmed.replace(/\r?\n/g, '\\n')) as string;
} catch {
return trimmed.slice(1, -1).replace(/\\"/g, '"');
}
}
return trimmed;
};
const stripBackticks = (value: string): string => {
const trimmed = value.trim();
if (trimmed.length >= 2 && trimmed.startsWith('`') && trimmed.endsWith('`')) {
return trimmed.slice(1, -1);
}
return trimmed;
};
const splitCommaSeparated = (text: string): string[] =>
text
.split(',')
.map((part) => part.trim())
.filter((part) => part.length > 0);
const getStringFromLiteral = (ctx: StringLiteralContext | undefined | null): string | undefined => {
if (!ctx) {
return undefined;
}
return stripQuotes(ctx.getText());
};
const getClassNameText = (ctx: ClassNameContext): string => {
const segments = ctx.classNameSegment();
const parts: string[] = [];
for (const segment of segments) {
parts.push(getClassNameSegmentText(segment));
}
return parts.join('.');
};
const getClassNameSegmentText = (ctx: ClassNameSegmentContext): string => {
if (ctx.BACKTICK_ID()) {
return stripBackticks(ctx.BACKTICK_ID()!.getText());
}
if (ctx.EDGE_STATE()) {
return ctx.EDGE_STATE()!.getText();
}
return ctx.getText();
};
const parseRelationArrow = (arrow: string, db: ClassDbLike) => {
const relation = {
type1: 'none',
type2: 'none',
lineType: db.lineType?.LINE ?? 0,
};
const trimmed = arrow.trim();
if (trimmed.includes('..')) {
relation.lineType = db.lineType?.DOTTED_LINE ?? relation.lineType;
}
const leftHeads: [string, keyof typeof db.relationType][] = [
['<|', 'EXTENSION'],
['()', 'LOLLIPOP'],
['o', 'AGGREGATION'],
['*', 'COMPOSITION'],
['<', 'DEPENDENCY'],
];
for (const [prefix, key] of leftHeads) {
if (trimmed.startsWith(prefix)) {
relation.type1 = db.relationType?.[key] ?? relation.type1;
break;
}
}
const rightHeads: [string, keyof typeof db.relationType][] = [
['|>', 'EXTENSION'],
['()', 'LOLLIPOP'],
['o', 'AGGREGATION'],
['*', 'COMPOSITION'],
['>', 'DEPENDENCY'],
];
for (const [suffix, key] of rightHeads) {
if (trimmed.endsWith(suffix)) {
relation.type2 = db.relationType?.[key] ?? relation.type2;
break;
}
}
return relation;
};
const parseStyleLine = (db: ClassDbLike, line: string) => {
const trimmed = line.trim();
const body = trimmed.slice('style'.length).trim();
if (!body) {
return;
}
const match = /^(\S+)(\s+.+)?$/.exec(body);
if (!match) {
return;
}
const classId = match[1];
const styleBody = match[2]?.trim() ?? '';
if (!styleBody) {
return;
}
const styles = splitCommaSeparated(styleBody);
if (styles.length) {
db.setCssStyle?.(classId, styles);
}
};
const parseClassDefLine = (db: ClassDbLike, line: string) => {
const trimmed = line.trim();
const body = trimmed.slice('classDef'.length).trim();
if (!body) {
return;
}
const match = /^(\S+)(\s+.+)?$/.exec(body);
if (!match) {
return;
}
const idPart = match[1];
const stylePart = match[2]?.trim() ?? '';
const ids = splitCommaSeparated(idPart);
const styles = stylePart ? splitCommaSeparated(stylePart) : [];
db.defineClass?.(ids, styles);
};
const parseCssClassLine = (db: ClassDbLike, line: string) => {
const trimmed = line.trim();
const body = trimmed.slice('cssClass'.length).trim();
if (!body) {
return;
}
const match = /^("[^"]*"|\S+)\s+(\S+)/.exec(body);
if (!match) {
return;
}
const idsRaw = stripQuotes(match[1]);
const className = match[2];
db.setCssClass?.(idsRaw, className);
};
const parseCallbackLine = (db: ClassDbLike, line: string) => {
const trimmed = line.trim();
const match = /^callback\s+(\S+)\s+("[^"]*")(?:\s+("[^"]*"))?\s*$/.exec(trimmed);
if (!match) {
return;
}
const target = match[1];
const fn = stripQuotes(match[2]);
const tooltip = match[3] ? stripQuotes(match[3]) : undefined;
db.setClickEvent?.(target, fn);
if (tooltip) {
db.setTooltip?.(target, tooltip);
}
};
const parseClickLine = (db: ClassDbLike, line: string) => {
const trimmed = line.trim();
const callMatch = /^click\s+(\S+)\s+call\s+([^(]+)\(([^)]*)\)(?:\s+("[^"]*"))?\s*$/.exec(trimmed);
if (callMatch) {
const target = callMatch[1];
const fnName = callMatch[2].trim();
const args = callMatch[3].trim();
const tooltip = callMatch[4] ? stripQuotes(callMatch[4]) : undefined;
if (args.length > 0) {
db.setClickEvent?.(target, fnName, args);
} else {
db.setClickEvent?.(target, fnName);
}
if (tooltip) {
db.setTooltip?.(target, tooltip);
}
return target;
}
const hrefMatch = /^click\s+(\S+)\s+href\s+("[^"]*")(?:\s+("[^"]*"))?(?:\s+(\S+))?\s*$/.exec(
trimmed
);
if (hrefMatch) {
const target = hrefMatch[1];
const url = stripQuotes(hrefMatch[2]);
const tooltip = hrefMatch[3] ? stripQuotes(hrefMatch[3]) : undefined;
const targetWindow = hrefMatch[4];
if (targetWindow) {
db.setLink?.(target, url, targetWindow);
} else {
db.setLink?.(target, url);
}
if (tooltip) {
db.setTooltip?.(target, tooltip);
}
return target;
}
const genericMatch = /^click\s+(\S+)\s+("[^"]*")(?:\s+("[^"]*"))?\s*$/.exec(trimmed);
if (genericMatch) {
const target = genericMatch[1];
const link = stripQuotes(genericMatch[2]);
const tooltip = genericMatch[3] ? stripQuotes(genericMatch[3]) : undefined;
db.setLink?.(target, link);
if (tooltip) {
db.setTooltip?.(target, tooltip);
}
return target;
}
return undefined;
};
const parseLinkLine = (db: ClassDbLike, line: string) => {
const trimmed = line.trim();
const match = /^link\s+(\S+)\s+("[^"]*")(?:\s+("[^"]*"))?(?:\s+(\S+))?\s*$/.exec(trimmed);
if (!match) {
return;
}
const target = match[1];
const href = stripQuotes(match[2]);
const tooltip = match[3] ? stripQuotes(match[3]) : undefined;
const targetWindow = match[4];
if (targetWindow) {
db.setLink?.(target, href, targetWindow);
} else {
db.setLink?.(target, href);
}
if (tooltip) {
db.setTooltip?.(target, tooltip);
}
};
const parseCallLine = (db: ClassDbLike, lastTarget: string | undefined, line: string) => {
if (!lastTarget) {
return;
}
const trimmed = line.trim();
const match = /^call\s+([^(]+)\(([^)]*)\)\s*("[^"]*")?\s*$/.exec(trimmed);
if (!match) {
return;
}
const fnName = match[1].trim();
const args = match[2].trim();
const tooltip = match[3] ? stripQuotes(match[3]) : undefined;
if (args.length > 0) {
db.setClickEvent?.(lastTarget, fnName, args);
} else {
db.setClickEvent?.(lastTarget, fnName);
}
if (tooltip) {
db.setTooltip?.(lastTarget, tooltip);
}
};
interface NamespaceFrame {
name?: string;
classes: string[];
}
/**
* Base class containing common parsing logic for class diagrams
* Used by both Visitor and Listener pattern implementations
*/
export abstract class ClassParserCore {
protected readonly classNames = new WeakMap<ClassIdentifierContext, string>();
protected readonly memberLists = new WeakMap<ClassMembersContext, string[]>();
protected readonly namespaceStack: NamespaceFrame[] = [];
protected lastClickTarget?: string;
constructor(protected readonly db: ClassDbLike) {}
protected recordClassInCurrentNamespace(name: string) {
const current = this.namespaceStack[this.namespaceStack.length - 1];
if (current?.name) {
current.classes.push(name);
}
}
protected resolveCssClassRef(ctx: CssClassRefContext): string | undefined {
if (ctx.className()) {
return getClassNameText(ctx.className()!);
}
if (ctx.IDENTIFIER()) {
return ctx.IDENTIFIER()!.getText();
}
return undefined;
}
// Processing methods that can be called by both Visitor and Listener patterns
processNamespaceStatementEnter(): void {
this.namespaceStack.push({ classes: [] });
}
processNamespaceIdentifier(ctx: NamespaceIdentifierContext): void {
const frame = this.namespaceStack[this.namespaceStack.length - 1];
if (!frame) {
return;
}
const classNameCtx = ctx.namespaceName()?.className();
if (!classNameCtx) {
return;
}
const name = getClassNameText(classNameCtx);
frame.name = name;
this.db.addNamespace?.(name);
}
processNamespaceStatementExit(): void {
const frame = this.namespaceStack.pop();
if (!frame?.name) {
return;
}
if (frame.classes.length) {
this.db.addClassesToNamespace?.(frame.name, frame.classes);
}
}
processClassIdentifier(ctx: ClassIdentifierContext): void {
const id = getClassNameText(ctx.className());
this.classNames.set(ctx, id);
this.db.addClass?.(id);
this.recordClassInCurrentNamespace(id);
const labelCtx = ctx.classLabel?.();
if (labelCtx) {
const label = getStringFromLiteral(labelCtx.stringLiteral());
if (label !== undefined) {
this.db.setClassLabel?.(id, label);
}
}
}
processClassMembers(ctx: ClassMembersContext): void {
const members: string[] = [];
for (const memberCtx of ctx.classMember() ?? []) {
if (memberCtx.MEMBER()) {
members.push(memberCtx.MEMBER()!.getText());
} else if (memberCtx.EDGE_STATE()) {
members.push(memberCtx.EDGE_STATE()!.getText());
}
}
members.reverse();
this.memberLists.set(ctx, members);
}
processClassStatement(ctx: ClassStatementContext): void {
const identifierCtx = ctx.classIdentifier();
if (!identifierCtx) {
return;
}
const classId = this.classNames.get(identifierCtx);
if (!classId) {
return;
}
const tailCtx = ctx.classStatementTail?.();
const cssRefCtx = tailCtx?.cssClassRef?.();
if (cssRefCtx) {
const cssTarget = this.resolveCssClassRef(cssRefCtx);
if (cssTarget) {
this.db.setCssClass?.(classId, cssTarget);
}
}
const memberContexts: ClassMembersContext[] = [];
const cm1 = tailCtx?.classMembers();
if (cm1) {
memberContexts.push(cm1);
}
const cssTailCtx = tailCtx?.classStatementCssTail?.();
const cm2 = cssTailCtx?.classMembers();
if (cm2) {
memberContexts.push(cm2);
}
for (const membersCtx of memberContexts) {
const members = this.memberLists.get(membersCtx) ?? [];
if (members.length) {
this.db.addMembers?.(classId, members);
}
}
}
processRelationStatement(ctx: RelationStatementContext): void {
const classNames = ctx.className();
if (classNames.length < 2) {
return;
}
const id1 = getClassNameText(classNames[0]);
const id2 = getClassNameText(classNames[classNames.length - 1]);
const arrow = ctx.relation()?.getText() ?? '';
const relation = parseRelationArrow(arrow, this.db);
let relationTitle1 = 'none';
let relationTitle2 = 'none';
const stringLiterals = ctx.stringLiteral();
if (stringLiterals.length === 1 && ctx.children) {
const stringCtx = stringLiterals[0];
const children = ctx.children as unknown[];
const stringIndex = children.indexOf(stringCtx);
const relationCtx = ctx.relation();
const relationIndex = relationCtx ? children.indexOf(relationCtx) : -1;
if (relationIndex >= 0 && stringIndex >= 0 && stringIndex < relationIndex) {
relationTitle1 = getStringFromLiteral(stringCtx) ?? 'none';
} else {
relationTitle2 = getStringFromLiteral(stringCtx) ?? 'none';
}
} else if (stringLiterals.length >= 2) {
relationTitle1 = getStringFromLiteral(stringLiterals[0]) ?? 'none';
relationTitle2 = getStringFromLiteral(stringLiterals[1]) ?? 'none';
}
let title = 'none';
const labelCtx = ctx.relationLabel?.();
if (labelCtx?.LABEL()) {
title = this.db.cleanupLabel?.(labelCtx.LABEL().getText()) ?? 'none';
}
this.db.addRelation?.({
id1,
id2,
relation,
relationTitle1,
relationTitle2,
title,
});
}
processNoteStatement(ctx: NoteStatementContext): void {
const noteCtx = ctx.noteBody();
const literalText = noteCtx?.getText?.();
const text = literalText !== undefined ? stripQuotes(literalText) : undefined;
if (text === undefined) {
return;
}
if (ctx.NOTE_FOR()) {
const className = getClassNameText(ctx.className()!);
this.db.addNote?.(text, className);
} else {
this.db.addNote?.(text);
}
}
processAnnotationStatement(ctx: AnnotationStatementContext): void {
const className = getClassNameText(ctx.className());
const nameCtx = ctx.annotationName();
let annotation: string | undefined;
if (nameCtx.IDENTIFIER()) {
annotation = nameCtx.IDENTIFIER()!.getText();
} else {
annotation = getStringFromLiteral(nameCtx.stringLiteral());
}
if (annotation !== undefined) {
this.db.addAnnotation?.(className, annotation);
}
}
processMemberStatement(ctx: MemberStatementContext): void {
const className = getClassNameText(ctx.className());
const labelToken = ctx.LABEL();
if (!labelToken) {
return;
}
const cleaned = this.db.cleanupLabel?.(labelToken.getText()) ?? labelToken.getText();
this.db.addMember?.(className, cleaned);
}
processClassDefStatement(ctx: ClassDefStatementContext): void {
const token = ctx.CLASSDEF_LINE()?.getSymbol()?.text;
if (token) {
parseClassDefLine(this.db, token);
}
}
processStyleStatement(ctx: StyleStatementContext): void {
const token = ctx.STYLE_LINE()?.getSymbol()?.text;
if (token) {
parseStyleLine(this.db, token);
}
}
processCssClassStatement(ctx: CssClassStatementContext): void {
const token = ctx.CSSCLASS_LINE()?.getSymbol()?.text;
if (token) {
parseCssClassLine(this.db, token);
}
}
processDirectionStatement(ctx: DirectionStatementContext): void {
if (ctx.DIRECTION_TB()) {
this.db.setDirection?.('TB');
} else if (ctx.DIRECTION_BT()) {
this.db.setDirection?.('BT');
} else if (ctx.DIRECTION_LR()) {
this.db.setDirection?.('LR');
} else if (ctx.DIRECTION_RL()) {
this.db.setDirection?.('RL');
}
}
processAccTitleStatement(ctx: AccTitleStatementContext): void {
const value = ctx.ACC_TITLE_VALUE()?.getText();
if (value !== undefined) {
this.db.setAccTitle?.(value.trim());
}
}
processAccDescrStatement(ctx: AccDescrStatementContext): void {
const value = ctx.ACC_DESCR_VALUE()?.getText();
if (value !== undefined) {
this.db.setAccDescription?.(value.trim());
}
}
processAccDescrMultilineStatement(ctx: AccDescrMultilineStatementContext): void {
const value = ctx.ACC_DESCR_MULTILINE_VALUE()?.getText();
if (value !== undefined) {
this.db.setAccDescription?.(value.trim());
}
}
processCallbackStatement(ctx: CallbackStatementContext): void {
const token = ctx.CALLBACK_LINE()?.getSymbol()?.text;
if (token) {
parseCallbackLine(this.db, token);
}
}
processClickStatement(ctx: ClickStatementContext): void {
const token = ctx.CLICK_LINE()?.getSymbol()?.text;
if (!token) {
return;
}
const target = parseClickLine(this.db, token);
if (target) {
this.lastClickTarget = target;
}
}
processLinkStatement(ctx: LinkStatementContext): void {
const token = ctx.LINK_LINE()?.getSymbol()?.text;
if (token) {
parseLinkLine(this.db, token);
}
}
processCallStatement(ctx: CallStatementContext): void {
const token = ctx.CALL_LINE()?.getSymbol()?.text;
if (token) {
parseCallLine(this.db, this.lastClickTarget, token);
}
}
}
// Export utility functions for use by other modules
export {
stripQuotes,
stripBackticks,
splitCommaSeparated,
getStringFromLiteral,
getClassNameText,
getClassNameSegmentText,
parseRelationArrow,
parseStyleLine,
parseClassDefLine,
parseCssClassLine,
parseCallbackLine,
parseClickLine,
parseLinkLine,
parseCallLine,
type ClassDbLike,
type NamespaceFrame,
};

View File

@@ -1,303 +0,0 @@
import { ClassParserVisitor } from './generated/ClassParserVisitor.js';
import { ClassParserCore, type ClassDbLike } from './ClassParserCore.js';
import type {
ClassIdentifierContext,
ClassMembersContext,
ClassStatementContext,
NamespaceIdentifierContext,
NamespaceStatementContext,
RelationStatementContext,
NoteStatementContext,
AnnotationStatementContext,
MemberStatementContext,
ClassDefStatementContext,
StyleStatementContext,
CssClassStatementContext,
DirectionStatementContext,
AccTitleStatementContext,
AccDescrStatementContext,
AccDescrMultilineStatementContext,
CallbackStatementContext,
ClickStatementContext,
LinkStatementContext,
CallStatementContext,
} from './generated/ClassParser.js';
/**
* Class diagram visitor implementation using the visitor pattern
* Extends ClassParserCore for common parsing logic
*/
export class ClassVisitor extends ClassParserCore {
private visitor: ClassParserVisitor<any>;
constructor(db: ClassDbLike) {
super(db);
this.visitor = new ClassParserVisitor<any>();
// Override visitor methods to call our processing methods
this.visitor.visitNamespaceStatement = this.visitNamespaceStatement.bind(this);
this.visitor.visitNamespaceIdentifier = this.visitNamespaceIdentifier.bind(this);
this.visitor.visitClassIdentifier = this.visitClassIdentifier.bind(this);
this.visitor.visitClassMembers = this.visitClassMembers.bind(this);
this.visitor.visitClassStatement = this.visitClassStatement.bind(this);
this.visitor.visitRelationStatement = this.visitRelationStatement.bind(this);
this.visitor.visitNoteStatement = this.visitNoteStatement.bind(this);
this.visitor.visitAnnotationStatement = this.visitAnnotationStatement.bind(this);
this.visitor.visitMemberStatement = this.visitMemberStatement.bind(this);
this.visitor.visitClassDefStatement = this.visitClassDefStatement.bind(this);
this.visitor.visitStyleStatement = this.visitStyleStatement.bind(this);
this.visitor.visitCssClassStatement = this.visitCssClassStatement.bind(this);
this.visitor.visitDirectionStatement = this.visitDirectionStatement.bind(this);
this.visitor.visitAccTitleStatement = this.visitAccTitleStatement.bind(this);
this.visitor.visitAccDescrStatement = this.visitAccDescrStatement.bind(this);
this.visitor.visitAccDescrMultilineStatement = this.visitAccDescrMultilineStatement.bind(this);
this.visitor.visitCallbackStatement = this.visitCallbackStatement.bind(this);
this.visitor.visitClickStatement = this.visitClickStatement.bind(this);
this.visitor.visitLinkStatement = this.visitLinkStatement.bind(this);
this.visitor.visitCallStatement = this.visitCallStatement.bind(this);
this.visitor.visitErrorNode = this.visitErrorNode.bind(this);
}
/**
* Visit the parse tree using the visitor pattern
*/
visit(tree: any): any {
return this.visitor.visit(tree);
}
// Visitor method implementations that delegate to the core processing methods
visitNamespaceStatement(ctx: NamespaceStatementContext): any {
console.log('🔧 ClassVisitor: Processing namespace statement');
try {
this.processNamespaceStatementEnter();
// Visit children first
const result = this.visitor.visitChildren?.(ctx);
this.processNamespaceStatementExit();
return result;
} catch (error) {
console.error('❌ ClassVisitor: Error processing namespace statement:', error);
throw error;
}
}
visitNamespaceIdentifier(ctx: NamespaceIdentifierContext): any {
console.log('🔧 ClassVisitor: Processing namespace identifier');
try {
this.processNamespaceIdentifier(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing namespace identifier:', error);
throw error;
}
}
visitClassIdentifier(ctx: ClassIdentifierContext): any {
console.log('🔧 ClassVisitor: Processing class identifier');
try {
this.processClassIdentifier(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing class identifier:', error);
throw error;
}
}
visitClassMembers(ctx: ClassMembersContext): any {
console.log('🔧 ClassVisitor: Processing class members');
try {
this.processClassMembers(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing class members:', error);
throw error;
}
}
visitClassStatement(ctx: ClassStatementContext): any {
console.log('🔧 ClassVisitor: Processing class statement');
try {
// Visit children first to populate member lists
const result = this.visitor.visitChildren?.(ctx);
this.processClassStatement(ctx);
return result;
} catch (error) {
console.error('❌ ClassVisitor: Error processing class statement:', error);
throw error;
}
}
visitRelationStatement(ctx: RelationStatementContext): any {
console.log('🔧 ClassVisitor: Processing relation statement');
try {
this.processRelationStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing relation statement:', error);
throw error;
}
}
visitNoteStatement(ctx: NoteStatementContext): any {
console.log('🔧 ClassVisitor: Processing note statement');
try {
this.processNoteStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing note statement:', error);
throw error;
}
}
visitAnnotationStatement(ctx: AnnotationStatementContext): any {
console.log('🔧 ClassVisitor: Processing annotation statement');
try {
this.processAnnotationStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing annotation statement:', error);
throw error;
}
}
visitMemberStatement(ctx: MemberStatementContext): any {
console.log('🔧 ClassVisitor: Processing member statement');
try {
this.processMemberStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing member statement:', error);
throw error;
}
}
visitClassDefStatement(ctx: ClassDefStatementContext): any {
console.log('🔧 ClassVisitor: Processing classDef statement');
try {
this.processClassDefStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing classDef statement:', error);
throw error;
}
}
visitStyleStatement(ctx: StyleStatementContext): any {
console.log('🔧 ClassVisitor: Processing style statement');
try {
this.processStyleStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing style statement:', error);
throw error;
}
}
visitCssClassStatement(ctx: CssClassStatementContext): any {
console.log('🔧 ClassVisitor: Processing cssClass statement');
try {
this.processCssClassStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing cssClass statement:', error);
throw error;
}
}
visitDirectionStatement(ctx: DirectionStatementContext): any {
console.log('🔧 ClassVisitor: Processing direction statement');
try {
this.processDirectionStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing direction statement:', error);
throw error;
}
}
visitAccTitleStatement(ctx: AccTitleStatementContext): any {
console.log('🔧 ClassVisitor: Processing accTitle statement');
try {
this.processAccTitleStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing accTitle statement:', error);
throw error;
}
}
visitAccDescrStatement(ctx: AccDescrStatementContext): any {
console.log('🔧 ClassVisitor: Processing accDescr statement');
try {
this.processAccDescrStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing accDescr statement:', error);
throw error;
}
}
visitAccDescrMultilineStatement(ctx: AccDescrMultilineStatementContext): any {
console.log('🔧 ClassVisitor: Processing accDescr multiline statement');
try {
this.processAccDescrMultilineStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing accDescr multiline statement:', error);
throw error;
}
}
visitCallbackStatement(ctx: CallbackStatementContext): any {
console.log('🔧 ClassVisitor: Processing callback statement');
try {
this.processCallbackStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing callback statement:', error);
throw error;
}
}
visitClickStatement(ctx: ClickStatementContext): any {
console.log('🔧 ClassVisitor: Processing click statement');
try {
this.processClickStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing click statement:', error);
throw error;
}
}
visitLinkStatement(ctx: LinkStatementContext): any {
console.log('🔧 ClassVisitor: Processing link statement');
try {
this.processLinkStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing link statement:', error);
throw error;
}
}
visitCallStatement(ctx: CallStatementContext): any {
console.log('🔧 ClassVisitor: Processing call statement');
try {
this.processCallStatement(ctx);
return this.visitor.visitChildren?.(ctx);
} catch (error) {
console.error('❌ ClassVisitor: Error processing call statement:', error);
throw error;
}
}
visitErrorNode(_node: any): any {
console.log('❌ ClassVisitor: Error node encountered');
// Throw error to match Jison parser behavior for syntax errors
throw new Error('Syntax error in class diagram');
}
}

View File

@@ -1,182 +0,0 @@
import {
BailErrorStrategy,
CharStream,
CommonTokenStream,
ParseCancellationException,
ParseTreeWalker,
RecognitionException,
type Token,
} from 'antlr4ng';
import { ClassParser } from './generated/ClassParser.js';
import { ClassLexer } from './generated/ClassLexer.js';
import { ClassVisitor } from './ClassVisitor.js';
import { ClassListener } from './ClassListener.js';
import type { ClassDbLike } from './ClassParserCore.js';
// Browser-safe environment variable access (same as sequence parser)
const getEnvVar = (name: string): string | undefined => {
try {
if (typeof process !== 'undefined' && process.env) {
return process.env[name];
}
} catch (_e) {
// process is not defined in browser, continue to browser checks
}
// In browser, check for global variables
if (typeof window !== 'undefined' && (window as any).MERMAID_CONFIG) {
return (window as any).MERMAID_CONFIG[name];
}
return undefined;
};
class ANTLRClassParser {
yy: ClassDbLike | null = null;
parse(input: string): unknown {
if (!this.yy) {
throw new Error('Class ANTLR parser missing yy (database).');
}
// eslint-disable-next-line no-console
console.log('🔧 ClassParser: USE_ANTLR_PARSER = true');
// eslint-disable-next-line no-console
console.log('🔧 ClassParser: Selected parser: ANTLR');
this.yy.clear?.();
const inputStream = CharStream.fromString(input);
const lexer = new ClassLexer(inputStream);
const tokenStream = new CommonTokenStream(lexer);
const parser = new ClassParser(tokenStream);
const anyParser = parser as unknown as {
getErrorHandler?: () => unknown;
setErrorHandler?: (handler: unknown) => void;
errorHandler?: unknown;
};
const currentHandler = anyParser.getErrorHandler?.() ?? anyParser.errorHandler;
const handlerName = (currentHandler as { constructor?: { name?: string } } | undefined)
?.constructor?.name;
if (!currentHandler || handlerName !== 'BailErrorStrategy') {
if (typeof anyParser.setErrorHandler === 'function') {
anyParser.setErrorHandler(new BailErrorStrategy());
} else {
(parser as unknown as { errorHandler: unknown }).errorHandler = new BailErrorStrategy();
}
}
try {
const tree = parser.start();
// Check if we should use Visitor or Listener pattern
// Default to Visitor pattern (true) unless explicitly set to false
const useVisitorPattern = getEnvVar('USE_ANTLR_VISITOR') !== 'false';
// eslint-disable-next-line no-console
console.log('🔧 ClassParser: Pattern =', useVisitorPattern ? 'Visitor' : 'Listener');
if (useVisitorPattern) {
const visitor = new ClassVisitor(this.yy);
visitor.visit(tree);
} else {
const listener = new ClassListener(this.yy);
ParseTreeWalker.DEFAULT.walk(listener, tree);
}
return tree;
} catch (error) {
// eslint-disable-next-line no-console
console.error('❌ ANTLR Class Parser: Parse failed:', error);
throw this.transformParseError(error, parser);
}
}
private transformParseError(error: unknown, parser: ClassParser): Error {
const recognitionError = this.unwrapRecognitionError(error);
const offendingToken = this.resolveOffendingToken(recognitionError, parser);
const line = offendingToken?.line ?? 0;
const column = offendingToken?.column ?? 0;
const message = `Parse error on line ${line}: Expecting 'STR'`;
const cause = error instanceof Error ? error : undefined;
const formatted = cause ? new Error(message, { cause }) : new Error(message);
Object.assign(formatted, {
hash: {
line,
loc: {
first_line: line,
last_line: line,
first_column: column,
last_column: column,
},
text: offendingToken?.text ?? '',
},
});
return formatted;
}
private unwrapRecognitionError(error: unknown): RecognitionException | undefined {
if (!error) {
return undefined;
}
if (error instanceof RecognitionException) {
return error;
}
if (error instanceof ParseCancellationException) {
const cause = (error as { cause?: unknown }).cause;
if (cause instanceof RecognitionException) {
return cause;
}
}
if (typeof error === 'object' && error !== null && 'cause' in error) {
const cause = (error as { cause?: unknown }).cause;
if (cause instanceof RecognitionException) {
return cause;
}
}
return undefined;
}
private resolveOffendingToken(
error: RecognitionException | undefined,
parser: ClassParser
): Token | undefined {
const candidate = (error as { offendingToken?: Token })?.offendingToken;
if (candidate) {
return candidate;
}
const current = (
parser as unknown as { getCurrentToken?: () => Token | undefined }
).getCurrentToken?.();
if (current) {
return current;
}
const stream = (
parser as unknown as { _input?: { LT?: (offset: number) => Token | undefined } }
)._input;
return stream?.LT?.(1);
}
}
const parserInstance = new ANTLRClassParser();
const exportedParser = {
parse: (text: string) => parserInstance.parse(text),
parser: parserInstance,
yy: null as ClassDbLike | null,
};
Object.defineProperty(exportedParser, 'yy', {
get() {
return parserInstance.yy;
},
set(value: ClassDbLike | null) {
parserInstance.yy = value;
},
});
export default exportedParser;

View File

@@ -1,31 +0,0 @@
// @ts-ignore: JISON parser lacks type definitions
import jisonParser from './classDiagram.jison';
import antlrParser from './antlr/antlr-parser.js';
const USE_ANTLR_PARSER = process.env.USE_ANTLR_PARSER === 'true';
const baseParser: any = USE_ANTLR_PARSER ? antlrParser : jisonParser;
const selectedParser: any = Object.create(baseParser);
selectedParser.parse = (source: string): unknown => {
const normalized = source.replace(/\r\n/g, '\n');
if (USE_ANTLR_PARSER) {
return antlrParser.parse(normalized);
}
return jisonParser.parse(normalized);
};
Object.defineProperty(selectedParser, 'yy', {
get() {
return baseParser.yy;
},
set(value) {
baseParser.yy = value;
},
enumerable: true,
configurable: true,
});
export default selectedParser;
export const parser = selectedParser;

View File

@@ -13,6 +13,30 @@ const getStyles = (options) =>
}
.cluster-label text {
fill: ${options.titleColor};
}
.cluster-label span {
color: ${options.titleColor};
}
.cluster-label span p {
background-color: transparent;
}
.cluster rect {
fill: ${options.clusterBkg};
stroke: ${options.clusterBorder};
stroke-width: 1px;
}
.cluster text {
fill: ${options.titleColor};
}
.cluster span {
color: ${options.titleColor};
}
.nodeLabel, .edgeLabel {
color: ${options.classText};
}

View File

@@ -1,25 +0,0 @@
lexer grammar HeaderCommon;
@members {
// headerMode is true until the diagram header keyword is seen
protected headerMode = true;
// Helper to disable header mode from delegator lexers on diagram start
protected disableHeaderMode(): void { this.headerMode = false; }
}
// Header directives: only before the diagram header keyword has been seen
// Accept optional leading spaces/tabs on the line before the directive
HEADER_DIRECTIVE: { this.headerMode }? [ \t]* '%%{' .*? '}%%';
// YAML front matter (allowed only before the diagram header)
// Use a dedicated mode to consume until the closing '---' line
FRONTMATTER: { this.headerMode }? [ \t]* '---' [ \t]* ('\r'? '\n') -> pushMode(YAML_MODE);
mode YAML_MODE;
YAML_END: [ \t]* '---' [ \t]* ('\r'? '\n') -> popMode, skip;
YAML_CONTENT: . -> skip;
// Comments (skip) - simple, broad handling; rely on longest-match to keep HEADER_DIRECTIVE intact
HASH_COMMENT: '#' ~[\r\n]* -> skip;
PERCENT_COMMENT: '%%' ~[\r\n]* -> skip;

View File

@@ -66,12 +66,15 @@ accDescr\s*"{"\s* { this.begin("acc_descr_multili
\}\| return 'ONE_OR_MORE';
"one" return 'ONLY_ONE';
"only one" return 'ONLY_ONE';
"1" return 'ONLY_ONE';
[0-9]+\.[0-9]+ return 'DECIMAL_NUM';
"1"(?=\s+[A-Za-z_"']) return 'ONLY_ONE';
"1" return 'ENTITY_ONE';
[0-9]+ return 'NUM';
\|\| return 'ONLY_ONE';
o\| return 'ZERO_OR_ONE';
o\{ return 'ZERO_OR_MORE';
\|\{ return 'ONE_OR_MORE';
\s*u return 'MD_PARENT';
u(?=[\.\-\|]) return 'MD_PARENT';
\.\. return 'NON_IDENTIFYING';
\-\- return 'IDENTIFYING';
"to" return 'IDENTIFYING';
@@ -80,13 +83,15 @@ o\{ return 'ZERO_OR_MORE';
\-\. return 'NON_IDENTIFYING';
<style>([^\x00-\x7F]|\w|\-|\*)+ return 'STYLE_TEXT';
<style>';' return 'SEMI';
([^\x00-\x7F]|\w|\-|\*)+ return 'UNICODE_TEXT';
[0-9] return 'NUM';
([^\x00-\x7F]|\w|\-|\*|\.)+ return 'UNICODE_TEXT';
. return yytext[0];
<<EOF>> return 'EOF';
/lex
%left 'ONLY_ONE'
%left 'ZERO_OR_ONE' 'ZERO_OR_MORE' 'ONE_OR_MORE' 'MD_PARENT'
%start start
%% /* language grammar */
@@ -228,6 +233,9 @@ styleComponent: STYLE_TEXT | NUM | COLON | BRKT;
entityName
: 'ENTITY_NAME' { $$ = $1.replace(/"/g, ''); }
| 'UNICODE_TEXT' { $$ = $1; }
| 'NUM' { $$ = $1; }
| 'DECIMAL_NUM' { $$ = $1; }
| 'ENTITY_ONE' { $$ = $1; }
;
attributes

View File

@@ -1001,4 +1001,90 @@ describe('when parsing ER diagram it...', function () {
}
);
});
describe('syntax fixes for special characters and numbers', function () {
describe('standalone entity names', function () {
it('should allow number "1" as standalone entity', function () {
erDiagram.parser.parse(`erDiagram\nCUSTOMER }|..|{ DELIVERY-ADDRESS : has\n1`);
});
it('should allow character "u" as standalone entity', function () {
erDiagram.parser.parse(`erDiagram\nCUSTOMER }|..|{ DELIVERY-ADDRESS : has\nu`);
});
it('should allow decimal numbers as standalone entities', function () {
erDiagram.parser.parse(`erDiagram\nCUSTOMER }|..|{ DELIVERY-ADDRESS : has\n2.5`);
erDiagram.parser.parse(`erDiagram\nCUSTOMER }|..|{ DELIVERY-ADDRESS : has\n1.5`);
erDiagram.parser.parse(`erDiagram\nCUSTOMER }|..|{ DELIVERY-ADDRESS : has\n0.1`);
erDiagram.parser.parse(`erDiagram\nCUSTOMER }|..|{ DELIVERY-ADDRESS : has\n99.99`);
});
});
describe('entity names with attributes', function () {
it('should allow "u" as entity name with attributes', function () {
erDiagram.parser.parse(`erDiagram\nu {\nstring name\nint id\n}`);
});
it('should allow number "1" as entity name with attributes', function () {
erDiagram.parser.parse(`erDiagram\n1 {\nstring name\nint id\n}`);
});
it('should allow decimal numbers as entity names with attributes', function () {
erDiagram.parser.parse(`erDiagram\n2.5 {\nstring name\nint id\n}`);
erDiagram.parser.parse(`erDiagram\n1.5 {\nstring value\n}`);
});
});
describe('entity names in relationships', function () {
it('should allow "u" in relationships', function () {
erDiagram.parser.parse(`erDiagram\nCUSTOMER ||--|| u : has`);
erDiagram.parser.parse(`erDiagram\nu ||--|| ORDER : places`);
erDiagram.parser.parse(`erDiagram\nu ||--|| v : connects`);
});
it('should allow numbers in relationships', function () {
erDiagram.parser.parse(`erDiagram\nCUSTOMER ||--|| 1 : has`);
erDiagram.parser.parse(`erDiagram\n1 ||--|| ORDER : places`);
erDiagram.parser.parse(`erDiagram\n1 ||--|| 2 : connects`);
});
it('should allow decimal numbers in relationships', function () {
erDiagram.parser.parse(`erDiagram\nCUSTOMER ||--|| 2.5 : has`);
erDiagram.parser.parse(`erDiagram\n1.5 ||--|| ORDER : places`);
erDiagram.parser.parse(`erDiagram\n2.5 ||--|| 5.5 : connects`);
});
});
describe('mixed scenarios', function () {
it('should handle complex diagram with special entity names', function () {
erDiagram.parser.parse(
`erDiagram
CUSTOMER ||--o{ 1 : places
1 ||--|{ u : contains
u {
string name
int quantity
}
"2.5" ||--|| ORDER : processes
ORDER {
int id
date created
}
`
);
});
it('should handle attributes with numbers in names (but not starting)', function () {
erDiagram.parser.parse(
`erDiagram
ENTITY {
string name1
int value2
float point3_5
}
`
);
});
});
});
});

View File

@@ -99,23 +99,6 @@ export class FlowDB implements DiagramDB {
return id;
}
// Browser-safe environment variable access
private getEnvVar(name: string): string | undefined {
try {
if (typeof process !== 'undefined' && process.env) {
return process.env[name];
}
} catch (_e) {
// process is not defined in browser, continue to browser checks
}
// In browser, check for global variables
if (typeof window !== 'undefined' && (window as any).MERMAID_CONFIG) {
return (window as any).MERMAID_CONFIG[name];
}
return undefined;
}
/**
* Function called by parser when a node definition has been found
*/
@@ -129,18 +112,12 @@ export class FlowDB implements DiagramDB {
props = {},
metadata: any
) {
// Only log for debug mode - this is called very frequently
if (this.getEnvVar('ANTLR_DEBUG') === 'true') {
console.log(' FlowDB: Adding vertex', { id, textObj, type, style, classes, dir });
}
if (!id || id.trim().length === 0) {
console.log('⚠️ FlowDB: Skipping vertex with empty ID');
return;
}
// Extract the metadata from the shapeData, the syntax for adding metadata for nodes and edges is the same
// so at this point we don't know if it's a node or an edge, but we can still extract the metadata
let doc;
let originalYamlData = '';
if (metadata !== undefined) {
let yamlData;
// detect if shapeData contains a newline character
@@ -149,7 +126,6 @@ export class FlowDB implements DiagramDB {
} else {
yamlData = metadata + '\n';
}
originalYamlData = yamlData; // Store original for multiline detection
doc = yaml.load(yamlData, { schema: yaml.JSON_SCHEMA }) as NodeMetaData;
}
@@ -231,37 +207,7 @@ export class FlowDB implements DiagramDB {
}
if (doc?.label) {
// Convert newlines to <br/> tags for HTML rendering (except for YAML pipe syntax which preserves \n)
let labelText = doc.label;
// Check if the original YAML had a quoted multiline string pattern
const quotedMultilinePattern = /label:\s*"[^"]*\n[^"]*"/;
const isQuotedMultiline = quotedMultilinePattern.test(originalYamlData);
if (typeof labelText === 'string' && labelText.includes('\n')) {
// Check if this is a YAML block scalar (ends with \n) vs quoted multiline string
if (labelText.endsWith('\n')) {
// YAML block scalar (label: |) - preserve as-is with \n
vertex.text = labelText;
} else {
// Quoted multiline string (label: "text\nmore text") - convert \n to <br/>
labelText = labelText.replace(/\n/g, '<br/>');
vertex.text = labelText;
}
} else if (isQuotedMultiline && typeof labelText === 'string') {
// YAML parsed away the newlines, but original had quoted multiline - add <br/>
// Find where the line break should be by analyzing the original YAML
const match = originalYamlData.match(/label:\s*"([^"]*)\n\s*([^"]*)"/);
if (match) {
const part1 = match[1].trim();
const part2 = match[2].trim();
vertex.text = `${part1}<br/>${part2}`;
} else {
vertex.text = labelText;
}
} else {
vertex.text = labelText;
}
vertex.text = doc?.label;
}
if (doc?.icon) {
vertex.icon = doc?.icon;
@@ -287,9 +233,6 @@ export class FlowDB implements DiagramDB {
if (doc.w) {
vertex.assetWidth = Number(doc.w);
}
if (doc.w) {
vertex.assetWidth = Number(doc.w);
}
if (doc.h) {
vertex.assetHeight = Number(doc.h);
}
@@ -348,10 +291,7 @@ export class FlowDB implements DiagramDB {
}
if (this.edges.length < (this.config.maxEdges ?? 500)) {
// Reduced logging for performance - only log every 5000th edge for huge diagrams
if (this.edges.length % 5000 === 0) {
log.info(`Pushing edge ${this.edges.length}...`);
}
log.info('Pushing edge...');
this.edges.push(edge);
} else {
throw new Error(
@@ -374,20 +314,10 @@ You have to call mermaid.initialize.`
}
public addLink(_start: string[], _end: string[], linkData: unknown) {
const startTime = performance.now();
const id = this.isLinkData(linkData) ? linkData.id.replace('@', '') : undefined;
// Only log for debug mode or progress tracking for huge diagrams
if (this.getEnvVar('ANTLR_DEBUG') === 'true') {
console.log('🔗 FlowDB: Adding link', { _start, _end, linkData, id });
}
log.info('addLink', _start, _end, id);
// Track performance for huge diagrams - less frequent logging
if (this.edges.length % 10000 === 0 && this.edges.length > 0) {
console.log(`🔄 FlowDB Progress: ${this.edges.length} edges added`);
}
// for a group syntax like A e1@--> B & C, only the first edge should have a userDefined id
// the rest of the edges should have auto generated ids
for (const start of _start) {
@@ -402,12 +332,6 @@ You have to call mermaid.initialize.`
}
}
}
const duration = performance.now() - startTime;
if (duration > 1) {
// Only log if it takes more than 1ms
console.log(`⏱️ FlowDB: addLink took ${duration.toFixed(2)}ms`);
}
}
/**
@@ -630,7 +554,6 @@ You have to call mermaid.initialize.`
*
*/
public getVertices() {
console.log('📊 FlowDB: Getting vertices, count:', this.vertices.size);
return this.vertices;
}
@@ -639,7 +562,6 @@ You have to call mermaid.initialize.`
*
*/
public getEdges() {
console.log('📊 FlowDB: Getting edges, count:', this.edges.length);
return this.edges;
}
@@ -696,7 +618,6 @@ You have to call mermaid.initialize.`
*
*/
public clear(ver = 'gen-2') {
console.log('🗑️ FlowDB: Clearing database state');
this.vertices = new Map();
this.classes = new Map();
this.edges = [];
@@ -709,7 +630,6 @@ You have to call mermaid.initialize.`
this.version = ver;
this.config = getConfig();
commonClear();
console.log('✅ FlowDB: Database cleared successfully');
}
public setGen(ver: string) {
@@ -1118,11 +1038,10 @@ You have to call mermaid.initialize.`
shape: 'rect',
});
} else {
const shapeFromVertex = this.getTypeFromVertex(vertex);
nodes.push({
...baseNode,
isGroup: false,
shape: shapeFromVertex,
shape: this.getTypeFromVertex(vertex),
});
}
}

View File

@@ -1,269 +0,0 @@
lexer grammar FlowLexer;
import HeaderCommon;
// Virtual tokens for parser
tokens {
NODIR, DIR, PIPE, PE, SQE, DIAMOND_STOP, STADIUMEND, SUBROUTINEEND, CYLINDEREND, DOUBLECIRCLEEND,
ELLIPSE_END_TOKEN, TRAPEND, INVTRAPEND, PS, SQS, TEXT, CIRCLEEND, STR, CALLBACKARGS
}
// Lexer modes to match Jison's state-based lexing
// Based on Jison: %x string, md_string, acc_title, acc_descr, acc_descr_multiline, dir, vertex, text, etc.
// Shape data tokens - MUST be defined FIRST for absolute precedence over LINK_ID
// Match exactly "@{" like Jison does (no whitespace allowed between @ and {)
SHAPE_DATA_START: '@{' -> pushMode(SHAPE_DATA_MODE);
// Accessibility tokens
ACC_TITLE: 'accTitle' WS* ':' WS* -> pushMode(ACC_TITLE_MODE);
ACC_DESCR: 'accDescr' WS* ':' WS* -> pushMode(ACC_DESCR_MODE);
ACC_DESCR_MULTI: 'accDescr' WS* '{' WS* -> pushMode(ACC_DESCR_MULTILINE_MODE);
// Interactivity tokens
CALL: 'call' WS+ -> pushMode(CALLBACKNAME_MODE);
HREF: 'href' WS;
// CLICK token - matches 'click' + whitespace + node ID (like Jison)
CLICK: 'click' WS+ [A-Za-z0-9_]+ -> pushMode(CLICK_MODE);
// Graph declaration tokens - these trigger direction mode
GRAPH: ('flowchart-elk' | 'graph' | 'flowchart') { this.headerMode = false; } -> pushMode(DIR_MODE);
SUBGRAPH: 'subgraph';
END: 'end';
// Link targets
LINK_TARGET: ('_self' | '_blank' | '_parent' | '_top');
// Style and class tokens
STYLE: 'style';
DEFAULT: 'default';
LINKSTYLE: 'linkStyle';
INTERPOLATE: 'interpolate';
CLASSDEF: 'classDef';
CLASS: 'class';
// String tokens - must come early to avoid conflicts with QUOTE
MD_STRING_START: '"`' -> pushMode(MD_STRING_MODE);
// Direction tokens - matches Jison's direction_tb, direction_bt, etc.
// These handle "direction TB", "direction BT", etc. statements within subgraphs
DIRECTION_TB: 'direction' WS+ 'TB' ~[\n]*;
DIRECTION_BT: 'direction' WS+ 'BT' ~[\n]*;
DIRECTION_RL: 'direction' WS+ 'RL' ~[\n]*;
DIRECTION_LR: 'direction' WS+ 'LR' ~[\n]*;
// ELLIPSE_START must come very early to avoid conflicts with PAREN_START
// Simplified ellipse pattern - match the entire ellipse in one token
ELLIPSE_COMPLETE: '(-' (~[)]|')'~[-])* '-)';
ELLIPSE_START: '(-' -> pushMode(ELLIPSE_TEXT_MODE);
// Link ID token - matches edge IDs like "e1@" when followed by link patterns
// Uses a negative lookahead pattern to match the Jison lookahead (?=[^\{\"])
// This prevents LINK_ID from matching "e1@{" and allows SHAPE_DATA_START to match "@{" correctly
// The pattern matches any non-whitespace followed by @ but only when NOT followed by { or "
LINK_ID: ~[ \t\r\n"]+ '@' {this.inputStream.LA(1) != '{'.charCodeAt(0) && this.inputStream.LA(1) != '"'.charCodeAt(0)}?;
NUM: [0-9]+;
BRKT: '#';
STYLE_SEPARATOR: ':::';
COLON: ':';
AMP: '&';
SEMI: ';';
COMMA: ',';
MULT: '*';
// Edge patterns - these are complex in Jison, need careful translation
// Normal edges without text: A-->B (matches Jison: \s*[xo<]?\-\-+[-xo>]\s*) - must come first to avoid conflicts
LINK_NORMAL: WS* [xo<]? '--' '-'* [-xo>] WS*;
// Normal edges with text: A-- text ---B (matches Jison: <INITIAL>\s*[xo<]?\-\-\s* -> START_LINK)
START_LINK_NORMAL: WS* [xo<]? '--' WS+ -> pushMode(EDGE_TEXT_MODE);
// Normal edges with text (no space): A--text---B - match -- followed by any non-dash character
START_LINK_NORMAL_NOSPACE: WS* [xo<]? '--' -> pushMode(EDGE_TEXT_MODE);
// Pipe-delimited edge text: A--x| (linkStatement for arrowText) - matches Jison linkStatement pattern
LINK_STATEMENT_NORMAL: WS* [xo<]? '--' '-'* [xo<]?;
// Thick edges with text: A== text ===B (matches Jison: <INITIAL>\s*[xo<]?\=\=\s* -> START_LINK)
START_LINK_THICK: WS* [xo<]? '==' WS+ -> pushMode(THICK_EDGE_TEXT_MODE);
// Thick edges without text: A==>B (matches Jison: \s*[xo<]?\=\=+[=xo>]\s*)
LINK_THICK: WS* [xo<]? '==' '='* [=xo>] WS*;
LINK_STATEMENT_THICK: WS* [xo<]? '==' '='* [xo<]?;
// Dotted edges with text: A-. text .->B (matches Jison: <INITIAL>\s*[xo<]?\-\.\s* -> START_LINK)
START_LINK_DOTTED: WS* [xo<]? '-.' WS* -> pushMode(DOTTED_EDGE_TEXT_MODE);
// Dotted edges without text: A-.->B (matches Jison: \s*[xo<]?\-?\.+\-[xo>]?\s*)
LINK_DOTTED: WS* [xo<]? '-' '.'+ '-' [xo>]? WS*;
LINK_STATEMENT_DOTTED: WS* [xo<]? '-' '.'+ [xo<]?;
// Special link
LINK_INVISIBLE: WS* '~~' '~'+ WS*;
// PIPE handling: push to TEXT_MODE to handle content between pipes
// Put this AFTER link patterns to avoid interference with edge parsing
PIPE: '|' -> pushMode(TEXT_MODE);
// Vertex shape tokens - MUST come first (longer patterns before shorter ones)
DOUBLECIRCLE_START: '(((' -> pushMode(TEXT_MODE);
CIRCLE_START: '((' -> pushMode(TEXT_MODE);
// ELLIPSE_START moved to top of file for precedence
// Basic shape tokens - IMPORTANT: longer patterns MUST come before shorter ones for proper precedence
// Trapezoid patterns must come before SQUARE_START to avoid '[' matching first
TRAP_START: '[/' -> pushMode(TRAP_TEXT_MODE);
INVTRAP_START: '[\\' -> pushMode(TRAP_TEXT_MODE);
// Other bracket-based patterns
STADIUM_START: '([' -> pushMode(TEXT_MODE);
SUBROUTINE_START: '[[' -> pushMode(TEXT_MODE);
VERTEX_WITH_PROPS_START: '[|';
CYLINDER_START: '[(' -> pushMode(TEXT_MODE);
// SQUARE_START must come AFTER all other '[' patterns to avoid conflicts
SQUARE_START: '[' -> pushMode(TEXT_MODE), type(SQS);
// PAREN_START must come AFTER ELLIPSE_START to avoid consuming '(' before '(-' can match
PAREN_START: '(' -> pushMode(TEXT_MODE), type(PS);
DIAMOND_START: '{' -> pushMode(TEXT_MODE);
// Other basic shape tokens
TAGSTART: '<';
TAGEND: '>' -> pushMode(TEXT_MODE);
UP: '^';
DOWN: 'v';
MINUS: '-';
// Node string - allow dashes with lookahead to prevent conflicts with links (matches Jison pattern)
// Pattern: ([A-Za-z0-9!"\#$%&'*+\.`?\\_\/]|\-(?=[^\>\-\.])|=(?!=))+
// Fixed: Use positive lookahead instead of consuming the following character
NODE_STRING: ([A-Za-z0-9!"#$%&'*+.`?\\/_] | '-' {this.inputStream.LA(1) != '>'.charCodeAt(0) && this.inputStream.LA(1) != '-'.charCodeAt(0) && this.inputStream.LA(1) != '.'.charCodeAt(0)}? | '=' ~'=')+;
// Unicode text support (simplified from Jison's extensive Unicode ranges)
UNICODE_TEXT: [\u00AA\u00B5\u00BA\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02C1\u02C6-\u02D1\u02E0-\u02E4\u02EC\u02EE]+;
// String handling - matches Jison's <*>["] behavior (any mode can enter string mode)
QUOTE: '"' -> pushMode(STRING_MODE), skip;
NEWLINE: ('\r'? '\n')+;
WS: [ \t]+;
// Lexer modes
mode ACC_TITLE_MODE;
ACC_TITLE_VALUE: (~[\n;#])* -> popMode;
mode ACC_DESCR_MODE;
ACC_DESCR_VALUE: (~[\n;#])* -> popMode;
mode ACC_DESCR_MULTILINE_MODE;
ACC_DESCR_MULTILINE_END: '}' -> popMode;
ACC_DESCR_MULTILINE_VALUE: (~[}])*;
mode SHAPE_DATA_MODE;
SHAPE_DATA_STRING_START: '"' -> pushMode(SHAPE_DATA_STRING_MODE);
SHAPE_DATA_CONTENT: (~[}"]+);
SHAPE_DATA_END: '}' -> popMode;
mode SHAPE_DATA_STRING_MODE;
SHAPE_DATA_STRING_END: '"' -> popMode;
SHAPE_DATA_STRING_CONTENT: (~["]+);
mode CALLBACKNAME_MODE;
// Simplified approach: match the entire callback with arguments as one token
CALLBACKNAME_WITH_ARGS: [A-Za-z0-9_]+ '(' (~[)])* ')' -> popMode, type(CALLBACKARGS);
CALLBACKNAME_PAREN_EMPTY: '(' WS* ')' -> popMode, type(CALLBACKARGS);
CALLBACKNAME: [A-Za-z0-9_]+;
mode CLICK_MODE;
CLICK_NEWLINE: ('\r'? '\n')+ -> popMode, type(NEWLINE);
CLICK_WS: WS -> skip;
CLICK_CALL: 'call' WS+ -> type(CALL), pushMode(CALLBACKNAME_MODE);
CLICK_HREF: 'href' -> type(HREF);
CLICK_STR: '"' (~["])* '"' -> type(STR);
CLICK_LINK_TARGET: ('_self' | '_blank' | '_parent' | '_top') -> type(LINK_TARGET);
CLICK_CALLBACKNAME: [A-Za-z0-9_]+ -> type(CALLBACKNAME);
mode DIR_MODE;
DIR_NEWLINE: ('\r'? '\n')* WS* '\n' -> popMode, type(NODIR);
DIR_LR: WS* 'LR' -> popMode, type(DIR);
DIR_RL: WS* 'RL' -> popMode, type(DIR);
DIR_TB: WS* 'TB' -> popMode, type(DIR);
DIR_BT: WS* 'BT' -> popMode, type(DIR);
DIR_TD: WS* 'TD' -> popMode, type(DIR);
DIR_BR: WS* 'BR' -> popMode, type(DIR);
DIR_LEFT: WS* '<' -> popMode, type(DIR);
DIR_RIGHT: WS* '>' -> popMode, type(DIR);
DIR_UP: WS* '^' -> popMode, type(DIR);
DIR_DOWN: WS* 'v' -> popMode, type(DIR);
mode STRING_MODE;
STRING_END: '"' -> popMode, skip;
STR: (~["]+);
mode MD_STRING_MODE;
MD_STRING_END: '`"' -> popMode;
MD_STR: (~[`"])+;
mode TEXT_MODE;
// Allow nested diamond starts (for hexagon nodes)
TEXT_DIAMOND_START: '{' -> pushMode(TEXT_MODE), type(DIAMOND_START);
// Handle nested parentheses and brackets like Jison
TEXT_PAREN_START: '(' -> pushMode(TEXT_MODE), type(PS);
TEXT_SQUARE_START: '[' -> pushMode(TEXT_MODE), type(SQS);
// Handle quoted strings in text mode - matches Jison's <*>["] behavior
// Skip the opening quote token, just push to STRING_MODE like Jison does
TEXT_STRING_START: '"' -> pushMode(STRING_MODE), skip;
// Handle closing pipe in text mode - pop back to default mode
TEXT_PIPE_END: '|' -> popMode, type(PIPE);
TEXT_PAREN_END: ')' -> popMode, type(PE);
TEXT_SQUARE_END: ']' -> popMode, type(SQE);
TEXT_DIAMOND_END: '}' -> popMode, type(DIAMOND_STOP);
TEXT_STADIUM_END: '])' -> popMode, type(STADIUMEND);
TEXT_SUBROUTINE_END: ']]' -> popMode, type(SUBROUTINEEND);
TEXT_CYLINDER_END: ')]' -> popMode, type(CYLINDEREND);
TEXT_DOUBLECIRCLE_END: ')))' -> popMode, type(DOUBLECIRCLEEND);
TEXT_CIRCLE_END: '))' -> popMode, type(CIRCLEEND);
// Now allow all characters except the specific end tokens for this mode
TEXT_CONTENT: (~[(){}|\]"])+;
mode ELLIPSE_TEXT_MODE;
ELLIPSE_END: '-)' -> popMode, type(ELLIPSE_END_TOKEN);
// Match Jison behavior: allow any char except ()[]{} OR - not followed by )
// Jison pattern: [^\(\)\[\]\{\}]|-\!\)+
// Fixed: Allow hyphens in the middle of text, but not when they form the end pattern '-)'
ELLIPSE_TEXT: (
~[()[\]{}]
| '-' {this.inputStream.LA(1) != ')'.charCodeAt(0)}?
)+;
mode TRAP_TEXT_MODE;
// End patterns must come first for proper precedence
TRAP_END_BRACKET: '\\]' -> popMode, type(TRAPEND);
INVTRAP_END_BRACKET: '/]' -> popMode, type(INVTRAPEND);
// Match Jison behavior with a single token that handles all cases
// Allow sequences of: / not followed by ], \ not followed by ], or other allowed chars
// This matches the Jison pattern: \/(?!\])|\\(?!\])|[^\\\[\]\(\)\{\}\/]+
TRAP_TEXT: (
'/' {this.inputStream.LA(1) != ']'.charCodeAt(0)}?
| '\\' {this.inputStream.LA(1) != ']'.charCodeAt(0)}?
| ~[\\/()\]{}]
)+;
mode EDGE_TEXT_MODE;
// Handle space-delimited pattern: A-- text ----B or A-- text -->B (matches Jison: [^-]|\-(?!\-)+)
// Must handle both cases: extra dashes without arrow (----) and dashes with arrow (-->)
EDGE_TEXT_LINK_END: WS* '--' '-'* [-xo>]? WS* -> popMode, type(LINK_NORMAL);
// Match any character including spaces and single dashes, but not double dashes
EDGE_TEXT: (~[-] | '-' ~[-])+;
mode THICK_EDGE_TEXT_MODE;
// Handle thick edge patterns: A== text ====B or A== text ==>B
THICK_EDGE_TEXT_LINK_END: WS* '==' '='* [=xo>]? WS* -> popMode, type(LINK_THICK);
THICK_EDGE_TEXT: (~[=] | '=' ~[=])+;
mode DOTTED_EDGE_TEXT_MODE;
// Handle dotted edge patterns: A-. text ...-B or A-. text .->B
DOTTED_EDGE_TEXT_LINK_END: WS* '.'+ '-' [xo>]? WS* -> popMode, type(LINK_DOTTED);
DOTTED_EDGE_TEXT: ~[.]+;

View File

@@ -1,290 +0,0 @@
parser grammar FlowParser;
options {
tokenVocab = FlowLexer;
}
// Entry point - matches Jison's "start: graphConfig document"
start: graphConfig document;
// Document structure - matches Jison's document rule
document:
line*
;
// Line structure - matches Jison's line rule
line:
statement
| SEMI
| NEWLINE
| WS
;
// Graph configuration - matches Jison's graphConfig rule
graphConfig:
WS graphConfig
| NEWLINE graphConfig
| GRAPH NODIR // Default TB direction
| GRAPH DIR firstStmtSeparator // Explicit direction
;
// Statement types - matches Jison's statement rule
statement:
vertexStatement separator
| standaloneVertex separator // For edge property statements like e1@{curve: basis}
| styleStatement separator
| linkStyleStatement separator
| classDefStatement separator
| classStatement separator
| clickStatement separator
| subgraphStatement separator
| direction
| accTitle
| accDescr
;
// Separators
separator: NEWLINE | SEMI | EOF;
firstStmtSeparator: SEMI | NEWLINE | spaceList NEWLINE;
spaceList: WS spaceList | WS;
// Vertex statement - matches Jison's vertexStatement rule
vertexStatement:
vertexStatement link node shapeData // Chain with shape data
| vertexStatement link node // Chain without shape data
| vertexStatement link node spaceList // Chain with trailing space
| node spaceList // Single node with space
| node shapeData // Single node with shape data
| node // Single node
;
// Standalone vertex - for edge property statements like e1@{curve: basis}
standaloneVertex:
NODE_STRING shapeData
| LINK_ID shapeData // For edge IDs like e1@{curve: basis}
;
// Node definition - matches Jison's node rule
node:
styledVertex
| node spaceList AMP spaceList styledVertex
;
// Styled vertex - matches Jison's styledVertex rule
styledVertex:
vertex shapeData
| vertex
| vertex STYLE_SEPARATOR idString
;
// Vertex shapes - matches Jison's vertex rule
vertex:
idString SQS text SQE // Square: [text]
| idString DOUBLECIRCLE_START text DOUBLECIRCLEEND // Double circle: (((text)))
| idString CIRCLE_START text CIRCLEEND // Circle: ((text))
| idString ELLIPSE_COMPLETE // Ellipse: (-text-) - complete token
| idString ELLIPSE_START text ELLIPSE_END_TOKEN // Ellipse: (-text-) - mode-based
| idString STADIUM_START text STADIUMEND // Stadium: ([text])
| idString SUBROUTINE_START text SUBROUTINEEND // Subroutine: [[text]]
| idString VERTEX_WITH_PROPS_START NODE_STRING COLON NODE_STRING PIPE text SQE // Props: [|field:value|text]
| idString CYLINDER_START text CYLINDEREND // Cylinder: [(text)]
| idString PS text PE // Round: (text)
| idString DIAMOND_START text DIAMOND_STOP // Diamond: {text}
| idString DIAMOND_START DIAMOND_START text DIAMOND_STOP DIAMOND_STOP // Hexagon: {{text}}
| idString TAGEND text SQE // Odd: >text]
| idString // Simple node ID without shape - default to squareRect
| idString TRAP_START text TRAPEND // Trapezoid: [/text\]
| idString INVTRAP_START text INVTRAPEND // Inv trapezoid: [\text/]
| idString TRAP_START text INVTRAPEND // Lean right: [/text/]
| idString INVTRAP_START text TRAPEND // Lean left: [\text\]
| idString // Plain node
;
// Link definition - matches Jison's link rule
link:
linkStatement arrowText spaceList?
| linkStatement
| START_LINK_NORMAL edgeText LINK_NORMAL
| START_LINK_NORMAL_NOSPACE edgeText LINK_NORMAL
| START_LINK_THICK edgeText LINK_THICK
| START_LINK_DOTTED edgeText LINK_DOTTED
| LINK_ID START_LINK_NORMAL edgeText LINK_NORMAL
| LINK_ID START_LINK_NORMAL_NOSPACE edgeText LINK_NORMAL
| LINK_ID START_LINK_THICK edgeText LINK_THICK
| LINK_ID START_LINK_DOTTED edgeText LINK_DOTTED
;
// Link statement - matches Jison's linkStatement rule
linkStatement:
LINK_NORMAL
| LINK_THICK
| LINK_DOTTED
| LINK_INVISIBLE
| LINK_STATEMENT_NORMAL
| LINK_STATEMENT_DOTTED
| LINK_ID LINK_NORMAL
| LINK_ID LINK_THICK
| LINK_ID LINK_DOTTED
| LINK_ID LINK_INVISIBLE
| LINK_ID LINK_STATEMENT_NORMAL
| LINK_ID LINK_STATEMENT_THICK
;
// Edge text - matches Jison's edgeText rule
edgeText:
edgeTextToken
| edgeText edgeTextToken
| stringLiteral
| MD_STR
;
// Arrow text - matches Jison's arrowText rule
arrowText:
PIPE text PIPE
;
// Text definition - matches Jison's text rule
text:
textToken
| text textToken
| stringLiteral
| MD_STR
| NODE_STRING
| TEXT_CONTENT
| ELLIPSE_TEXT
| TRAP_TEXT
;
// Shape data - matches Jison's shapeData rule
shapeData:
SHAPE_DATA_START shapeDataContent SHAPE_DATA_END
;
shapeDataContent:
shapeDataContent SHAPE_DATA_CONTENT
| shapeDataContent SHAPE_DATA_STRING_START SHAPE_DATA_STRING_CONTENT SHAPE_DATA_STRING_END
| SHAPE_DATA_CONTENT
| SHAPE_DATA_STRING_START SHAPE_DATA_STRING_CONTENT SHAPE_DATA_STRING_END
|
;
// Style statement - matches Jison's styleStatement rule
styleStatement:
STYLE WS idString WS stylesOpt
;
// Link style statement - matches Jison's linkStyleStatement rule
linkStyleStatement:
LINKSTYLE WS DEFAULT WS stylesOpt
| LINKSTYLE WS numList WS stylesOpt
| LINKSTYLE WS DEFAULT WS INTERPOLATE WS alphaNum WS stylesOpt
| LINKSTYLE WS numList WS INTERPOLATE WS alphaNum WS stylesOpt
| LINKSTYLE WS DEFAULT WS INTERPOLATE WS alphaNum
| LINKSTYLE WS numList WS INTERPOLATE WS alphaNum
;
// Class definition statement - matches Jison's classDefStatement rule
classDefStatement:
CLASSDEF WS idString WS stylesOpt
;
// Class statement - matches Jison's classStatement rule
classStatement:
CLASS WS idString WS idString
;
// String rule to handle STR patterns
stringLiteral:
STR
;
// Click statement - matches Jison's clickStatement rule
// CLICK token now contains both 'click' and node ID (like Jison)
clickStatement:
CLICK CALLBACKNAME
| CLICK CALLBACKNAME stringLiteral
| CLICK CALLBACKNAME CALLBACKARGS
| CLICK CALLBACKNAME CALLBACKARGS stringLiteral
| CLICK CALL CALLBACKNAME
| CLICK CALL CALLBACKNAME stringLiteral
| CLICK CALL CALLBACKNAME CALLBACKARGS
| CLICK CALL CALLBACKNAME CALLBACKARGS stringLiteral
| CLICK CALL CALLBACKARGS // CLICK CALL callback() - call with args only
| CLICK CALL CALLBACKARGS stringLiteral // CLICK CALL callback() "tooltip" - call with args and tooltip
| CLICK HREF stringLiteral
| CLICK HREF stringLiteral stringLiteral
| CLICK HREF stringLiteral LINK_TARGET
| CLICK HREF stringLiteral stringLiteral LINK_TARGET
| CLICK stringLiteral // CLICK STR - direct click with URL
| CLICK stringLiteral stringLiteral // CLICK STR STR - click with URL and tooltip
| CLICK stringLiteral LINK_TARGET // CLICK STR LINK_TARGET - click with URL and target
| CLICK stringLiteral stringLiteral LINK_TARGET // CLICK STR STR LINK_TARGET - click with URL, tooltip, and target
;
// Subgraph statement - matches Jison's subgraph rules
subgraphStatement:
SUBGRAPH WS textNoTags SQS text SQE separator document END
| SUBGRAPH WS textNoTags separator document END
| SUBGRAPH separator document END
;
// Direction statement - matches Jison's direction rule
direction:
DIRECTION_TB
| DIRECTION_BT
| DIRECTION_RL
| DIRECTION_LR
;
// Accessibility statements
accTitle: ACC_TITLE ACC_TITLE_VALUE;
accDescr: ACC_DESCR ACC_DESCR_VALUE | ACC_DESCR_MULTI ACC_DESCR_MULTILINE_VALUE ACC_DESCR_MULTILINE_END;
// Number list - matches Jison's numList rule
numList:
NUM
| numList COMMA NUM
;
// Styles - matches Jison's stylesOpt rule
stylesOpt:
style
| stylesOpt COMMA style
;
// Style components - matches Jison's style rule
style:
styleComponent
| style styleComponent
;
// Style component - matches Jison's styleComponent rule
styleComponent: NUM | NODE_STRING | COLON | WS | BRKT | STYLE | MULT | MINUS;
// Token definitions - matches Jison's token lists
idString:
idStringToken
| idString idStringToken
;
alphaNum:
alphaNumToken
| alphaNum alphaNumToken
;
textNoTags:
textNoTagsToken
| textNoTags textNoTagsToken
| stringLiteral
| MD_STR
;
// Token types - matches Jison's token definitions
idStringToken: NUM | NODE_STRING | DOWN | MINUS | DEFAULT | COMMA | COLON | AMP | BRKT | MULT | UNICODE_TEXT;
textToken: TEXT_CONTENT | TAGSTART | TAGEND | UNICODE_TEXT | NODE_STRING | WS;
textNoTagsToken: NUM | NODE_STRING | WS | MINUS | AMP | UNICODE_TEXT | COLON | MULT | BRKT | keywords | START_LINK_NORMAL;
edgeTextToken: EDGE_TEXT | THICK_EDGE_TEXT | DOTTED_EDGE_TEXT | UNICODE_TEXT;
alphaNumToken: NUM | UNICODE_TEXT | NODE_STRING | DIR | DOWN | MINUS | COMMA | COLON | AMP | BRKT | MULT;
// Keywords - matches Jison's keywords rule
keywords: STYLE | LINKSTYLE | CLASSDEF | CLASS | CLICK | GRAPH | DIR | SUBGRAPH | END | DOWN | UP;

View File

@@ -1,128 +0,0 @@
import type { ParseTreeListener } from 'antlr4ng';
import type { VertexStatementContext } from './generated/FlowParser.js';
import { FlowchartParserCore } from './FlowchartParserCore.js';
/**
* Listener implementation that builds the flowchart model
* Extends the core logic to ensure 99.1% test compatibility
*/
export class FlowchartListener extends FlowchartParserCore implements ParseTreeListener {
constructor(db: any) {
super(db);
console.log('👂 FlowchartListener: Constructor called');
}
// Standard ParseTreeListener methods
enterEveryRule = (ctx: any) => {
// Optional: Add debug logging for rule entry
if (this.getEnvVar('NODE_ENV') === 'development') {
const ruleName = ctx.constructor.name;
console.log('🔍 FlowchartListener: Entering rule:', ruleName);
}
};
exitEveryRule = (ctx: any) => {
// Optional: Add debug logging for rule exit
if (this.getEnvVar('NODE_ENV') === 'development') {
const ruleName = ctx.constructor.name;
console.log('🔍 FlowchartListener: Exiting rule:', ruleName);
}
};
visitTerminal = (node: any) => {
// Optional: Handle terminal nodes
};
visitErrorNode = (node: any) => {
console.log('❌ FlowchartListener: Error node encountered');
};
// Handle graph config (graph >, flowchart ^, etc.)
exitGraphConfig = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing graph config');
this.processGraphDeclaration(ctx);
};
enterGraphConfig = (ctx: any) => {
console.log('🔍 FlowchartListener: Entering graph config');
this.processGraphDeclaration(ctx);
};
// Handle vertex statements (nodes and edges)
exitVertexStatement = (ctx: VertexStatementContext) => {
// Use the shared core logic
this.processVertexStatementCore(ctx);
};
// Remove old duplicate subgraph handling - now using core methods
// Handle style statements
exitStyleStatement = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing style statement');
// Use core processing method
this.processStyleStatementCore(ctx);
};
// Handle linkStyle statements
exitLinkStyleStatement = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing linkStyle statement');
// Use core processing method
this.processLinkStyleStatementCore(ctx);
};
// Handle class definition statements
exitClassDefStatement = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing class definition statement');
// Use core processing method
this.processClassDefStatementCore(ctx);
};
// Handle class statements
exitClassStatement = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing class statement');
// Use core processing method
this.processClassStatementCore(ctx);
};
// Handle click statements
exitClickStatement = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing click statement');
// Use core processing method
this.processClickStatementCore(ctx);
};
// Handle direction statements
exitDirection = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing direction statement');
this.processDirectionStatementCore(ctx);
};
// Handle accessibility statements - method names must match grammar rule names
exitAccTitle = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing accTitle statement');
this.processAccTitleStatementCore(ctx);
};
exitAccDescr = (ctx: any) => {
console.log('🔍 FlowchartListener: Processing accDescr statement');
this.processAccDescStatementCore(ctx);
};
// Handle subgraph statements
enterSubgraphStatement = (ctx: any) => {
console.log('🔍 FlowchartListener: Entering subgraph statement');
this.processSubgraphStatementCore(ctx);
};
exitSubgraphStatement = (ctx: any) => {
console.log('🔍 FlowchartListener: Exiting subgraph statement');
this.processSubgraphEndCore();
};
// Note: Helper methods are now in FlowchartParserCore base class
}

View File

@@ -1,377 +0,0 @@
import type { FlowParserVisitor } from './generated/FlowParser.js';
import type { VertexStatementContext } from './generated/FlowParser.js';
import { FlowchartParserCore } from './FlowchartParserCore.js';
/**
* Visitor implementation that builds the flowchart model
* Uses the same core logic as the Listener for 99.1% test compatibility
*/
export class FlowchartVisitor extends FlowchartParserCore implements FlowParserVisitor<any> {
private visitCount = 0;
private vertexStatementCount = 0;
private edgeCount = 0;
private performanceLog: { [key: string]: { count: number; totalTime: number } } = {};
constructor(db: any) {
super(db);
// Only log for debug mode
if (this.getEnvVar('ANTLR_DEBUG') === 'true') {
console.log('🎯 FlowchartVisitor: Constructor called');
}
}
private logPerformance(methodName: string, startTime: number) {
// Only track performance in debug mode to reduce overhead
if (this.getEnvVar('ANTLR_DEBUG') === 'true') {
const duration = performance.now() - startTime;
if (!this.performanceLog[methodName]) {
this.performanceLog[methodName] = { count: 0, totalTime: 0 };
}
this.performanceLog[methodName].count++;
this.performanceLog[methodName].totalTime += duration;
}
}
private printPerformanceReport() {
console.log('📊 FlowchartVisitor Performance Report:');
console.log(` Total visits: ${this.visitCount}`);
console.log(` Vertex statements: ${this.vertexStatementCount}`);
console.log(` Edges processed: ${this.edgeCount}`);
const sortedMethods = Object.entries(this.performanceLog)
.sort(([, a], [, b]) => b.totalTime - a.totalTime)
.slice(0, 10); // Top 10 slowest methods
console.log(' Top time-consuming methods:');
for (const [method, stats] of sortedMethods) {
const avgTime = stats.totalTime / stats.count;
console.log(
` ${method}: ${stats.totalTime.toFixed(2)}ms total (${stats.count} calls, ${avgTime.toFixed(2)}ms avg)`
);
}
}
// Default visitor methods
visit(tree: any): any {
// Only track performance in debug mode to reduce overhead
const shouldTrackPerformance = this.getEnvVar('ANTLR_DEBUG') === 'true';
const startTime = shouldTrackPerformance ? performance.now() : 0;
this.visitCount++;
if (shouldTrackPerformance) {
console.log(`🔍 FlowchartVisitor: Visiting node type: ${tree.constructor.name}`);
}
let result;
try {
result = tree.accept(this);
if (shouldTrackPerformance) {
console.log(`✅ FlowchartVisitor: Successfully visited ${tree.constructor.name}`);
}
} catch (error) {
console.error(`❌ FlowchartVisitor: Error visiting ${tree.constructor.name}:`, error);
throw error;
}
if (shouldTrackPerformance) {
this.logPerformance('visit', startTime);
}
// Print performance report every 20,000 visits for huge diagrams (less frequent)
if (this.visitCount % 20000 === 0) {
console.log(`🔄 Progress: ${this.visitCount} visits completed`);
}
// Print final performance report after visiting the entire tree (only for root visit)
if (
shouldTrackPerformance &&
this.visitCount > 1000 &&
tree.constructor.name === 'StartContext'
) {
this.printPerformanceReport();
}
return result;
}
visitChildren(node: any): any {
// Only track performance in debug mode to reduce overhead
const shouldTrackPerformance = this.getEnvVar('ANTLR_DEBUG') === 'true';
const startTime = shouldTrackPerformance ? performance.now() : 0;
let result = null;
const n = node.getChildCount();
for (let i = 0; i < n; i++) {
const childResult = node.getChild(i).accept(this);
if (childResult !== null) {
result = childResult;
}
}
if (shouldTrackPerformance) {
this.logPerformance('visitChildren', startTime);
}
return result;
}
// Required visitor methods for terminal nodes and errors
visitTerminal(node: any): any {
return null;
}
visitErrorNode(node: any): any {
console.log('❌ FlowchartVisitor: Error node encountered');
return null;
}
// Additional required methods for the visitor interface
defaultResult(): any {
return null;
}
shouldVisitNextChild(node: any, currentResult: any): boolean {
return true;
}
aggregateResult(aggregate: any, nextResult: any): any {
return nextResult !== null ? nextResult : aggregate;
}
// Handle graph config (graph >, flowchart ^, etc.)
visitGraphConfig(ctx: any): any {
// Only log for debug mode - this is called frequently
if (this.getEnvVar('ANTLR_DEBUG') === 'true') {
console.log('🎯 FlowchartVisitor: Visiting graph config');
}
this.processGraphDeclaration(ctx);
return this.visitChildren(ctx);
}
// Implement key visitor methods using the same logic as the Listener
visitVertexStatement(ctx: VertexStatementContext): any {
// Only track performance in debug mode to reduce overhead
const shouldTrackPerformance = this.getEnvVar('ANTLR_DEBUG') === 'true';
const startTime = shouldTrackPerformance ? performance.now() : 0;
this.vertexStatementCount++;
// Log progress for huge diagrams - less frequent logging
if (this.vertexStatementCount % 10000 === 0) {
console.log(`🔄 Progress: ${this.vertexStatementCount} vertex statements processed`);
}
// For left-recursive vertexStatement grammar, we need to visit children first
// to process the chain in the correct order (A->B->C should process A first)
const result = this.visitChildren(ctx);
// Then process this vertex statement using core logic
// This ensures identical behavior and test compatibility with Listener pattern
this.processVertexStatementCore(ctx);
this.logPerformance('visitVertexStatement', startTime);
return result;
}
// Default implementation for all other visit methods
visitStart(ctx: any): any {
return this.visitChildren(ctx);
}
visitDocument(ctx: any): any {
return this.visitChildren(ctx);
}
visitLine(ctx: any): any {
return this.visitChildren(ctx);
}
visitStatement(ctx: any): any {
return this.visitChildren(ctx);
}
visitStyleStatement(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting style statement');
// Use core processing method
this.processStyleStatementCore(ctx);
return this.visitChildren(ctx);
}
visitLinkStyleStatement(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting linkStyle statement');
// Use core processing method
this.processLinkStyleStatementCore(ctx);
return this.visitChildren(ctx);
}
visitClassStatement(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting class statement');
// Use core processing method
this.processClassStatementCore(ctx);
return this.visitChildren(ctx);
}
visitClickStatement(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting click statement');
// Use core processing method
this.processClickStatementCore(ctx);
return this.visitChildren(ctx);
}
// Handle direction statements
visitDirection(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting direction statement');
this.processDirectionStatementCore(ctx);
return this.visitChildren(ctx);
}
// Handle accessibility statements - method names must match grammar rule names
// Handle subgraph statements - matches Listener pattern logic
visitSubgraphStatement(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting subgraph statement');
// Handle subgraph entry using core method
this.processSubgraphStatementCore(ctx);
// Visit children
const result = this.visitChildren(ctx);
// Handle subgraph exit using core method
this.processSubgraphEndCore();
return result;
}
// Note: Helper methods are now in FlowchartParserCore base class
// Add implementations for additional visitor methods (avoiding duplicates)
visitStandaloneVertex(ctx: any): any {
return this.visitChildren(ctx);
}
visitNode(ctx: any): any {
return this.visitChildren(ctx);
}
visitStyledVertex(ctx: any): any {
return this.visitChildren(ctx);
}
visitVertex(ctx: any): any {
return this.visitChildren(ctx);
}
visitText(ctx: any): any {
return this.visitChildren(ctx);
}
visitIdString(ctx: any): any {
return this.visitChildren(ctx);
}
visitLink(ctx: any): any {
return this.visitChildren(ctx);
}
visitLinkStatement(ctx: any): any {
return this.visitChildren(ctx);
}
visitEdgeText(ctx: any): any {
return this.visitChildren(ctx);
}
visitArrowText(ctx: any): any {
return this.visitChildren(ctx);
}
visitShapeData(ctx: any): any {
return this.visitChildren(ctx);
}
visitShapeDataContent(ctx: any): any {
return this.visitChildren(ctx);
}
visitClassDefStatement(ctx: any): any {
console.log('🔍 FlowchartVisitor: Processing class definition statement');
// Use core processing method
this.processClassDefStatementCore(ctx);
return this.visitChildren(ctx);
}
visitStringLiteral(ctx: any): any {
return this.visitChildren(ctx);
}
visitAccTitle(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting accTitle statement');
this.processAccTitleStatementCore(ctx);
return this.visitChildren(ctx);
}
visitAccDescr(ctx: any): any {
console.log('🎯 FlowchartVisitor: Visiting accDescr statement');
this.processAccDescStatementCore(ctx);
return this.visitChildren(ctx);
}
visitNumList(ctx: any): any {
return this.visitChildren(ctx);
}
visitStylesOpt(ctx: any): any {
return this.visitChildren(ctx);
}
visitStyle(ctx: any): any {
return this.visitChildren(ctx);
}
visitStyleComponent(ctx: any): any {
return this.visitChildren(ctx);
}
visitAlphaNum(ctx: any): any {
return this.visitChildren(ctx);
}
visitTextNoTags(ctx: any): any {
return this.visitChildren(ctx);
}
visitIdStringToken(ctx: any): any {
return this.visitChildren(ctx);
}
visitTextToken(ctx: any): any {
return this.visitChildren(ctx);
}
visitTextNoTagsToken(ctx: any): any {
return this.visitChildren(ctx);
}
visitEdgeTextToken(ctx: any): any {
return this.visitChildren(ctx);
}
visitAlphaNumToken(ctx: any): any {
return this.visitChildren(ctx);
}
visitKeywords(ctx: any): any {
return this.visitChildren(ctx);
}
}

View File

@@ -1,191 +0,0 @@
# 🎯 ANTLR Flowchart Parser
A high-performance ANTLR-based parser for Mermaid flowchart diagrams, achieving 99.1% compatibility with the original Jison parser.
## 🚀 Quick Start
```bash
# Generate ANTLR parser files
pnpm antlr:generate
# Test with Visitor pattern (default)
USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true npx vitest run packages/mermaid/src/diagrams/flowchart/parser/
# Test with Listener pattern
USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=false npx vitest run packages/mermaid/src/diagrams/flowchart/parser/
```
## 📊 Current Status
### ✅ Production Ready (99.1% Pass Rate)
- **939/948 tests passing** ✅
- **Zero failing tests** ❌ → ✅
- **15% performance improvement** with optimizations ⚡
- **Both Listener and Visitor patterns** working identically 🎯
## 🏗️ Architecture
### 📁 File Structure
```
antlr/
├── FlowLexer.g4 # ANTLR lexer grammar
├── FlowParser.g4 # ANTLR parser grammar
├── antlr-parser.ts # Main parser entry point
├── FlowchartParserCore.ts # Shared core logic (99.1% compatible)
├── FlowchartListener.ts # Listener pattern implementation
├── FlowchartVisitor.ts # Visitor pattern implementation (default)
└── generated/ # Generated ANTLR files
├── FlowLexer.ts # Generated lexer
├── FlowParser.ts # Generated parser
├── FlowParserListener.ts # Generated listener interface
└── FlowParserVisitor.ts # Generated visitor interface
```
### 🔄 Dual-Pattern Support
#### 🚶 Visitor Pattern (Default)
- **Pull-based**: Developer controls traversal
- **Return values**: Can return data from visit methods
- **Best for**: Complex processing, data transformation
#### 👂 Listener Pattern
- **Event-driven**: Parser controls traversal
- **Push-based**: Parser pushes events to callbacks
- **Best for**: Simple processing, event-driven architectures
### 🎯 Shared Core Logic
Both patterns extend `FlowchartParserCore` ensuring **identical behavior**:
- All parsing logic that achieved 99.1% compatibility
- Shared helper methods for node/edge processing
- Database interaction methods
- Error handling and validation
## ⚡ Performance Optimizations
### 🚀 15% Performance Improvement
- **Conditional logging**: Only for complex diagrams or debug mode
- **Optimized performance tracking**: Minimal overhead in production
- **Efficient database operations**: Reduced logging frequency
- **Clean console output**: Professional logging experience
### 📊 Performance Results
| Test Size | Time | Improvement |
|-----------|------|-------------|
| **Medium (1000 edges)** | 2.25s | **15% faster** |
| **Parse Tree Generation** | 2091ms | **15% faster** |
| **Tree Traversal** | 154ms | **17% faster** |
### 🔧 Debug Mode
```bash
# Enable detailed logging
ANTLR_DEBUG=true USE_ANTLR_PARSER=true pnpm dev:antlr
```
## 🎯 Features Supported
### ✅ Complete Flowchart Syntax
- All node shapes (rectangles, circles, diamonds, stadiums, etc.)
- Complex text content with special characters
- Class and style definitions
- Subgraph processing with markdown support
- Interaction handling (click events, callbacks)
- Accessibility descriptions (accDescr/accTitle)
- Multi-line YAML processing
- Node data with @ syntax
- Ampersand chains with shape data
### 🔧 Advanced Features
- **Trapezoid shapes** with forward/back slashes
- **Markdown processing** with nested quote/backtick detection
- **Complex edge cases** including special character node IDs
- **Error handling** with proper validation
- **Performance tracking** with detailed breakdowns
## 🧪 Testing
### 📋 Test Coverage
- **948 total tests** across 15 test files
- **939 passing tests** (99.1% pass rate)
- **9 skipped tests** (intentionally skipped)
- **Zero failing tests** ✅
### 🔍 Key Test Categories
- **flow-text.spec.js**: 342/342 tests ✅ (100%)
- **flow-edges.spec.js**: 293/293 tests ✅ (100%)
- **flow-singlenode.spec.js**: 148/148 tests ✅ (100%)
- **subgraph.spec.js**: 21/22 tests ✅ (95.5%)
- **All other test files**: 100% pass rate ✅
## 🔧 Configuration
### Environment Variables
```bash
# Parser Selection
USE_ANTLR_PARSER=true # Use ANTLR parser
USE_ANTLR_PARSER=false # Use Jison parser (default)
# Pattern Selection (when ANTLR enabled)
USE_ANTLR_VISITOR=true # Use Visitor pattern (default)
USE_ANTLR_VISITOR=false # Use Listener pattern
# Debug Mode
ANTLR_DEBUG=true # Enable detailed logging
```
### Usage Examples
```bash
# Production: Visitor pattern with clean output
USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true pnpm dev:antlr
# Development: Listener pattern with debug logging
ANTLR_DEBUG=true USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=false pnpm dev:antlr
```
## 🚀 Development
### 🔄 Regenerating Parser
```bash
# From project root
pnpm antlr:generate
# Or manually from antlr directory
cd packages/mermaid/src/diagrams/flowchart/parser/antlr
antlr-ng -Dlanguage=TypeScript -l -v -o generated FlowLexer.g4 FlowParser.g4
```
### 🧪 Running Tests
```bash
# Full test suite with Visitor pattern
USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=true npx vitest run packages/mermaid/src/diagrams/flowchart/parser/
# Full test suite with Listener pattern
USE_ANTLR_PARSER=true USE_ANTLR_VISITOR=false npx vitest run packages/mermaid/src/diagrams/flowchart/parser/
# Single test file
USE_ANTLR_PARSER=true npx vitest run packages/mermaid/src/diagrams/flowchart/parser/flow-text.spec.js
```
## 🎉 Success Indicators
### ✅ Normal Operation
- Clean console output with minimal logging
- All diagrams render correctly as SVG
- Fast parsing performance for typical diagrams
### 🐛 Debug Mode
- Detailed performance breakdowns
- Parse tree generation timing
- Tree traversal metrics
- Database operation logging
## 🏆 Achievements
- **99.1% compatibility** with original Jison parser
- **Zero functional failures** - all parsing issues resolved
- **Dual-pattern architecture** with identical behavior
- **15% performance improvement** through optimizations
- **Production-ready** with clean logging and debug support
- **Comprehensive test coverage** across all flowchart features
- **Advanced ANTLR concepts** successfully implemented
The ANTLR parser is now ready to replace the Jison parser with confidence! 🎉

View File

@@ -1,166 +0,0 @@
/**
* ANTLR-based Flowchart Parser
*
* This is a proper ANTLR implementation using antlr-ng generated parser code.
* It provides the same interface as the Jison parser for 100% compatibility.
*
* Goal: Achieve 99.7% pass rate (944/947 tests) to match Jison parser performance
*/
import { CharStream, CommonTokenStream, ParseTreeWalker } from 'antlr4ng';
import { FlowLexer } from './generated/FlowLexer.js';
import { FlowParser } from './generated/FlowParser.js';
import { FlowchartListener } from './FlowchartListener.js';
import { FlowchartVisitor } from './FlowchartVisitor.js';
/**
* Main ANTLR parser class that provides the same interface as the Jison parser
*/
export class ANTLRFlowParser {
yy: any;
constructor() {
this.yy = {};
}
parse(input: string): any {
const startTime = performance.now();
// Count approximate complexity for performance decisions (optimized regex)
const edgeCount = (input.match(/-->/g) ?? []).length;
// Use simpler, faster regex for node counting
const nodeCount = new Set(input.match(/\w+(?=\s*(?:-->|;|[\[({]))/g) ?? []).size;
// Only log for complex diagrams or when debugging
const isComplexDiagram = edgeCount > 100 || input.length > 1000;
const getEnvVar = (name: string): string | undefined => {
try {
if (typeof process !== 'undefined' && process.env) {
return process.env[name];
}
} catch (_e) {
// process is not defined in browser, continue to browser checks
}
// In browser, check for global variables
if (typeof window !== 'undefined' && (window as any).MERMAID_CONFIG) {
return (window as any).MERMAID_CONFIG[name];
}
return undefined;
};
const shouldLog = isComplexDiagram || getEnvVar('ANTLR_DEBUG') === 'true';
if (shouldLog) {
console.log('🎯 ANTLR Parser: Starting parse');
console.log(`📝 Input length: ${input.length} characters`);
console.log(`📊 Estimated complexity: ~${edgeCount} edges, ~${nodeCount} nodes`);
}
try {
// Reset database state
const resetStart = performance.now();
if (shouldLog) console.log('🔄 ANTLR Parser: Resetting database state');
if (this.yy.clear) {
this.yy.clear();
}
const resetTime = performance.now() - resetStart;
// Create input stream and lexer (fast operations, minimal logging)
const lexerSetupStart = performance.now();
const inputStream = CharStream.fromString(input);
const lexer = new FlowLexer(inputStream);
const tokenStream = new CommonTokenStream(lexer);
const lexerSetupTime = performance.now() - lexerSetupStart;
// Create parser (fast operation)
const parserSetupStart = performance.now();
const parser = new FlowParser(tokenStream);
const parserSetupTime = performance.now() - parserSetupStart;
// Generate parse tree (this is the bottleneck)
const parseTreeStart = performance.now();
if (shouldLog) console.log('🌳 ANTLR Parser: Starting parse tree generation');
const tree = parser.start();
const parseTreeTime = performance.now() - parseTreeStart;
if (shouldLog) {
console.log(`⏱️ Parse tree generation took: ${parseTreeTime.toFixed(2)}ms`);
console.log('✅ ANTLR Parser: Parse tree generated successfully');
}
// Check if we should use Visitor or Listener pattern
// Default to Visitor pattern (true) unless explicitly set to false
const useVisitorPattern = getEnvVar('USE_ANTLR_VISITOR') !== 'false';
const traversalStart = performance.now();
if (useVisitorPattern) {
if (shouldLog) console.log('🎯 ANTLR Parser: Creating visitor');
const visitor = new FlowchartVisitor(this.yy);
if (shouldLog) console.log('🚶 ANTLR Parser: Visiting parse tree');
try {
visitor.visit(tree);
if (shouldLog) console.log('✅ ANTLR Parser: Visitor completed successfully');
} catch (error) {
console.error('❌ ANTLR Parser: Visitor failed:', error.message);
console.error('❌ ANTLR Parser: Visitor stack:', error.stack);
throw error;
}
} else {
if (shouldLog) console.log('👂 ANTLR Parser: Creating listener');
const listener = new FlowchartListener(this.yy);
if (shouldLog) console.log('🚶 ANTLR Parser: Walking parse tree');
try {
ParseTreeWalker.DEFAULT.walk(listener, tree);
if (shouldLog) console.log('✅ ANTLR Parser: Listener completed successfully');
} catch (error) {
console.error('❌ ANTLR Parser: Listener failed:', error.message);
console.error('❌ ANTLR Parser: Listener stack:', error.stack);
throw error;
}
}
const traversalTime = performance.now() - traversalStart;
const totalTime = performance.now() - startTime;
// Only show performance breakdown for complex diagrams or debug mode
if (shouldLog) {
console.log(`⏱️ Tree traversal took: ${traversalTime.toFixed(2)}ms`);
console.log(
`⏱️ Total parse time: ${totalTime.toFixed(2)}ms (${(totalTime / 1000).toFixed(2)}s)`
);
// Performance breakdown
console.log('📊 Performance breakdown:');
console.log(
` - Database reset: ${resetTime.toFixed(2)}ms (${((resetTime / totalTime) * 100).toFixed(1)}%)`
);
console.log(
` - Lexer setup: ${lexerSetupTime.toFixed(2)}ms (${((lexerSetupTime / totalTime) * 100).toFixed(1)}%)`
);
console.log(
` - Parser setup: ${parserSetupTime.toFixed(2)}ms (${((parserSetupTime / totalTime) * 100).toFixed(1)}%)`
);
console.log(
` - Parse tree: ${parseTreeTime.toFixed(2)}ms (${((parseTreeTime / totalTime) * 100).toFixed(1)}%)`
);
console.log(
` - Tree traversal: ${traversalTime.toFixed(2)}ms (${((traversalTime / totalTime) * 100).toFixed(1)}%)`
);
console.log('✅ ANTLR Parser: Parse completed successfully');
}
return this.yy;
} catch (error) {
const totalTime = performance.now() - startTime;
console.log(`❌ ANTLR parsing error after ${totalTime.toFixed(2)}ms:`, error);
console.log('📝 Input that caused error (first 500 chars):', input.substring(0, 500));
throw error;
}
}
// Provide the same interface as Jison parser
setYY(yy: any) {
this.yy = yy;
}
}
// Export for compatibility with existing code
export const parser = new ANTLRFlowParser();

View File

@@ -4,7 +4,6 @@ import { setConfig } from '../../../config.js';
setConfig({
securityLevel: 'strict',
maxEdges: 50000, // Increase edge limit for performance testing
});
describe('[Text] when parsing', () => {
@@ -14,37 +13,9 @@ describe('[Text] when parsing', () => {
});
describe('it should handle huge files', function () {
// Start with a smaller test to identify bottlenecks
it('it should handle medium diagrams (performance test)', function () {
// Much smaller test: ~1000 edges instead of 47,917
const nodes = 'A-->B;B-->A;'.repeat(500);
flow.parser.parse(`graph LR;${nodes}`);
const vert = flow.parser.yy.getVertices();
const edges = flow.parser.yy.getEdges();
expect(edges[0].type).toBe('arrow_point');
expect(edges.length).toBe(1000);
expect(vert.size).toBe(2);
});
// Keep the original huge test but skip it for now
it.skip('it should handle huge diagrams (47,917 edges)', function () {
// More efficient string generation using array join
const parts = [];
// First part: ('A-->B;B-->A;'.repeat(415) + 'A-->B;').repeat(57)
const basePattern = 'A-->B;B-->A;'.repeat(415) + 'A-->B;';
for (let i = 0; i < 57; i++) {
parts.push(basePattern);
}
// Second part: 'A-->B;B-->A;'.repeat(275)
parts.push('A-->B;B-->A;'.repeat(275));
const nodes = parts.join('');
// skipped because this test takes like 2 minutes or more!
it.skip('it should handle huge diagrams', function () {
const nodes = ('A-->B;B-->A;'.repeat(415) + 'A-->B;').repeat(57) + 'A-->B;B-->A;'.repeat(275);
flow.parser.parse(`graph LR;${nodes}`);
const vert = flow.parser.yy.getVertices();

View File

@@ -535,9 +535,7 @@ describe('[Text] when parsing', () => {
expect(vert.get('A').text).toBe('this is an ellipse');
});
it.skip('should not freeze when ellipse text has a `(`', function () {
// TODO: ANTLR parser error handling - Jison and ANTLR have different error handling mechanisms
// Need to define custom error messages for ANTLR parser later
it('should not freeze when ellipse text has a `(`', function () {
expect(() => flow.parser.parse('graph\nX(- My Text (')).toThrowError();
});
@@ -580,41 +578,31 @@ describe('[Text] when parsing', () => {
expect(edges[0].text).toBe(',.?!+-*');
});
it.skip('should throw error at nested set of brackets', function () {
// TODO: ANTLR parser error handling - Jison and ANTLR have different error handling mechanisms
// Need to define custom error messages for ANTLR parser later
it('should throw error at nested set of brackets', function () {
const str = 'graph TD; A[This is a () in text];';
expect(() => flow.parser.parse(str)).toThrowError("got 'PS'");
});
it.skip('should throw error for strings and text at the same time', function () {
// TODO: ANTLR parser error handling - Jison and ANTLR have different error handling mechanisms
// Need to define custom error messages for ANTLR parser later
it('should throw error for strings and text at the same time', function () {
const str = 'graph TD;A(this node has "string" and text)-->|this link has "string" and text|C;';
expect(() => flow.parser.parse(str)).toThrowError("got 'STR'");
});
it.skip('should throw error for escaping quotes in text state', function () {
// TODO: ANTLR parser error handling - Jison and ANTLR have different error handling mechanisms
// Need to define custom error messages for ANTLR parser later
it('should throw error for escaping quotes in text state', function () {
//prettier-ignore
const str = 'graph TD; A[This is a \"()\" in text];'; //eslint-disable-line no-useless-escape
expect(() => flow.parser.parse(str)).toThrowError("got 'STR'");
});
it.skip('should throw error for nested quotation marks', function () {
// TODO: ANTLR parser error handling - Jison and ANTLR have different error handling mechanisms
// Need to define custom error messages for ANTLR parser later
it('should throw error for nested quotation marks', function () {
const str = 'graph TD; A["This is a "()" in text"];';
expect(() => flow.parser.parse(str)).toThrowError("Expecting 'SQE'");
});
it.skip('should throw error', function () {
// TODO: ANTLR parser error handling - Jison and ANTLR have different error handling mechanisms
// Need to define custom error messages for ANTLR parser later
it('should throw error', function () {
const str = `graph TD; node[hello ) world] --> works`;
expect(() => flow.parser.parse(str)).toThrowError("got 'PE'");
});

View File

@@ -140,6 +140,7 @@ that id.
.*direction\s+BT[^\n]* return 'direction_bt';
.*direction\s+RL[^\n]* return 'direction_rl';
.*direction\s+LR[^\n]* return 'direction_lr';
.*direction\s+TD[^\n]* return 'direction_td';
[^\s\"]+\@(?=[^\{\"]) { return 'LINK_ID'; }
[0-9]+ return 'NUM';
@@ -626,6 +627,8 @@ direction
{ $$={stmt:'dir', value:'RL'};}
| direction_lr
{ $$={stmt:'dir', value:'LR'};}
| direction_td
{ $$={stmt:'dir', value:'TD'};}
;
%%

View File

@@ -1,69 +1,12 @@
// @ts-ignore: JISON doesn't support types
import flowJisonParser from './flow.jison';
import { ANTLRFlowParser } from './antlr/antlr-parser.ts';
// Configuration flag to switch between parsers
// Set to true to test ANTLR parser, false to use original Jison parser
// Browser-safe environment variable access
const getEnvVar = (name: string): string | undefined => {
try {
if (typeof process !== 'undefined' && process.env) {
return process.env[name];
}
} catch (_e) {
// process is not defined in browser, continue to browser checks
}
const newParser = Object.assign({}, flowJisonParser);
// In browser, check for global variables or default values
if (typeof window !== 'undefined' && (window as any).MERMAID_CONFIG) {
return (window as any).MERMAID_CONFIG[name];
}
// Default to ANTLR parser in browser if no config is found
if (typeof window !== 'undefined' && name === 'USE_ANTLR_PARSER') {
return 'true';
}
return undefined;
};
const USE_ANTLR_PARSER = getEnvVar('USE_ANTLR_PARSER') === 'true';
// Force logging to window for debugging
if (typeof window !== 'undefined') {
(window as any).MERMAID_PARSER_DEBUG = {
USE_ANTLR_PARSER,
env_value: getEnvVar('USE_ANTLR_PARSER'),
selected_parser: USE_ANTLR_PARSER ? 'ANTLR' : 'Jison',
};
}
// eslint-disable-next-line no-console
console.log('🔧 FlowParser: USE_ANTLR_PARSER =', USE_ANTLR_PARSER);
// eslint-disable-next-line no-console
console.log('🔧 FlowParser: env USE_ANTLR_PARSER =', getEnvVar('USE_ANTLR_PARSER'));
// eslint-disable-next-line no-console
console.log('🔧 FlowParser: Selected parser:', USE_ANTLR_PARSER ? 'ANTLR' : 'Jison');
// Create the appropriate parser instance
let parserInstance;
if (USE_ANTLR_PARSER) {
parserInstance = new ANTLRFlowParser();
} else {
parserInstance = flowJisonParser;
}
// Create a wrapper that provides the expected interface
const newParser = {
parser: parserInstance,
parse: (src: string): unknown => {
// remove the trailing whitespace after closing curly braces when ending a line break
const newSrc = src.replace(/}\s*\n/g, '}\n');
if (USE_ANTLR_PARSER) {
return parserInstance.parse(newSrc);
} else {
return flowJisonParser.parse(newSrc);
}
},
newParser.parse = (src: string): unknown => {
// remove the trailing whitespace after closing curly braces when ending a line break
const newSrc = src.replace(/}\s*\n/g, '}\n');
return flowJisonParser.parse(newSrc);
};
export default newParser;

Some files were not shown because too many files have changed in this diff Show More