Skip to content

Second code span not recognised after an unclosed backtick string and another code span #458

Description

@DRMacIver

Steps to reproduce the problem (provide example Markdown if applicable):

`` `a` `c`

The same through the API, with two neighbouring inputs that render correctly, to show the trigger:

import org.commonmark.parser.Parser;
import org.commonmark.renderer.html.HtmlRenderer;

public class Main {
    public static void main(String[] args) {
        Parser parser = Parser.builder().build();
        HtmlRenderer renderer = HtmlRenderer.builder().build();
        for (String md : new String[] {"`` `a` `c`", "`` `a`", "`a` `c`"}) {
            System.out.print(md + "  ->  " + renderer.render(parser.parse(md)));
        }
    }
}

Expected behavior:

<p>`` <code>a</code> <code>c</code></p>

This is what the reference implementation, commonmark.js 0.31.2, gives for all three inputs: the `` has no
closing double backtick and stays literal, and both `a` and `c` are code spans (spec 0.31.2, Code spans).

Actual behavior:

<p>`` <code>a</code> `c`</p>

The full output of the program above:

`` `a` `c`  ->  <p>`` <code>a</code> `c`</p>
`` `a`  ->  <p>`` <code>a</code></p>
`a` `c`  ->  <p><code>a</code> <code>c</code></p>

The second code span, `c`, is left as text. It takes all three parts: with only the unclosed `` and one
code span, or with the two code spans and no unclosed string, the output is correct. Text between the parts changes
nothing, and every further code span of the same length stays text too: `a` `c` `e` after the unclosed string
gives <code>a</code> `c` `e`.

Tested on commonmark 0.30.0 from Maven Central and on current main (b89e72f).

BTW, this was found by an automated program that writes property-based tests for various open source projects using hegel (but it has been reviewed by hand before reporting). We've also potentially found (but not yet hand validated) 51 other bugs in commonmark-java. You can see the tests at https://github.com/hegeldev/hegel-zoo/tree/main/targets/java/commonmark-java. Let us know if you would like us to file the other bugs found and/or contribute the tests. NB the tests are currently LLM generated and probably not yet suitable for inclusion as is, but we're happy to help get them into a better state if you want them.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions