Make hover popover prettier

rdar://126488098

Author: ahoppen

Sources/SourceKitLSP/Swift/CommentXML.swift

@@ -77,7 +77,7 @@ private struct XMLToMarkdown {
       newlineIfNeeded(count: 2)
       out += "```swift\n"
       toMarkdown(node.children)
-      out += "\n```\n\n---\n"
+      out += "\n```\n"
 
     case "Name", "USR", "Direction":
       break

Sources/SourceKitLSP/Swift/SwiftLanguageService.swift

@@ -569,46 +569,35 @@ extension SwiftLanguageService {
     let cursorInfoResults = try await cursorInfo(uri, position..<position).cursorInfo
 
     let symbolDocumentations = cursorInfoResults.compactMap { (cursorInfo) -> String? in
-      guard let name: String = cursorInfo.symbolInfo.name else {
-        // There is a cursor but we don't know how to deal with it.
-        return nil
-      }
-
-      /// Prepend backslash to `*` and `_`, to prevent them
-      /// from being interpreted as markdown.
-      func escapeNameMarkdown(_ str: String) -> String {
-        return String(str.flatMap({ ($0 == "*" || $0 == "_") ? ["\\", $0] : [$0] }))
-      }
-
-      var result = escapeNameMarkdown(name)
       if let documentation = cursorInfo.documentation {
+        var result = ""
         if let annotatedDeclaration = cursorInfo.annotatedDeclaration {
           let markdownDecl =
             orLog("Convert XML declaration to Markdown") {
               try xmlDocumentationToMarkdown(annotatedDeclaration)
             } ?? annotatedDeclaration
-          result += "\n\(markdownDecl)"
+          result += "\(markdownDecl)\n---\n"
         }
         result += documentation
+        return result
       } else if let doc = cursorInfo.documentationXML {
-        result += """
-
+        return """
           \(orLog("Convert XML to Markdown") { try xmlDocumentationToMarkdown(doc) } ?? doc)
           """
       } else if let annotated: String = cursorInfo.annotatedDeclaration {
-        result += """
-
+        return """
           \(orLog("Convert XML to Markdown") { try xmlDocumentationToMarkdown(annotated) } ?? annotated)
           """
+      } else {
+        return nil
       }
-      return result
     }
 
     if symbolDocumentations.isEmpty {
       return nil
     }
 
-    let joinedDocumentation = symbolDocumentations.joined(separator: "\n# Alternative result\n")
+    let joinedDocumentation = symbolDocumentations.joined(separator: "\n### Alternative result\n")
 
     return HoverResponse(
       contents: .markupContent(MarkupContent(kind: .markdown, value: joinedDocumentation)),
@@ -851,7 +840,7 @@ extension SwiftLanguageService {
       // Instead of returning an error, return empty results.
       logger.error(
         """
-        Loading diagnostic failed with the following error. Returning empty diagnostics. 
+        Loading diagnostic failed with the following error. Returning empty diagnostics.
         \(error.forLogging)
         """
       )

Tests/SourceKitLSPTests/HoverTests.swift

@@ -26,7 +26,6 @@ final class HoverTests: XCTestCase {
       struct 1️⃣S {}
       """,
       expectedContent: """
-        S
         ```swift
         struct S
         ```
@@ -70,21 +69,15 @@ final class HoverTests: XCTestCase {
       _ = 1️⃣Foo()
       """,
       expectedContent: """
-        Foo
         ```swift
         struct Foo
         ```
 
-        ---
-
-        # Alternative result
-        init()
+        ### Alternative result
         ```swift
         init()
         ```
 
-        ---
-
         """
     )
   }
@@ -96,7 +89,6 @@ final class HoverTests: XCTestCase {
       func 1️⃣test(_ a: Int, _ b: Int) { }
       """,
       expectedContent: ##"""
-        test(\_:\_:)
         ```swift
         func test(_ a: Int, _ b: Int)
         ```
@@ -114,7 +106,6 @@ final class HoverTests: XCTestCase {
       func 1️⃣*%*(lhs: String, rhs: String) { }
       """,
       expectedContent: ##"""
-        \*%\*(\_:\_:)
         ```swift
         func *%* (lhs: String, rhs: String)
         ```
@@ -135,7 +126,6 @@ final class HoverTests: XCTestCase {
       func 1️⃣eatApple() {}
       """,
       expectedContent: """
-        eatApple()
         ```swift
         func eatApple()
         ```