Remove HTML Comment Handling

Author: rdestefa

commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/internal/AlertHtmlNodeRenderer.java

@@ -2,9 +2,7 @@
 
 import org.commonmark.ext.gfm.alerts.Alert;
 import org.commonmark.ext.gfm.alerts.AlertTitle;
-import org.commonmark.node.HtmlInline;
 import org.commonmark.node.Node;
-import org.commonmark.node.Text;
 import org.commonmark.renderer.html.HtmlNodeRendererContext;
 import org.commonmark.renderer.html.HtmlWriter;
 
@@ -40,21 +38,6 @@ protected void renderAlert(Alert alert) {
         htmlWriter.tag("p", context.extendAttributes(alert, "p", Map.of("class", "markdown-alert-title")));
         var first = alert.getFirstChild();
         if (first instanceof AlertTitle) {
-            /*
-             * If the alert title only contains HTML comments like this:
-             *
-             * > [!TIP] <!-- This won't appear --> <!---> <!-- Neither will this -->
-             * > Body text
-             *
-             * Then the reader will see a blank title. In this case, it's better
-             * to render the default title (but keep the comments for accuracy).
-             *
-             * These comments will be visible when rendered to other formats like
-             * Markdown, so this is only relevant for the HTML renderer.
-             */
-            if (isCommentOnlyTitle(first)) {
-                htmlWriter.text(getAlertTitle(type));
-            }
             renderChildren(first);
         } else {
             htmlWriter.text(getAlertTitle(type));
@@ -90,38 +73,6 @@ private String getAlertTitle(String type) {
         }
     }
 
-    private boolean isCommentOnlyTitle(Node title) {
-        var node = title.getFirstChild();
-        if (node == null) {
-            return false;
-        }
-        while (node != null) {
-            if (node instanceof HtmlInline) {
-                if (!isHtmlComment((HtmlInline) node)) {
-                    return false;
-                }
-            } else if (node instanceof Text) {
-                if (!((Text) node).getLiteral().trim().isEmpty()) {
-                    return false;
-                }
-            } else {
-                return false;
-            }
-            node = node.getNext();
-        }
-        return true;
-    }
-
-    private boolean isHtmlComment(HtmlInline htmlInline) {
-        var literal = htmlInline.getLiteral();
-        if (literal == null || !literal.startsWith("<!--")) {
-            return false;
-        }
-        return literal.equals("<!-->")
-                || literal.equals("<!--->")
-                || literal.endsWith("-->");
-    }
-
     private void renderChildren(Node parent) {
         var node = parent.getFirstChild();
         while (node != null) {

commonmark-ext-gfm-alerts/src/test/java/org/commonmark/ext/gfm/alerts/AlertsTest.java

@@ -184,15 +184,6 @@ public void customTitleWithComment() {
                 "</div>\n");
     }
 
-    @Test
-    public void customTitleWithOnlyCommentFallsBackToDefaultTitle() {
-        assertRenderingCustomTitles("> [!TIP] <!-- This won't appear --> <!-- This won't either -->\n> Body text",
-                "<div class=\"markdown-alert markdown-alert-tip\" data-alert-type=\"tip\">\n" +
-                "<p class=\"markdown-alert-title\">Tip<!-- This won't appear --> <!-- This won't either --></p>\n" +
-                "<p>Body text</p>\n" +
-                "</div>\n");
-    }
-
     @Test
     public void customTitleWithInlineFormatting() {
         assertRenderingCustomTitles("> [!NOTE] Custom _title <ins>with **formatting**</ins>_\n> Note with a custom title",
@@ -264,15 +255,6 @@ public void onlyTrailingWhitespaceIsNotCustomTitle() {
                 "</div>\n");
     }
 
-    @Test
-    public void onlyHtmlCommentsInTitleUseDefaultTitle() {
-        assertRenderingCustomTitles("> [!NOTE] <!-- This won't appear --> <!---> <!-- Neither will this -->\n> Body text",
-                "<div class=\"markdown-alert markdown-alert-note\" data-alert-type=\"note\">\n" +
-                "<p class=\"markdown-alert-title\">Note<!-- This won't appear --> <!---> <!-- Neither will this --></p>\n" +
-                "<p>Body text</p>\n" +
-                "</div>\n");
-    }
-
     // Lazy continuation
 
     @Test