Skip to content

Allow info string of fenced code to start with the other fence character #464

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

Open
ybai08 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow info string of fenced code to start with the other fence character #464

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
23 changes: 6 additions & 17 deletions commonmark/src/main/java/org/commonmark/internal/FencedCodeBlockParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,30 +94,19 @@ public BlockStart tryStart(ParserState state, MatchedBlockParser matchedBlockPar
// spec: A code fence is a sequence of at least three consecutive backtick characters (`) or
// tildes (~). (Tildes and backticks cannot be mixed.)
private static FencedCodeBlockParser checkOpener(CharSequence line, int index, int indent) {
int backticks = 0;
int tildes = 0;
// The fence is only the run of the first character, the info string can start directly
// after it with the other character (e.g. "```~" or "~~~`").
int length = line.length();
loop:
for (int i = index; i < length; i++) {
switch (line.charAt(i)) {
case '`':
backticks++;
break;
case '~':
tildes++;
break;
default:
break loop;
}
}
if (backticks >= 3 && tildes == 0) {
int backticks = Characters.skip('`', line, index, length) - index;
int tildes = Characters.skip('~', line, index, length) - index;
if (backticks >= 3) {
// spec: If the info string comes after a backtick fence, it may not contain any
// backtick characters.
if (Characters.find('`', line, index + backticks) != -1) {
return null;
}
return new FencedCodeBlockParser('`', backticks, indent);
} else if (tildes >= 3 && backticks == 0) {
} else if (tildes >= 3) {
// spec: Info strings for tilde code blocks can contain backticks and tildes
return new FencedCodeBlockParser('~', tildes, indent);
} else {
Expand Down
30 changes: 30 additions & 0 deletions commonmark/src/test/java/org/commonmark/test/FencedCodeBlockParserTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,36 @@ public void backtickInfo() {
assertThat(codeBlock.getLiteral()).isEqualTo("code\n");
}

@Test
public void backtickInfoCanStartWithTilde() {
var s =
"""
```~/.bashrc
code
```
""";
var document = PARSER.parse(s);
FencedCodeBlock codeBlock = (FencedCodeBlock) document.getFirstChild();
assertThat(codeBlock.getFenceCharacter()).isEqualTo("`");
assertThat(codeBlock.getOpeningFenceLength()).isEqualTo(3);
assertThat(codeBlock.getInfo()).isEqualTo("~/.bashrc");
assertThat(codeBlock.getLiteral()).isEqualTo("code\n");
}

@Test
public void tildeInfoCanStartWithBacktick() {
assertRendering(
"""
~~~`info`
code
~~~
""",
"""
<pre><code class="language-`info`">code
</code></pre>
""");
}

@Test
public void backtickInfoDoesntAllowBacktick() {
assertRendering(
Expand Down