Update HTML comment scanning

Looks like commonmark.js has a bug in its handling: commonmark/commonmark.js#285
commonmark · Mar 2, 2024 · 203eeb2 · 203eeb2
1 parent 058e2f0
commit 203eeb2
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/commonmark/src/main/java/org/commonmark/internal/inline/HtmlInlineParser.java b/commonmark/src/main/java/org/commonmark/internal/inline/HtmlInlineParser.java
@@ -142,8 +142,9 @@ private static boolean tryProcessingInstruction(Scanner scanner) {
     }
 
     private static boolean tryComment(Scanner scanner) {
-        // spec: An HTML comment consists of <!-- + text + -->, where text does not start with > or ->, does not end
-        // with -, and does not contain --. (See the HTML5 spec.)
+        // spec: An [HTML comment](@) consists of `<!-->`, `<!--->`, or  `<!--`, a string of
+        // characters not including the string `-->`, and `-->` (see the
+        // [HTML spec](https://html.spec.whatwg.org/multipage/parsing.html#markup-declaration-open-state)).
 
         // Skip first `-`
         scanner.next();
@@ -152,12 +153,12 @@ private static boolean tryComment(Scanner scanner) {
         }
 
         if (scanner.next('>') || scanner.next("->")) {
-            return false;
+            return true;
         }
 
         while (scanner.find('-') >= 0) {
-            if (scanner.next("--")) {
-                return scanner.next('>');
+            if (scanner.next("-->")) {
+                return true;
             } else {
                 scanner.next();
             }

diff --git a/commonmark/src/test/java/org/commonmark/test/HtmlInlineParserTest.java b/commonmark/src/test/java/org/commonmark/test/HtmlInlineParserTest.java
@@ -8,7 +8,11 @@ public class HtmlInlineParserTest extends CoreRenderingTestCase {
     public void comment() {
         assertRendering("inline <!---->", "<p>inline <!----></p>\n");
         assertRendering("inline <!-- -> -->", "<p>inline <!-- -> --></p>\n");
-        assertRendering("inline <!--->-->", "<p>inline &lt;!---&gt;--&gt;</p>\n");
+        assertRendering("inline <!-- -- -->", "<p>inline <!-- -- --></p>\n");
+        assertRendering("inline <!-- --->", "<p>inline <!-- ---></p>\n");
+        assertRendering("inline <!-- ---->", "<p>inline <!-- ----></p>\n");
+        assertRendering("inline <!-->-->", "<p>inline <!-->--&gt;</p>\n");
+        assertRendering("inline <!--->-->", "<p>inline <!--->--&gt;</p>\n");
     }
 
     @Test