Weekly GitHub Report for Mermaid: March 31, 2025 - April 07, 2025 (12:00:53)
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.
-
Method return a pointer type, which is treated as an abstract type method.: This issue involves a method in a class diagram that returns a pointer type, which is currently being treated as an abstract type method due to the use of the asterisk (*) symbol. The user is seeking clarification and potential solutions to properly distinguish between pointer types and abstract classifiers in the Mermaid diagram syntax.
- The comments discuss the current interpretation of the asterisk (*) in Mermaid diagrams, suggesting that if pointer type support is needed, it should be considered an enhancement. A contributor offers to help implement syntax-level support for pointer types, and the original poster expresses interest in receiving assistance.
- Number of comments this week: 2
-
Some previews in the Flowchart documentation are failing: This issue involves the failure of some previews to render correctly on the Flowchart documentation page of the Mermaid library, resulting in syntax errors and console errors related to lexical parsing in version 11.6.0. The problem is specifically linked to incorrect syntax in the documentation examples, such as using
e1@->instead of the correcte1@-->, which causes parsing errors.- The comments indicate that a fix has been implemented for the broken example in the documentation, with a pull request submitted to address the syntax error. The contributor requests a review of the pull request and expresses gratitude for the work on the library.
- Number of comments this week: 2
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 for those unfamiliar with the icons.
- 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 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 a problem for users who want to maintain readability when the diagram includes numerous participants and interactions. The user notes that while other graph types in Mermaid, such as QuadrantChartConfig, have attributes for title customization, this feature is not yet available for sequence diagrams, leading them to resort to using Markdown titles 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 live editor. Users have reported that when opening 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 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 seems to occur during the application startup, specifically when attempting to set properties on an undefined object, which is likely related to the initialization or rendering process of Mermaid graphs.
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: 7
Summarized Issues:
- Sequence Diagram Lifeline Issues: Long lifelines in sequence diagrams created using Mermaid are being cut off, which affects the visual representation of the diagram. This issue requires a solution to ensure that the lifelines are displayed correctly without truncation.
- Class Diagram Pointer Type Misinterpretation: A method in a class diagram that returns a pointer type is incorrectly treated as an abstract type method due to syntax interpretation issues in Mermaid. Enhancing the parser to properly distinguish between pointer types and abstract classifiers is suggested to resolve this problem.
- Hidden Nodes Bug in Visualization: Hidden nodes with zero width in the Mermaid visualization tool can cause computation errors, specifically throwing an error message about finding a suitable point for a given distance. Modifying the hidden class definition or removing problematic edge labels is suggested to prevent this bug.
- Langium Grammar Complexity: The
common.langiumgrammar requires a custom ValueConverter, causing unnecessary complexity and discrepancies between the Langium playground and Mermaid's output. A revision is needed to eliminate this requirement and simplify the grammar.
- Flowchart Documentation Syntax Errors: Some previews fail to render correctly on the Flowchart documentation page due to syntax errors in the text for Mermaid version 11.6.0. Correcting the syntax from
e1@->toe1@-->is proposed to resolve the parsing error.
- Work Breakdown Structure Diagram Proposal: A proposal for creating a Work Breakdown Structure diagram to organize work-packages in a project management context is discussed. The potential integration with a Gantt manager for generating Gantt diagrams is also considered.
- Website Team Section Enhancement: Enhancing the "Meet The Team" section of the Mermaid website by adding interactive effects to team member cards is proposed. This includes ensuring correct placement of contributors and incorporating a footer with useful links and branding for improved user experience.
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: 4
Key Open Pull Requests
1. Add metadata for diagrams: This pull request aims to enhance the Mermaid project by adding metadata, including titles, descriptions, and examples, to all diagrams, allowing tools like mermaid.live and editor plugins to utilize examples provided by diagram authors, thereby eliminating the need for maintaining separate copies that require manual updates with each new diagram addition.
- URL: pull/6453
- Merged: No
- Associated Commits: c0b14, 865c4, 5b7c1, 0c759, 34e61, 7e7a4, 78291, 9b77a, 695b5, a25ee, 4b896, 28bdb, febae, 5acbd, 43e66
2. Radial layout prototype: This pull request introduces a prototype for radial layout support in the Mermaid project, addressing issue #938, and includes several commits for type checking, testing, and code formatting adjustments, while also ensuring compliance with contribution guidelines and documentation updates.
- URL: pull/6446
- Merged: No
3. fix(docs): fix edge ID example: This pull request addresses a documentation issue in the Flowchart section of the Mermaid project by correcting a rendering error caused by the use of a Unicode en dash instead of an ASCII dash in the edge syntax, ensuring that the example aligns with the supported syntax for assigning IDs to edges as introduced in Mermaid v11.6.0, without altering any functionality or implementation.
- URL: pull/6456
- Merged: No
Other Open Pull Requests
- Multi-line Titles in Diagrams: This pull request introduces native support for multi-line titles in various diagram types. It allows the use of
\nand<br>for line breaks, updates thedrawText()function to handle multi-line rendering with<tspan>elements, and refactorsinsertTitle()to ensure consistent title rendering across diagrams.
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. DOCS: update promo bar content: This pull request updates the promo bar content in the Mermaid project, as part of a design decision by the Mermaid Chart team, and includes a commit with the message "update promo bar content," but lacks additional unit/e2e tests, documentation updates, and changeset generation.
- URL: pull/6398
- Merged: 2025-04-02T09:22:53Z
- Associated Commits: ce68d
2. Feature: Support multi-line titles using \n and
in diagram types: This pull request introduces native support for multi-line titles in various diagram types by allowing the use of \n and <br> for line breaks, updating the drawText() function to handle multi-line rendering with <tspan> elements, and refactoring insertTitle() to ensure consistent title rendering across all applicable diagrams.
- URL: pull/6443
- Merged: No
- Associated Commits: 9ecac
3. chore: Downgrade chokidar to 3.6.0 for hot reloading fix: This pull request downgrades the chokidar library from version 4.0.3 to 3.6.0 to address issues with hot reloading that were impacting development workflows.
- URL: pull/6445
- Merged: 2025-04-01T12:55:30Z
- Associated Commits: 32c70
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 |
|---|---|---|---|---|
| BambioGaming | 24 | 5 | 0 | 6 |
| lgazo | 24 | 1 | 0 | 0 |
| ashishjain0512 | 18 | 0 | 0 | 1 |
| thomascizeron | 16 | 1 | 0 | 0 |
| nourhenta | 5 | 2 | 4 | 4 |
| nour0205 | 1 | 4 | 3 | 7 |
| No author found | 14 | 0 | 0 | 0 |
| sidharthv96 | 13 | 1 | 0 | 0 |
| Shahir-47 | 10 | 0 | 0 | 0 |
| kevinwuhoo | 7 | 1 | 0 | 0 |