fix(calm-widgets): update mermaid ID handling and sanitize identifier…#1807
Merged
LeighFinegold merged 5 commits intofinos:mainfrom Nov 17, 2025
Merged
fix(calm-widgets): update mermaid ID handling and sanitize identifier…#1807LeighFinegold merged 5 commits intofinos:mainfrom
LeighFinegold merged 5 commits intofinos:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes Mermaid diagram rendering issues by implementing proper ID sanitization and reserved word handling. The changes address conflicts with Mermaid's reserved keywords (like 'end', 'graph', 'subgraph') that were causing diagram generation failures, and improves HTML entity handling in the VS Code extension.
Key changes:
- Introduced
mermaidIdhelper function to sanitize node identifiers and prefix reserved words - Updated all Handlebars templates to use the new
mermaidIdhelper consistently - Added HTML entity decoding in the VS Code extension's Mermaid renderer
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| calm-widgets/src/widgets/block-architecture/core/utils.ts | Added mermaidId function with reserved word detection logic |
| calm-widgets/src/widget-helpers.ts | Implemented mermaidId as a Handlebars template helper |
| calm-widgets/src/widgets/block-architecture/typed-node.hbs | Updated to use mermaidId helper for all node IDs |
| calm-widgets/src/widgets/block-architecture/container.hbs | Updated to use mermaidId helper for container and node IDs |
| calm-widgets/src/widgets/block-architecture/click-links.hbs | Updated to use mermaidId helper for clickable links |
| calm-widgets/src/widgets/block-architecture/block-architecture.hbs | Updated to use mermaidId helper for nodes, edges, and highlights |
| calm-widgets/src/widgets/block-architecture/core/utils.spec.ts | Added comprehensive tests for mermaidId function |
| calm-widgets/src/widget-helpers.spec.ts | Added comprehensive tests for mermaidId template helper |
| calm-plugins/vscode/src/features/preview/webview/mermaid-renderer.ts | Added HTML entity decoding for Mermaid code blocks |
| calm-plugins/vscode/package.json | Bumped version from 0.0.8 to 0.0.9 |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
calm-plugins/vscode/src/features/preview/webview/mermaid-renderer.ts
Outdated
Show resolved
Hide resolved
rocketstack-matt
requested review from
LeighFinegold,
Thels,
aidanm3341,
grahampacker-ms,
jpgough-ms,
lbulanti-ms,
markscott-ms and
willosborne
as code owners
Member
Author
|
Once merged this change will need a manual publish of both the CLI (fixes for docify) and VSCode extension |
| expect(helpers.mermaidId(null)).toBe('node_empty'); | ||
| expect(helpers.mermaidId(undefined)).toBe('node_empty'); | ||
| expect(helpers.mermaidId(123)).toBe('node_empty'); | ||
| expect(helpers.mermaidId('')).toBe('node_empty'); |
Member
There was a problem hiding this comment.
Make sense for now. I guess we need to enhance all of this to calm validate a lot of this stuff anyways for the null case.
LeighFinegold
approved these changes
Nov 17, 2025
pmerrison
pushed a commit
to pmerrison/architecture-as-code
that referenced
this pull request
Nov 20, 2025
fix(calm-widgets): update mermaid ID handling and sanitize identifier…
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…s in widgets
Description
Resolves #1806
Type of Change
Affected Components
cli/)shared/)calm-widgets/)calm-hub/)calm-hub-ui/)docs/)calm-plugins/vscode/)Commit Message Format ✅
Testing
Checklist