Skip to content

Don't escape = text if it's the first node in a block #338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robinst merged 1 commit into from
Sep 14, 2024
Merged

Don't escape = text if it's the first node in a block #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions commonmark/src/main/java/org/commonmark/renderer/markdown/CoreMarkdownNodeRenderer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,9 +366,11 @@ public void visit(Text text) {
break;
}
case '=': {
// Would be ambiguous with a Setext heading, escape
writer.raw("\\=");
literal = literal.substring(1);
// Would be ambiguous with a Setext heading, escape unless it's the first line in the block
if (text.getPrevious() != null) {
writer.raw("\\=");
literal = literal.substring(1);
}
break;
}
case '0':
Expand Down
3 changes: 3 additions & 0 deletions commonmark/src/test/java/org/commonmark/renderer/markdown/MarkdownRendererTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,9 @@ public void testEscaping() {
assertRoundTrip("\\## Test\n");
assertRoundTrip("\\#\n");
assertRoundTrip("Foo\n\\===\n");
// Only needs to be escaped after some text, not at beginning of paragraph
assertRoundTrip("===\n");
assertRoundTrip("a\n\n===\n");
// The beginning of the line within the block, so disregarding prefixes
assertRoundTrip("> \\- Test\n");
assertRoundTrip("- \\- Test\n");
Expand Down