Weekly GitHub Report for Mermaid: March 03, 2025 - March 10, 2025
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, which included a fix for offset calculations related to the diamond shape when handling intersections, 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.
-
Broken link in https://github.com/briz123/mermaid/blob/develop/CONTRIBUTING.md: This issue highlights a broken link in the
CONTRIBUTING.mdfile of the Mermaid project, which makes it difficult for new contributors to locate the necessary documentation. The problem is specifically with the path./packages/mermaid/src/docs/community/contributing.md, which does not correctly lead to the intended file.- A contributor has submitted a pull request to fix the broken link, and the issue creator has acknowledged the fix. Another participant pointed out that the pull request has not yet been reviewed or merged, suggesting the issue should remain open until it is resolved. The issue creator agreed with this suggestion.
- Number of comments this week: 4
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.
- 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 running the build and preview commands results in a TypeError in the browser. The error occurs when attempting to set properties of an undefined object, and it is noted that version 9.4 does not exhibit this problem, although there are slight API differences.
- Control brackets around loopText and friends: This issue proposes that the Mermaid project should provide an option to control the presence of brackets around elements like loopText in sequence diagrams, allowing users to customize their appearance through CSS. The request highlights the need for flexibility in styling, such as hiding brackets to match user-specific design preferences, and includes an example of how CSS can be used to achieve a desired look without the default text brackets.
- Lots of whitespace around C4 graph.: This issue pertains to the excessive whitespace generated around C4 context diagrams when exported using the Mermaid CLI tool, which is not observed with other types of diagrams. The problem has been open for nearly a year, and while steps to reproduce the issue are provided, no suggested solutions or additional context have been offered by the issue's author.
- 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 load due to a Content Security Policy (CSP) restriction that blocks a call toFunction(). The problem does not occur in Chromium-based browsers, and the user suspects that changes made in version v9.3.0, which made the build 25% smaller, might be related to the issue, but they have not identified any significant differences in the code that could explain the failure. - 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: 6
Summarized Issues:
- Production Build Errors with Vite Plugins: The issue involves an error occurring in production builds when using the "vite-plugin-top-level-await" and "vite-plugin-wasm" dependencies with the Mermaid module. This results in an "Uncaught (in promise) TypeError: o is not a function" error, while the development build functions correctly.
- Class Diagram Generic Type Display Issue: A problem in a class diagram is noted where a generic type is not displayed correctly when the class is used as a base for another class. Specifically, the generic type
<Shape>disappears from the interface name when inheritance is involved.
- Enhancements to Mermaid Diagram Syntax and Features: There are proposals to enhance Mermaid diagrams by allowing
classDefto include shape definitions and the@{...}syntax to contain styles, aiming to simplify syntax and reduce clutter. Additionally, there is a proposal to enhance ER Diagrams by adding the capability to create relationships between specific fields of tables for more detailed visual representations.
- Rendering Issues in Different Browsers: A rendering problem is identified in Firefox where using an SVG file as an image with the
constraintoption enabled in a flowchart diagram results in errors and a corrupted image. The same setup works correctly in Google Chrome, highlighting a browser-specific issue.
- Mermaid's startOnLoad Feature and Syntax Highlighting: The default startOnLoad feature of Mermaid fails to render code blocks with syntax highlighting. A suggested solution is to use the textContent of the target element instead of innerHTML, allowing bloggers to have both syntax highlighting and rendered diagrams without additional customizations.
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: 1
Summarized Issues:
- Mermaid Plugin Gantt Diagram Width Limitation: The Mermaid plugin for a static site generator has a problem where the Gantt Diagram rendering is restricted to a maximum width of 300px. This limitation does not allow the diagram to dynamically adjust to fit the content or the parent container's width, which may be caused by a global variable in the Gantt Renderer code.
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: 8
Key Open Pull Requests
1. fix: Node and edge labels should only render as markdown if properly delimited: This pull request addresses the issue of ensuring that node and edge labels in the Mermaid project are only rendered as markdown when they are properly delimited with double-quote-backticks, thereby restoring the intended behavior and resolving issues #6275, #6048, and #5824, while also updating the node test logic and providing configuration options for label types.
- URL: pull/6345
- Merged: No
2. feat: support links in SVGs: This pull request introduces a new feature to the Mermaid project by adding support for links within SVGs, ensuring that necessary tests and documentation are included, and updating the changeset to reflect this enhancement.
- URL: pull/6352
- Merged: No
3. DOCS: Update homepage: This pull request involves updates to the homepage of the Mermaid project, including verbiage changes, styling updates, and the addition of assets, with the base branch set to master and no associated issue number for resolution.
- URL: pull/6355
- Merged: No
Other Open Pull Requests
- Bug Fixes and Documentation Updates in Mermaid Project: This topic covers pull requests that address bug fixes and documentation updates in the Mermaid project. One pull request focuses on allowing colons in events to enable markdown links in timeline SVGs, while another replaces a symbolic link with a hard link for CONTRIBUTING.md to prevent broken links. Additionally, a pull request adjusts heading levels in documentation to ensure proper hierarchical structure.
- New Features and Enhancements in Mermaid Project: This topic includes pull requests that introduce new features and enhancements to the Mermaid project. One pull request implements a proof of concept for rendering code blocks with syntax highlighting, while another involves adding new content or features with a focus on compliance with contribution guidelines and updating necessary documentation.
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: 3
Key Closed Pull Requests
1. fix: allow semicolons branching of markdown PR: This pull request, titled "fix: allow semicolons branching of markdown PR," was created primarily to trigger continuous integration (CI) for testing purposes, and it includes various commits such as adding markup support to timeline diagrams, updating documentation, and cleaning up imports, but it was ultimately not merged.
- URL: pull/6344
- Merged: No
- Associated Commits: 92791, 34272, b843d, e96d0, 770a6, 1bbc9, 86b61, 775ab, 2fad4, ee90d, 469df, 5a5d6, 2ce71, 0a19f, da401, 6ecb3, 4f94e, f1662, 0d8d7, 1f59b, 2bb03
2. wip: Add optInMarkdownLabels config setting: This pull request introduces a new configuration setting called optInMarkdownLabels to the Mermaid project, aimed at providing a smoother transition from version 10 to 11 by allowing users to disable automatic markdown processing for node labels, thereby addressing markdown rendering issues encountered during the upgrade, although it is still a work in progress with several unresolved issues and tasks.
- URL: pull/6277
- Merged: No
3. chore: support links in SVGs: This pull request aims to enhance the project by adding support for links within SVGs, complementing a previous pull request (#6343), and includes tasks such as reading contribution guidelines, adding necessary tests and documentation, and generating a changeset for changelog updates.
- URL: pull/6351
- Merged: No
- Associated Commits:
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 | 38 | 1 | 0 | 13 |
| saurabhg772244 | 29 | 1 | 0 | 12 |
| yari-dewalt | 37 | 1 | 0 | 0 |
| Shahir-47 | 20 | 1 | 0 | 0 |
| udvale | 21 | 0 | 0 | 0 |
| aloisklink | 1 | 0 | 0 | 16 |
| huynhicode | 13 | 1 | 0 | 0 |
| pranavm2109 | 13 | 0 | 0 | 0 |
| monicanguyen25 | 12 | 1 | 0 | 0 |
| jeswr | 8 | 4 | 0 | 0 |