Weekly GitHub Report for Mermaid: March 18, 2025 - March 25, 2025 (12:12:45)
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/layout-elk@0.1.7
1.2 Version Information:
On November 27, 2024, a patch update was released for the Mermaid library, featuring a fix for offset calculations related to diamond shapes during intersection handling, contributed by @knsv.
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.
-
Timeline Title Does Not Wrap Correctly: This issue addresses a problem with the Mermaid diagram tool where the timeline title does not wrap correctly when it is too long, causing layout issues such as the diagram shrinking and horizontal overflow. The problem is demonstrated with a code sample and screenshots, highlighting the need for the title to break into multiple lines to maintain the diagram's readability and layout integrity.
- The comments discuss a solution involving replacing the SVG
<text>element with a<foreignObject>to enable proper text wrapping using HTML/CSS, which resolves the issue. Suggestions for further improvements include making the title larger and bold for better emphasis. A fix has been submitted to ensure long titles are wrapped correctly, preventing layout issues and maintaining readability. - Number of comments this week: 3
- The comments discuss a solution involving replacing the SVG
-
Incorrect Rendering of < in Mindmap: This issue involves the incorrect rendering of the
<character in mindmap nodes within the Mermaid.js library, where it is encoded as<, while the>character is rendered correctly. The problem is specific to mindmaps and does not affect other diagram types, suggesting a unique issue in the mindmap rendering logic.- The comments confirm the bug across multiple platforms and browsers, indicating a core issue in the mindmap rendering logic. Investigations reveal that the problem occurs at the SVG level, where
<is re-escaped unintentionally in<tspan>elements, and this behavior is consistent across different rendering methods and browsers. Further debugging is needed to address the re-escaping issue in the SVG text elements. - Number of comments this week: 2
- The comments confirm the bug across multiple platforms and browsers, indicating a core issue in the mindmap rendering logic. Investigations reveal that the problem occurs at the SVG level, where
-
11.5.0: Requirement diagram containment arrow reversed: This issue reports a regression in the Mermaid 11.5.0 release, where the containment arrowhead in requirement diagrams is incorrectly drawn on the "contained" member instead of the "container," deviating from the expected behavior seen in version 11.4.x. The user also notes a minor concern regarding the font size change in the Sankey diagrams, which, while more readable, may appear less tidy.
- A pull request has been submitted as a potential fix for the containment arrow issue, indicating ongoing efforts to address the problem.
- Number of comments this week: 1
-
Support for URLs as node text in flowcharts without parsing as links: This issue addresses a problem in Mermaid's flowchart syntax where nodes containing bracketed text with URLs fail to render and instead produce an error message indicating unsupported markdown for links. The expected behavior is for the node to display the URL as a label, or ideally, make it clickable, without causing rendering errors.
- A user expressed interest in collaborating with another contributor to work on resolving the issue.
- Number of comments this week: 1
-
SVG not Supported in PNG converter: This issue involves a problem with converting SVG files to PNG format, where the text within the SVG is not rendered in the resulting PNG image. Additionally, more complex diagrams result in the SVG to PNG converter detecting a malformed SVG file.
- A commenter suggests that Mermaid's live editor can directly download diagrams as PNGs, eliminating the need for external converters. They tested the conversion process with various online tools and found no issues, suggesting the problem might be specific to certain browsers or platforms.
- Number of comments this week: 1
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.
- vite build failure for 10.9.0: This issue involves a build failure in version 10.9.0 of a project using Vite with vite-react-swc, where the build process succeeds during development (
npm run dev) but encounters a TypeError during the build and preview stages (npm run build & npm run preview). The error, which states "Cannot set properties of undefined (setting 'prototype')", suggests a problem with the JavaScript code execution in the browser, and it is noted that version 9.4 does not exhibit this issue, although it has a slightly different API. - Control brackets around loopText and friends: This issue proposes that the Mermaid project should provide an option to control the addition of brackets around elements like loopText in sequence diagrams, allowing users to customize the appearance according to their style preferences, such as hiding brackets when they are not desired. The proposal includes an example of a sequence diagram and a CSS snippet demonstrating how users can apply custom styles to achieve a desired look, emphasizing the flexibility and control over the visual presentation of diagrams.
- Lots of whitespace around C4 graph.: This issue highlights a problem with excessive whitespace surrounding C4 context diagrams when generated using the Mermaid tool, which does not occur with other types of diagrams. The user provides a code sample and steps to reproduce the issue, indicating that the problem persists despite using the specified export command and version 10.8.0 of Mermaid.
- Mermaid versions after v9.2.2 cannot be injected into Firefox addons: This issue involves a problem with injecting the
mermaid.min.jsscript into Firefox browser extensions, where versions after v9.2.2 fail to inject due to a Content Security Policy (CSP) restriction that blocks a call toFunction(). The problem does not occur in Chromium-based browsers, and the issue has persisted since the release of Mermaid v9.3.0, leading to user inquiries and challenges in updating the extension for Firefox users. - support for Block diagrams to merge row blocks: This issue is a feature request for the Mermaid project, specifically seeking support for merging row blocks within Block diagrams to enhance their visual representation. The user provides a code sample and screenshots to illustrate the desired outcome, highlighting the current limitations and expressing the need for this enhancement to improve diagram functionality.
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: 13
Summarized Issues:
- Feature Enhancements in Mermaid: The Mermaid project has received proposals for feature enhancements, including the ability to include tables within notes in sequence diagrams and support for guillemet symbols for UML stereotypes. These enhancements aim to align with existing tools like PlantUML and improve visual aesthetics while ensuring compatibility with UML and SysML specifications.
- Rendering and Syntax Issues in Mermaid: Several issues have been reported regarding rendering and syntax in Mermaid diagrams, such as problems with bracketed URLs in flowcharts, tuple types in class diagrams, and the
<character in mindmap nodes. These issues result in errors or unexpected behavior, highlighting the need for improved handling of special characters and syntax.
- Layout and Text Wrapping Problems: Mermaid diagrams face layout issues, such as long timeline titles not wrapping correctly and circles in Sankey charts leaking out from behind bars. These problems cause visual inconsistencies and suggest a need for better text wrapping and layout management using HTML/CSS styling.
- Conversion and Compilation Errors: Users have encountered errors when converting SVG files to PNG format and when using inline comments in diagrams with the mmdc tool. These issues result in text not rendering or parse errors, indicating potential browser-specific problems or unexpected tokens in the code.
- Error Handling and Namespace Issues: Problems with error handling in sequence diagrams and missing
xlinknamespaces in SVGs have been reported in Mermaid. These issues cause browser hangs and incorrect rendering, suggesting a need for clearer grammar definitions and proper namespace inclusion.
- File Upload and Syntax Errors: A work overflow problem has been reopened due to failures in uploading specific markdown files, and a cryptic error message is reported when using reverse arrow syntax in flowcharts. These issues highlight the need for improved error messages and support for additional syntax.
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: 5
Key Open Pull Requests
1. Fix timeline title wrapping issue (#6393): This pull request addresses the issue of timeline titles not wrapping correctly in the Mermaid project by replacing the SVG <text> element with a <foreignObject> to enable proper text wrapping using HTML/CSS, ensuring that long titles break into multiple lines and maintain consistent diagram layouts, thereby resolving layout issues such as overflowing or shrinking diagrams.
- URL: pull/6394
- Merged: No
2. Move requirements containment arrow to edge start: This pull request proposes moving the containment arrowhead to the start of the edge in requirement diagrams, with slight geometry adjustments to prevent clipping, and addresses issue #6380 in the Mermaid project.
- URL: pull/6386
- Merged: No
3. Remove duplicates in integrations-community.md: This pull request aims to remove duplicate entries in the integrations-community.md file of the Mermaid project, as indicated by the title and the commit messages, while also ensuring compliance with contribution guidelines and documentation updates.
- URL: pull/6391
- Merged: No
Other Open Pull Requests
- Mermaid Timeline Diagram Layout Bug: This pull request addresses a layout bug in the Mermaid Timeline diagram by implementing a solution that ensures long titles wrap properly using SVG
<tspan>logic. It includes changes such as replacing the single<text>element with a group of dynamically calculated<tspan>elements, introducing awrapTextutility insvgDraw.js, and maintaining cross-browser consistency without using<foreignObject>.
- Promotional Bar Content Update: This pull request involves updating the content of the promotional bar in the Mermaid project. It is part of design decisions made by the Mermaid Chart team and includes a single commit with the message "update promo bar content."
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. feat: Add radar diagram: This pull request introduces a new feature to the Mermaid project by adding support for radar diagrams, which includes implementing a Langium grammar with a simple syntax for defining axes and curves, incorporating design decisions such as using a Catmull-Rom spline for closed rounded curves, and providing options for customization like min/max values, ticks, and theme-based styling, while also ensuring comprehensive documentation, tests, and adherence to contribution guidelines.
- URL: pull/6381
- Merged: Yes
2. Key Quantity of a Capable Sales and Marketing Manager: This pull request involves updating the gitgraph.md file in the Mermaid project, ensuring compliance with contribution guidelines, adding necessary tests and documentation, and preparing changesets for any notable changes, although it was ultimately not merged.
- URL: pull/6397
- Merged: No
- Associated Commits: d96f7
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 |
|---|---|---|---|---|
| sidharthv96 | 18 | 0 | 0 | 1 |
| yari-dewalt | 17 | 0 | 0 | 0 |
| No author found | 15 | 0 | 0 | 0 |
| Shahir-47 | 12 | 0 | 0 | 0 |
| thomascizeron | 10 | 1 | 0 | 0 |
| BambioGaming | 0 | 0 | 1 | 10 |
| nour0205 | 2 | 2 | 2 | 4 |
| saurabhg772244 | 10 | 0 | 0 | 0 |
| jeswr | 8 | 2 | 0 | 0 |
| huynhicode | 7 | 2 | 0 | 0 |