HTML: Treat comments as self-closing tags (#10)

This patch makes Ink parse HTML comments correctly, by treating them as self-closing tags, rather than as opening ones (which would cause all subsequent text to be parsed as plain HTML).
JohnSundell · Nov 28, 2019 · a4f0c8d · a4f0c8d
1 parent e2f76b1
commit a4f0c8d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/Sources/Ink/Internal/HTML.swift b/Sources/Ink/Internal/HTML.swift
@@ -74,7 +74,7 @@ private extension Reader {
                     return (name.dropLast(), true)
                 }
 
-                return (name, suffix.last == "/")
+                return (name, suffix.last == "/" || name == "!--")
             }
 
             advanceIndex()

diff --git a/Tests/InkTests/HTMLTests.swift b/Tests/InkTests/HTMLTests.swift
@@ -93,6 +93,16 @@ final class HTMLTests: XCTestCase {
 
         XCTAssertEqual(html, "<p>Hello</p><br/><p>World</p>")
     }
+
+    func testHTMLComment() {
+        let html = MarkdownParser().html(from: """
+        Hello
+        <!-- Comment -->
+        World
+        """)
+
+        XCTAssertEqual(html, "<p>Hello</p><!-- Comment --><p>World</p>")
+    }
 }
 
 extension HTMLTests {
@@ -107,7 +117,8 @@ extension HTMLTests {
             ("testInlineParagraphTagEndingCurrentParagraph", testInlineParagraphTagEndingCurrentParagraph),
             ("testTopLevelSelfClosingHTMLElement", testTopLevelSelfClosingHTMLElement),
             ("testInlineSelfClosingHTMLElement", testInlineSelfClosingHTMLElement),
-            ("testTopLevelHTMLLineBreak", testTopLevelHTMLLineBreak)
+            ("testTopLevelHTMLLineBreak", testTopLevelHTMLLineBreak),
+            ("testHTMLComment", testHTMLComment)
         ]
     }
 }