Fix multi line symbol link source range issue (#151) (#156)

* Fix multi line symbol link source range issue * Add disableSourcePosOpts ParseOptions
apple · Nov 14, 2023 · d91b618 · d91b618
1 parent 4ca8a13
commit d91b618
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 2 deletions.
diff --git a/Sources/Markdown/Parser/CommonMarkConverter.swift b/Sources/Markdown/Parser/CommonMarkConverter.swift
@@ -615,6 +615,9 @@ struct MarkupParser {
         if !options.contains(.disableSmartOpts) {
             cmarkOptions |= CMARK_OPT_SMART
         }
+        if !options.contains(.disableSourcePosOpts) {
+            cmarkOptions |= CMARK_OPT_SOURCEPOS
+        }
 
         let parser = cmark_parser_new(cmarkOptions)
 

diff --git a/Sources/Markdown/Parser/ParseOptions.swift b/Sources/Markdown/Parser/ParseOptions.swift
@@ -22,10 +22,13 @@ public struct ParseOptions: OptionSet {
     /// Enable interpretation of symbol links from inline code spans surrounded by two backticks.
     public static let parseSymbolLinks = ParseOptions(rawValue: 1 << 1)
 
-    /// Disable converting straight quotes to curly, --- to em dashes, -- to en dashes during parsing
+    /// Disable converting straight quotes to curly, --- to em dashes, -- to en dashes during parsing.
     public static let disableSmartOpts = ParseOptions(rawValue: 1 << 2)
 
     /// Parse a limited set of Doxygen commands. Requires ``parseBlockDirectives``.
     public static let parseMinimalDoxygen = ParseOptions(rawValue: 1 << 3)
+
+    /// Disable including a `data-sourcepos` attribute on all block elements during parsing.
+    public static let disableSourcePosOpts = ParseOptions(rawValue: 1 << 4)
 }
 
diff --git a/Tests/MarkdownTests/Inline Nodes/SymbolLinkTests.swift b/Tests/MarkdownTests/Inline Nodes/SymbolLinkTests.swift
@@ -46,4 +46,19 @@ class SymbolLinkTests: XCTestCase {
             XCTAssertEqual(expectedDump, document.debugDescription(options: .printSourceLocations))
         }
     }
+
+    func testMultilineSymbolLink() {
+        let source = """
+        Test of a ``multi
+        line symbolink``
+        """
+        let document = Document(parsing: source, options: .parseSymbolLinks)
+        let expectedDump = """
+            Document @1:1-2:17
+            └─ Paragraph @1:1-2:17
+               ├─ Text @1:1-1:11 "Test of a "
+               └─ SymbolLink @1:11-2:17 destination: multi line symbolink
+            """
+        XCTAssertEqual(expectedDump, document.debugDescription(options: .printSourceLocations))
+    }
 }
diff --git a/Tests/MarkdownTests/Parsing/BacktickTests.swift b/Tests/MarkdownTests/Parsing/BacktickTests.swift
@@ -36,7 +36,7 @@ class BacktickTests: XCTestCase {
         XCTAssertEqual(expectedDump, document.debugDescription(options: .printSourceLocations))
     }
 
-    func testOpenBackticks(){
+    func testOpenBackticks() {
         let double = "``"
         let document = Document(parsing: double)
         let expectedDump = """