refly-ai/refly

Mermaid should support displaying rendering error syntax information to help users easily identify and resolve issues

Open

#724 opened on Apr 16, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (7,331 stars) (712 forks)user submission
enhancementgood first issue

Description

Is your feature request related to a problem? Please describe. The proposal is to enhance the Mermaid diagramming tool by adding a feature that provides clear and detailed error messages when there are syntax errors in diagram definitions. This would help users quickly understand and fix mistakes in their diagram code, improving the overall user experience and making it easier to debug and create correct diagrams.

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

Contributor guide

Tech stack
javascripttypescript
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Familiarity with Mermaid syntaxBasic understanding of error handling in web apps
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how Mermaid currently renders syntax errors in the refly application. Look at the Mermaid library's error handling code (likely in node modules/mermaid) and the integration point in refly's source code. Check if there is any existing error display component. The goal is to intercept and enhance error messages so users see clear, actionable syntax error details instead of generic failures.