How chenyanchen/mermaid-formatter works
mermaid-formatter is a lightweight Mermaid syntax formatter with a CLI and programmatic API, plus Prettier integration. The main workflow accepts diagram text, identifies whether its indentation is semantics-sensitive, parses ordinary diagrams into a statement AST, then formats that AST. Markdown fenced blocks reuse the API. The source excerpts show the API orchestration and core parser/formatter calls; relationships for the separately registered Prettier plugin are documented by its source. No runtime storage or external service is present.
Main entry points: index.ts Public API · parser.ts Diagram Parser · cli.ts CLI · prettier-plugin.ts Prettier Plugin
Components 11
User Entry Points
- CLI
src/cli.ts - Prettier Plugin
src/prettier-plugin.ts - Public API
src/index.ts - Markdown Blocks
src/index.ts
Formatting Core
- Indent Policy
src/rules.ts - AST Formatter
src/formatter.ts
Syntax Model
- Diagram Parser
src/parser.ts - Grammar Rules
src/rules.ts - Diagram AST
src/types.ts
Other components
- User
- Prettier
Connections 13
- User → CLI: invokes
README.md - CLI → Public API: calls
src/cli.ts - User → Public API: calls
README.md - Prettier → Prettier Plugin: loads
README.md - Prettier Plugin → Public API: calls
src/prettier-plugin.ts - Public API → Indent Policy: checks policy
src/index.ts - Public API → Diagram Parser: parses with
src/index.ts - Diagram Parser → Grammar Rules: matches syntax
src/parser.ts - Public API → AST Formatter: formats with
src/index.ts - Diagram Parser → Diagram AST: produces
src/parser.ts - AST Formatter → Diagram AST: reads
src/formatter.ts - Public API → Markdown Blocks: formats blocks
src/index.ts - Markdown Blocks → Public API: formats Mermaid
src/index.ts