Weekly GitHub Report for Mermaid: April 21, 2025 - April 28, 2025 (12:00:20)
Weekly GitHub Report for Mermaid
Thank you for subscribing to our weekly newsletter! Each week, we deliver a comprehensive summary of your GitHub project's latest activity right to your inbox, including an overview of your project's issues, pull requests, contributors, and commit activity.
Table of Contents
I. News
1.1 Recent Version Releases:
The current version of this repository is @mermaid-js/parser@0.4.0
1.2 Version Information:
On March 25, 2025, a minor update was released for the Mermaid project, introducing a new feature that adds support for Radar Charts, thanks to the contribution from @thomascizeron.
II. Issues
2.1 Top 5 Active Issues:
We consider active issues to be issues that that have been commented on most frequently within the last week. Bot comments are omitted.
-
XY Chart bar chart doesn't begin at zero: This issue describes a problem with the XY Chart bar chart in which the bars do not start at the zero value on the y-axis, even when the lower limit is set to zero, leading to a misleading visual representation. The user provides a code sample and screenshots to illustrate the issue and suggests that the bars should begin at the y value zero or be clipped at the x-axis line if the zero value is below it.
- A commenter acknowledges the issue, mentions they have observed the same problem, and states they are working on a fix, promising to submit a pull request once the issue is resolved.
- Number of comments this week: 1
-
Sequence diagram requires colon and whitespace
:after an arrow without label: This issue highlights a problem in the Mermaid sequence diagram syntax where an arrow without a label requires a colon followed by a whitespace, which conflicts with code hygiene practices that remove trailing whitespace. The user suggests that the requirement for a colon and trailing whitespace should be removed to prevent sequence diagrams from breaking when editors automatically strip whitespace.- A commenter explains that the issue was due to the lexer expecting a character after the colon and has updated the grammar to allow a colon with or without trailing content, providing a fix and a test case, and plans to submit a pull request.
- Number of comments this week: 1
-
classDiagram: more than two generic types in return declaration not possible: This issue highlights a problem with the Mermaid classDiagram feature, where specifying a generic return type with more than two parameters in a method declaration results in an error. The user reports that while two parameters work correctly, attempting to use three parameters causes the issue, and they provide a code sample to illustrate the problem.
- The user suggests a workaround by using HTML entities
<and>for angle brackets, which allows the code to function correctly, but notes that this should not be necessary. - Number of comments this week: 1
- The user suggests a workaround by using HTML entities
Since there were fewer than 5 open issues, all of the open issues have been listed above.
2.2 Top 5 Stale Issues:
We consider stale issues to be issues that has had no activity within the last 30 days. The team should work together to get these issues resolved and closed as soon as possible.
- Tooltips for emoji in Diagram Syntax doc tree: This issue addresses the lack of clarity in the "Diagram Syntax" section of the documentation, where emojis are used next to diagram types without any explanation of their meanings. The proposal suggests adding tooltips to these emojis to help users understand the information they are intended to convey, enhancing the usability of the documentation.
- log scale for
xychart-beta: This issue proposes the addition of a string field namedscaleto thexychart-betafeature, which would default tolinearbut also acceptlogas an option, allowing for future extensions to other scales. The implementation of this feature would enable users to maintain version control of graph descriptions with true values while plotting the logged values, enhancing the flexibility and accuracy of data representation in charts. - Unable to Style Sequence Diagram Title: This issue pertains to the inability to modify the font size of the title in a sequence diagram created using Mermaid, which is causing the title to become very tiny when additional participants and interactions are added. The user notes that while other graph types in Mermaid have configurable title attributes, such as QuadrantChartConfig, this feature is not yet available for sequence diagrams, leading them to resort to using a Markdown title as a workaround.
- SVG rendering formatting issues with markdown input: This issue involves formatting problems with SVG rendering when markdown is used within nodes in diagrams created using the Mermaid tool. Specifically, it describes how additional height is added to nodes when opening the SVG in a new tab, and how text is cut off when downloading the SVG, despite the height remaining unchanged.
- Vite build error with mermaid version 10.9.0: This issue involves a build error encountered when using Vite with Mermaid version 10.9.0 in a Vue 3 application, where the developer successfully views graphs during development but encounters a "TypeError: Cannot set properties of undefined" upon building the project. The error occurs at application startup, and the developer has provided a code snippet illustrating the setup and initialization of Mermaid, along with a request for support to resolve the issue.
2.3 Open Issues
This section lists, groups, and then summarizes issues that were created within the last week in the repository.
Issues Opened This Week: 12
Summarized Issues:
- Timeline Diagram Styling Issues: The Mermaid project faces a problem where the
classDefandclasssyntax is not supported in timeline diagrams, leading to syntax errors and preventing customization of colors or highlighting of milestones. This issue affects the ability to visually distinguish important events in timeline diagrams.
- Gantt Chart Calculation and Enhancement Issues: The Gantt chart in Mermaid has a problem with exclusion settings, where it fails to skip excluded days like Fridays, resulting in incorrect timeline calculations. Additionally, there is a request to enhance the Gantt chart by adding support for 'year' intervals in axis ticks, which is currently limited to 'month'.
- XY Chart Bar Chart Issue: In the XY Chart bar chart, bars do not start at zero on the y-axis even when set to do so, leading to a misleading representation of bar heights. This issue suggests that bars should begin at the y value zero or be clipped at the x-axis line if the y value zero is below it.
- Sequence Diagram Syntax Issue: Mermaid sequence diagrams require a colon followed by whitespace for arrows without labels, which conflicts with code hygiene practices that remove trailing whitespace. Solutions are suggested to either not require the whitespace or the colon for all arrows.
- Rendering Regression in Architecture Diagrams: A regression in the rendering of architecture diagrams in Mermaid version 11.5.0 and later causes them to display differently compared to version 11.4.1. This change is likely due to a specific pull request, affecting the consistency of diagram rendering.
- Class Diagram Generic Return Type Limitation: The Mermaid classDiagram feature has a limitation where declaring a method with a generic return type involving more than two parameters results in an error. This issue highlights the need for improved support for complex generic return types.
- Accessibility Tags Parsing Issue: The
block-betadiagram parser in Mermaid cannot recognizeaccTitleandaccDescrtags, which are meant to provide accessibility features. This results in a parse error, hindering the inclusion of titles and descriptions for diagrams.
- Flowchart-ELK Layout Engine Node Order Issue: The
flowchart-elklayout engine in Mermaid fails to maintain the defined order of nodes, leading to arbitrary node placement. This behavior contrasts with the defaultflowchartengine, which respects the sequence of node definitions.
- Compatibility Issue with Older Chrome Versions: Version 11 of the Mermaid library does not function properly on Chrome versions earlier than 94 due to the lack of support for JavaScript static initialization blocks. This issue seeks advice on maintaining compatibility with older browser versions.
- Deterministic ID Seed Issue: The
deterministicIDSeedoption in Mermaid incorrectly uses the length of the seed value instead of the actual seed provided by the user. This breaks the expected determinism when the same seed string is reused across renders.
- Node.js Environment Parsing Error: In a Node.js environment, using
mermaid.parse()results in an error related to "DOMPurify.addHook is not a function." This suggests a potential misconfiguration or integration issue with DOMPurify within Mermaid.
2.4 Closed Issues
This section lists, groups, and then summarizes issues that were closed within the last week in the repository. This section also links the associated pull requests if applicable.
Issues Closed This Week: 0
Summarized Issues:
As of our latest update, there were no issues closed in the project this week.
2.5 Issue Discussion Insights
This section will analyze the tone and sentiment of discussions within this project's open and closed issues that occurred within the past week. It aims to identify potentially heated exchanges and to maintain a constructive project environment.
Based on our analysis, there are no instances of toxic discussions in the project's open or closed issues from the past week.
III. Pull Requests
3.1 Open Pull Requests
This section provides a summary of pull requests that were opened in the repository over the past week. The top three pull requests with the highest number of commits are highlighted as 'key' pull requests. Other pull requests are grouped based on similar characteristics for easier analysis. Up to 25 pull requests are displayed in this section, while any remaining pull requests beyond this limit are omitted for brevity.
Pull Requests Opened This Week: 2
Key Open Pull Requests
1. fix(sequenceDiagram): allow empty message after colon (Fixes #6518): This pull request addresses an issue in the Mermaid project by modifying the lexer rule to allow sequence diagram arrows with a trailing colon but no message to parse correctly, resolving a previously restrictive requirement that at least one character must follow the colon, and includes updates such as adding a changeset and unit tests.
- URL: pull/6523
- Merged: No
2. fix(xychart): align y-axis to start from zero (#6517): This pull request addresses the issue of the Y-axis in XY bar charts not starting at zero by forcing the Y-axis to always include zero in its range, adjusting the layout and rendering logic to ensure the graph's accuracy, and making changes specifically for bar charts while allowing other chart types to maintain their dynamic scaling, thereby resolving issue #6517.
- URL: pull/6526
- Merged: No
3.2 Closed Pull Requests
This section provides a summary of pull requests that were closed in the repository over the past week. The top three pull requests with the highest number of commits are highlighted as 'key' pull requests. Other pull requests are grouped based on similar characteristics for easier analysis. Up to 25 pull requests are displayed in this section, while any remaining pull requests beyond this limit are omitted for brevity.
Pull Requests Closed This Week: 2
Key Closed Pull Requests
1. Update samples.md: This pull request involves multiple updates to the samples.md file in the Mermaid project, as indicated by a series of commits, but it was not merged and lacks a detailed description or resolution of a specific issue.
- URL: pull/6521
- Merged: No
2. layout-elk package documentation misleading version: This pull request addresses a documentation issue in the layout-elk package by correcting a misleading version number in the CDN code snippet, which incorrectly showed layout-elk@11 instead of the current version v0.1.7.
- URL: pull/6511
- Merged: 2025-04-24T05:51:55Z
- Associated Commits: e7b39
3.3 Pull Request Discussion Insights
This section will analyze the tone and sentiment of discussions within this project's open and closed pull requests that occurred within the past week. It aims to identify potentially heated exchanges and to maintain a constructive project environment.
Based on our analysis, there are no instances of toxic discussions in the project's open or closed pull requests from the past week.
IV. Contributors
4.1 Contributors
Active Contributors:
We consider an active contributor in this project to be any contributor who has made at least 1 commit, opened at least 1 issue, created at least 1 pull request, or made more than 2 comments in the last month.
If there are more than 10 active contributors, the list is truncated to the top 10 based on contribution metrics for better clarity.
| Contributor | Commits | Pull Requests | Issues | Comments |
|---|---|---|---|---|
| jsoref | 105 | 0 | 5 | 2 |
| sidharthv96 | 38 | 4 | 1 | 7 |
| generrosity | 11 | 1 | 3 | 4 |
| monicanguyen25 | 12 | 1 | 0 | 0 |
| thomascizeron | 11 | 1 | 0 | 0 |
| lrecknagel | 10 | 1 | 1 | 0 |
| Shahir-47 | 11 | 0 | 0 | 0 |
| Maia313 | 9 | 1 | 0 | 0 |
| lgazo | 8 | 1 | 0 | 0 |
| nourhenta | 2 | 2 | 3 | 1 |