Fix SVG class attribute escaping for user-defined classes #2707
Conversation
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
User-defined class names containing special characters like quotes
were being written to SVG class attributes without escaping, producing
invalid XML/SVG that fails validation. For example:
a: {class: test label: "Hello World"}
Would generate:
<g class="YQ== test label: "Hello World"">
This is invalid because the double quotes break the attribute.
The fix adds an escapeClassNames helper function that uses
html.EscapeString to properly escape special characters (", ', <, >, &)
before they are written to class attributes in the SVG output.
Co-Authored-By: Claude Opus 4.5 <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
escapeClassNameshelper function usinghtml.EscapeStringto properly escape class namesProblem
When using
{class: foo label: "bar"}syntax, D2 generates invalid SVG with unescaped quotes in class attributes:This breaks SVG validation:
Solution
The fix escapes user-defined class names with
html.EscapeStringbefore they are written to the SVG class attribute. After the fix:Test plan
escapeClassNamesfunction covering various special charactersxmllint --nooutpasses on output with quoted class valuesgo test ./d2renderers/d2svg/...- all tests passGenerated with Claude Code