Add documentation to CodeSuggestionEntry

Author: thecoolwinter

Example/CodeEditSourceEditorExample/CodeEditSourceEditorExample/Views/MockCompletionDelegate.swift

@@ -49,7 +49,7 @@ class MockCompletionDelegate: CodeSuggestionDelegate, ObservableObject {
         var label: String
         var detail: String?
         var pathComponents: [String]?
-        var targetPosition: CursorPosition? { nil }
+        var targetPosition: CursorPosition? = CursorPosition(line: 10, column: 20)
         var sourcePreview: String?
         var image: Image = Image(systemName: "dot.square.fill")
         var imageColor: Color = .gray
@@ -75,7 +75,7 @@ class MockCompletionDelegate: CodeSuggestionDelegate, ObservableObject {
                     text: randomString,
                     detail: text.randomElement()!,
                     sourcePreview: randomString,
-                    pathComponents: (0..<Int.random(in: 1..<5)).map { text[$0] }
+                    pathComponents: (0..<Int.random(in: 0..<10)).map { text[$0] }
                 )
             )
         }

Sources/CodeEditSourceEditor/CodeSuggestion/Model/CodeSuggestionEntry.swift

@@ -12,6 +12,7 @@ import SwiftUI
 public protocol CodeSuggestionEntry {
     var label: String { get }
     var detail: String? { get }
+    var documentation: String? { get }
 
     /// Leave as `nil` if the link is in the same document.
     var pathComponents: [String]? { get }

Sources/CodeEditSourceEditor/CodeSuggestion/TableView/CodeSuggestionPreviewView.swift

@@ -39,7 +39,7 @@ final class CodeSuggestionPreviewView: NSVisualEffectView {
     var font: NSFont = .systemFont(ofSize: 12) {
         didSet {
             sourcePreviewLabel.font = font
-            pathComponentsLabel.font = font
+            pathComponentsLabel.font = .systemFont(ofSize: font.pointSize)
         }
     }
     var documentationFont: NSFont = .systemFont(ofSize: 12) {
@@ -76,6 +76,10 @@ final class CodeSuggestionPreviewView: NSVisualEffectView {
         styleStaticLabel(documentationLabel)
         styleStaticLabel(pathComponentsLabel)
 
+        pathComponentsLabel.maximumNumberOfLines = 1
+        pathComponentsLabel.lineBreakMode = .byTruncatingMiddle
+        pathComponentsLabel.usesSingleLineMode = true
+
         stackView.addArrangedSubview(sourcePreviewLabel)
         stackView.addArrangedSubview(documentationLabel)
         stackView.addArrangedSubview(pathComponentsLabel)
@@ -97,6 +101,10 @@ final class CodeSuggestionPreviewView: NSVisualEffectView {
         fatalError("init(coder:) has not been implemented")
     }
 
+    func hideIfEmpty() {
+        isHidden = sourcePreview == nil && documentation == nil && pathComponents.isEmpty
+    }
+
     func setPreferredMaxLayoutWidth(width: CGFloat) {
         sourcePreviewLabel.preferredMaxLayoutWidth = width
         documentationLabel.preferredMaxLayoutWidth = width
@@ -105,6 +113,7 @@ final class CodeSuggestionPreviewView: NSVisualEffectView {
 
     private func styleStaticLabel(_ label: NSTextField) {
         label.isEditable = false
+        label.isSelectable = true
         label.allowsDefaultTighteningForTruncation = false
         label.isBezeled = false
         label.isBordered = false
@@ -113,7 +122,48 @@ final class CodeSuggestionPreviewView: NSVisualEffectView {
     }
 
     private func configurePathComponentsLabel() {
-        // TODO: This
-        pathComponentsLabel.isHidden = true
+        pathComponentsLabel.isHidden = pathComponents.isEmpty
+
+        let folder = NSTextAttachment()
+        folder.image = NSImage(systemSymbolName: "folder.fill", accessibilityDescription: nil)?
+            .withSymbolConfiguration(
+                .init(paletteColors: [NSColor.systemBlue]).applying(.init(pointSize: font.pointSize, weight: .regular))
+            )
+
+        let string: NSMutableAttributedString = NSMutableAttributedString(attachment: folder)
+        string.append(NSAttributedString(string: " "))
+
+        let separator = NSTextAttachment()
+        separator.image = NSImage(systemSymbolName: "chevron.compact.right", accessibilityDescription: nil)?
+            .withSymbolConfiguration(
+                .init(paletteColors: [NSColor.labelColor])
+                .applying(.init(pointSize: font.pointSize + 1, weight: .regular))
+            )
+
+        for (idx, component) in pathComponents.enumerated() {
+            string.append(NSAttributedString(string: component, attributes: [.foregroundColor: NSColor.labelColor]))
+            if idx != pathComponents.count - 1 {
+                string.append(NSAttributedString(string: " "))
+                string.append(NSAttributedString(attachment: separator))
+                string.append(NSAttributedString(string: " "))
+            }
+        }
+
+        if let targetRange {
+            string.append(NSAttributedString(string: ":\(targetRange.start.line)"))
+            if targetRange.start.column > 1 {
+                string.append(NSAttributedString(string: ":\(targetRange.start.column)"))
+            }
+        }
+        if let paragraphStyle = NSMutableParagraphStyle.default.mutableCopy() as? NSMutableParagraphStyle {
+            paragraphStyle.lineBreakMode = .byTruncatingMiddle
+            string.addAttribute(
+                .paragraphStyle,
+                value: paragraphStyle,
+                range: NSRange(location: 0, length: string.length)
+            )
+        }
+
+        pathComponentsLabel.attributedStringValue = string
     }
 }

Sources/CodeEditSourceEditor/CodeSuggestion/TableView/SuggestionViewController.swift

@@ -334,10 +334,10 @@ extension SuggestionViewController: NSTableViewDataSource, NSTableViewDelegate {
             let selectedItem = model.items[tableView.selectedRow]
 
             previewView.sourcePreview = selectedItem.sourcePreview
-            // TODO: Add Documentation To Completion Items
-            previewView.documentation = selectedItem.detail
+            previewView.documentation = selectedItem.documentation
             previewView.pathComponents = selectedItem.pathComponents ?? []
             previewView.targetRange = selectedItem.targetPosition
+            previewView.hideIfEmpty()
             updateSize(using: nil)
 
             model.didSelect(item: selectedItem)

Sources/CodeEditSourceEditor/JumpToDefinition/JumpToDefinitionLink.swift

@@ -18,26 +18,29 @@ public struct JumpToDefinitionLink: Identifiable, Sendable, CodeSuggestionEntry
     public let targetRange: CursorPosition
 
     public let label: String
-    public let sourcePreview: String?
+    public var detail: String? { url?.lastPathComponent }
+    public var documentation: String?
 
+    public let sourcePreview: String?
     public let image: Image
     public let imageColor: Color
 
-    public var detail: String? { url?.lastPathComponent }
-    public var pathComponents: [String]? { url?.pathComponents ?? [] }
+    public var pathComponents: [String]? { url?.relativePath.components(separatedBy: "/") ?? [] }
     public var deprecated: Bool { false }
 
     public init(
         url: URL?,
         targetRange: CursorPosition,
         typeName: String,
         sourcePreview: String,
+        documentation: String?,
         image: Image = Image(systemName: "dot.square.fill"),
         imageColor: Color = Color(NSColor.lightGray)
     ) {
         self.url = url
         self.targetRange = targetRange
         self.label = typeName
+        self.documentation = documentation
         self.sourcePreview = sourcePreview
         self.image = image
         self.imageColor = imageColor