Update clearHtmlCommentText helper to match CommonMark (instead of HTML) specification (refs #361).

test/html-comments.md

@@ -0,0 +1,65 @@
+# HTML Comments
+
+## Block Comments
+
+<https://spec.commonmark.org/0.29/#html-blocks>
+
+<!-- *comment * -->
+
+<!-- *comment * -->text
+
+   <!-- *comment * -->
+
+    <!-- *code * -->
+
+<!-- *comment *
+*comment * -->
+
+<!-- *comment *
+*comment *
+*comment * -->
+
+<!--> *{MD037} * -->
+
+<!---> *{MD037} * -->
+
+<!-- *comment * --->
+
+<!-- -- *comment * -->
+
+<!-- *comment * -- -->
+
+## Inline Comments
+
+<https://spec.commonmark.org/0.29/#html-comment>
+
+t<!-- *comment * -->
+
+t<!-- *comment * -->text
+
+   t<!-- *comment * -->
+
+    t<!-- *code * -->
+
+t<!-- *comment *
+*comment * -->
+
+t<!-- *comment *
+*comment *
+*comment * -->
+
+t<!--> *{MD037} * -->
+
+t<!---> *{MD037} * -->
+
+t<!-- *{MD037} * --->
+
+t<!-- -- *{MD037} * -->
+
+t<!-- *{MD037} * -- -->
+
+## Notes
+
+It's important that the rule used above is one that calls
+`helpers.forEachLine` so `markdown-it` doesn't ignore any
+incorrectly-remaining comment blocks.

test/ignore-comments.md

@@ -18,11 +18,11 @@ Hard	tab
 Hard	tab
 -->
 
-<!--
+Text <!--
 Hard	tab {MD010}
 Invalid--!>comment
 Hard	tab {MD010}
--->
+--> text
 
 Te<!-- Hard	tab -->xt
 

test/markdownlint-test-helpers.js

@@ -9,6 +9,12 @@ const helpers = require("../helpers");
 test("clearHtmlCommentTextValid", (t) => {
   t.plan(1);
   const validComments = [
+    "<!-->",
+    "<!--->",
+    "<!---->",
+    "<!-- comment -->",
+    " <!-- comment -->",
+    "  <!-- comment -->",
     "<!-- text -->",
     "<!--text-->",
     "<!-- -->",
@@ -47,6 +53,12 @@ test("clearHtmlCommentTextValid", (t) => {
     "text"
   ];
   const validResult = [
+    "<!-->",
+    "<!--->",
+    "<!---->",
+    "<!--         -->",
+    " <!--         -->",
+    "  <!--         -->",
     "<!--      -->",
     "<!--    -->",
     "<!-- -->",
@@ -100,22 +112,12 @@ test("clearHtmlCommentTextInvalid", (t) => {
     "<!-->text-->",
     "<!--->text-->",
     "<!---->",
-    // Restrictions from specification
     "<!-->-->",
     "<!-->t-->",
     "<!--->-->",
     "<!--->t-->",
-    "<!--<!--t-->",
-    "<!--t<!---->",
-    "<!--t<!--t-->",
-    // "<!---->t-->",
-    // "<!--t-->-->",
-    // "<!--t-->t-->",
-    "<!----!>t-->",
-    "<!--t--!>-->",
-    "<!--t--!>t-->",
-    "<!--<!--->",
-    "<!--t<!--->"
+    "<!---->t-->",
+    "    <!-- indented code block -->"
   ];
   const actual = helpers.clearHtmlCommentText(invalidComments.join("\n"));
   const expected = invalidComments.join("\n");