fix(ansi): render HTML entities verbatim in code spans - #569
Open
troclaux wants to merge 1 commit into
Open
Conversation
html.UnescapeString was applied to code span content, converting entities like > to >. Code spans should render content literally. Fixes charmbracelet#94
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
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.
Problem
HTML entities inside inline code spans are decoded by
html.UnescapeStringbefore rendering. This means`>`renders as>instead of the literal string>.Code spans should render their content verbatim — the Markdown spec is clear that code spans protect their content from HTML processing.
Root Cause
In
ansi/elements.go, theKindCodeSpancase callshtml.UnescapeString(s)on the raw span text:Unlike regular prose, code span content comes from
n.Text(source)which is the raw source bytes — no entity decoding should be applied.Test
Added
testdata/issues/94.mdand golden file confirming that`>`now renders as>rather than>.Fixes #94