Feature/1768 sequencediagram custom grouping #4675
Conversation
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## develop #4675 +/- ##
============================================
+ Coverage 43.04% 79.34% +36.29%
============================================
Files 23 167 +144
Lines 5018 13916 +8898
Branches 21 710 +689
============================================
+ Hits 2160 11041 +8881
+ Misses 2857 2720 -137
- Partials 1 155 +154
Flags with carried forward coverage won't be shown. Click here to find out more.
|
| @@ -369,6 +369,30 @@ sequenceDiagram | |||
| API-->BillingService: Start billing process | |||
| ``` | |||
|
|
|||
| ## Custom Grouping | |||
There was a problem hiding this comment.
Make sure MERMAID_RELEASE_VERSION is used for all new features.
|
The group label and description should support "quoting", so we can have spaces and unicode symbols in it. Separating the label and description with just spaces doesn't seem like the most ideal way, any suggestions there? Can you also add some e2e tests with nested grouping?
|
* develop: (788 commits) Changes to gantt.html 1. Added a Gantt diagram that demonstrates to users that hashtages and semicolons can be added to titles, sections, and task data. Changes to gantt.spec.js 1. Added unit tests to ensure that semicolons and hashtags didn't break the functionality of the gantt diagram when used in titles, sections or task data. Changes to /parser/gantt.spec.js 1. Added rendering tests to ensure that semicolons and hashtags in titles, sections, and task data didn't break the rendering of Gantt diagrams. Lint Remove echo RefTest Echo event Update cypress Fix applitools docs: fix lint docs: move community to Discord Swap condition blocks to avoid using negation Reposition const declaration to ideal place Change repetitive values into consts docs: fix swimm link add sequenceDiagram link e2e test Fix Update Browserslist Use pnpm/action-setup@v2 Fix lint Cleanup e2e.yml Ignore push events on merge queue Remove :: ...
✅ Deploy Preview for mermaid-js ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| sequenceDiagram | ||
| Alice-->Bob: I have a secret | ||
| Bob-->Alice: What is it? | ||
| group:Whisper So nobody hears |
There was a problem hiding this comment.
| group:Whisper So nobody hears | |
| group:Whisper Slowly [So nobody hears] |
Let's wrap the description in [], so that we can have labels with spaces.
group:"Whisper" ["So nobody hears"] Quoting support can also be added to support unicode.
There was a problem hiding this comment.
@nirname I'm not really sure if this is the optimal approach to support group.
What do you think?
The following syntaxes need to be supported, without breaking existing diagrams having actors named "group".
group: Name [Desc]
group : Name With Space [Desc with space]
group: "Quoted name" ["Quoted desc"]
There was a problem hiding this comment.
I'll revive this PR but have to thoroughly check this
📑 Summary
Adds method for creating a grouping of actions (similar to loop, alt, break), but with a custom label.
Resolves #1768
📏 Design Decisions
Syntax uses "group" as a keyword, followed by a colon, followed by the custom label. White space around the colon is optional.
Example:
group:label [description]
... statements ...
end
📋 Tasks
Make sure you
MERMAID_RELEASE_VERSIONis used for all new features.developbranch