Weekly GitHub Report for Mermaid: May 05, 2025 - May 12, 2025 (12:00:11)
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.
As of our latest update, there are no active issues with ongoing comments this week.
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 tree, where emojis are used next to diagram type names 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 Mermaid 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 corresponding logged values, enhancing the flexibility and accuracy of data visualization. - 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 small when additional participants and interactions are added. The user notes that while other graph types in Mermaid have configurable title attributes, such as those in QuadrantChartConfig, this functionality 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 pertains to formatting problems encountered when rendering SVG diagrams that include markdown formatting within nodes, specifically in the Mermaid project. Users have reported that when they open the SVG in a new tab, additional height is added to the node, and when downloading the SVG, the text is cut off, although the height remains unchanged.
- Vite build error with mermaid version 10.9.0: This issue involves a build error encountered when using Mermaid version 10.9.0 in a Vue 3 + Vite application, where the developer successfully views graphs during development but encounters a "TypeError: Cannot set properties of undefined" upon building the project. The error seems to occur during the application startup, specifically when attempting to set properties on an undefined object, as indicated by the stack trace provided in the issue description.
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: 2
Summarized Issues:
- Security Vulnerability in URL Handling: The Mermaid project has a security vulnerability due to improper escaping of backslashes before parentheses in URL handling code. This issue could lead to malformed escape sequences, affecting rendering and potentially introducing security risks in downstream parsing.
- Rendering Discrepancy in State Diagrams: There is a discrepancy in how labels on edges in state diagrams are rendered between the live version and the playground of the Mermaid project. The playground version shows curvier edges that do not approach the labels as closely, impacting visual consistency across different environments and browsers like Chrome and Firefox.
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: 3
Summarized Issues:
- Mermaid Flowchart Directionality: The proposal to add an "inheritDir" option to Mermaid flowcharts aims to address the limitation where subgraphs do not automatically follow the main graph's direction. This feature would allow subgraphs to inherit the global direction of the parent flowchart, ensuring a consistent visual structure without needing explicit direction settings.
- Mermaid Class Diagram Annotation Syntax: There is an inconsistency in the annotation syntax for class diagrams in the Mermaid documentation, which needs clarification. The issue highlights the need to determine if both the separate line and inline methods are equally valid, and if there are any behavioral differences or a preferred method for consistency and best practices.
- PRISMA Flowchart Representation in Mermaid: A proposal has been made to use the Mermaid.js library to create a flowchart representing the PRISMA process. This flowchart would visually detail the stages from the identification of records to the inclusion of studies in the final meta-analysis, aiding in systematic reviews and meta-analyses.
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: 6
Key Open Pull Requests
1. chore(xychart): Use a langium grammar for xychart: This pull request involves replacing the deprecated jison grammar of the xy diagram in the Mermaid project with a new langium grammar, introducing changes such as the addition of common tokens for numbers, support for the xy-beta keyword, and addressing breaking changes like requiring quotes for categories with spaces and disallowing leading zeros, while also updating tests and documentation to reflect these modifications.
- URL: pull/6572
- Merged: No
- Associated Commits: e7239, b4467, e35e6, 79c82, cd751, 5df4c, 5b2cb, 609ea, c81cb, 69de1, 50003, 81ceb, 32410, fc071, 17f93, 30c73, c1520, 43498, b7460, dab1b, d758e, 00a58, c2b83, 66616, 66ec0, 25bd2
2. fix(quadrant): ensure quadrant titles wrap and stay within bounds (#6562): This pull request addresses issue #6562 by implementing a fix to ensure that quadrant titles in the quadrantChart component are left-aligned, automatically wrapped using tspan elements, and remain within the quadrant's boundaries both horizontally and vertically, using D3.js to split long title strings into words and manually render each line, thereby maintaining legibility and correct positioning even for long or multi-word titles.
- URL: pull/6583
- Merged: No
3. fix: escape backslashes before parentheses in URL replacement logic: This pull request addresses a bug in the URL replacement logic by ensuring that backslashes are properly escaped before parentheses to prevent malformed escape sequences, as identified by CodeQL, and includes a minimal change to the edges.js file to enhance the robustness and predictability of string escaping.
- URL: pull/6566
- Merged: No
Other Open Pull Requests
- Library Upgrade: This pull request focuses on upgrading the @zenuml/core library to version 3.31.1. It addresses issue #588 on the mermaid-cli repository and incorporates various improvements from the ZenUML core library, ensuring that all necessary tests, documentation, and changelog updates are completed in accordance with the project's contribution guidelines.
- Documentation Update: This pull request proposes an update to the
integrations-community.mddocument by adding information about the Antora integration with MermaidJS. It includes two commits: one for the addition of the Antora integration and another for applying automated fixes.
- TypeScript Migration: This pull request involves migrating the Gantt Diagram database from JavaScript to TypeScript. The goal is to address issues related to unknown data types while maintaining the existing functionality to avoid introducing new bugs, as part of a learning project to better understand the workings of Mermaid.
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: 7
Key Closed Pull Requests
1. chore: Update announcement bar: This pull request involves updates to the announcement bar of the Mermaid project, with design decisions made by the Mermaid Chart growth team, and includes several commits focused on minor changes and updates, although it lacks additional unit/e2e tests and documentation.
- URL: pull/6568
- Merged: 2025-05-06T05:13:05Z
2. Codespace glorious space goldfish pj6wp6g97rr3766w: This pull request, titled "Codespace glorious space goldfish pj6wp6g97rr3766w," involves two commits, including an initial commit and subsequent changes exported from a codespace, but it was not merged into the main project repository.
- URL: pull/6569
- Merged: No
3. docs(classDiagram): Clarify annotation syntax and recommend inline st…: This pull request updates the Mermaid Class Diagram documentation to clarify the annotation syntax, explaining that both inline and separate line methods are valid but recommending the inline method for better readability and consistent formatting, and includes examples and a Tip box in the "Annotations on classes" section to enhance understanding.
- URL: pull/6541
- Merged: 2025-05-07T20:13:57Z
- Associated Commits: f8c54
Other Closed Pull Requests
- Open Graph Tags Addition: This pull request introduces Open Graph (og) tags to the project, which enhances metadata for improved social media sharing and integration. The change was implemented in a single commit and successfully merged into the main branch.
- GitHub Rate Limiting Solution: This pull request addresses the issue of GitHub rate limiting by implementing a batch process for downloading avatars. It includes tasks such as reading contribution guidelines, adding tests and documentation, and generating a changeset if necessary.
- Bug Fix for Image Updates: This pull request focuses on fixing a bug by updating images in the project. The update was successfully merged into the main branch on May 7, 2025.
- ER Diagram Layout Adjustment: This pull request improves the layout rendering for ER diagrams by adjusting row height and combining
yOffsetandrowHeightinto a unified structure. It also refines the calculation of total shape height and the alternating row fill logic.
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 | 26 | 6 | 1 | 10 |
| thomascizeron | 37 | 2 | 0 | 0 |
| generrosity | 11 | 0 | 3 | 1 |
| nourhenta | 12 | 0 | 3 | 0 |
| NourBenz | 12 | 1 | 0 | 1 |
| CoyAce | 11 | 1 | 0 | 0 |
| lrecknagel | 9 | 1 | 0 | 0 |
| Maia313 | 9 | 0 | 0 | 0 |
| rajat-ht | 4 | 1 | 0 | 4 |