commonmark / commonmark/cmark

HTML comments do not follow the 0.30 spec

Open
#476 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
2k
Forks
691
Avg merge
1d 16h
Merged PRs (30d)
1

Description

cmark 0.30.3 does not follow the spec for Example 625 and Example 626.

Example input to cmark --unsafe:

foo <!-- not a comment -- two hyphens -->

foo <!--> foo -->

foo <!-- foo--->

Expected output:

<p>foo &lt;!-- not a comment -- two hyphens --&gt;</p>
<p>foo &lt;!--&gt; foo --&gt;</p>
<p>foo &lt;!-- foo---&gt;</p>

Actual output:

<p>foo <!-- not a comment -- two hyphens --></p>
<p>foo <!--> foo --&gt;</p>
<p>foo &lt;!-- foo---&gt;</p>

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

First reproduce the discrepancy with cmark --unsafe using CommonMark Examples 625 and 626 and compare the actual HTML with the expected output in this report. Trace the HTML-comment parsing entry point in the cmark source and add or update coverage so all three inputs are rendered as escaped text rather than comments.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, markdown
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.