First implementation of issue navigator

Author: FastestMolasses

CodeEdit/Features/Documents/WorkspaceDocument/WorkspaceDocument.swift

@@ -33,6 +33,10 @@ final class WorkspaceDocument: NSDocument, ObservableObject, NSToolbarDelegate {
     var editorManager: EditorManager? = EditorManager()
     var statusBarViewModel: StatusBarViewModel? = StatusBarViewModel()
     var utilityAreaModel: UtilityAreaViewModel? = UtilityAreaViewModel()
+    // TODO: GRAB PROJECT NAME FROM ROOT FOLDER
+    var issueNavigatorViewModel: IssueNavigatorViewModel? = IssueNavigatorViewModel(
+        projectName: "Test"
+    )
     var searchState: SearchState?
     var openQuicklyViewModel: OpenQuicklyViewModel?
     var commandsPaletteState: QuickActionsViewModel?

CodeEdit/Features/LSP/LanguageServer/LanguageServer.swift

@@ -21,6 +21,8 @@ class LanguageServer {
     let binary: LanguageServerBinary
     /// A cache to hold responses from the server, to minimize duplicate server requests
     let lspCache = LSPCache()
+    /// The workspace document that this server is associated with
+    let workspace: WorkspaceDocument
 
     /// Tracks documents and their associated objects.
     /// Use this property when adding new objects that need to track file data, or have a state associated with the
@@ -41,12 +43,14 @@ class LanguageServer {
     init(
         languageId: LanguageIdentifier,
         binary: LanguageServerBinary,
+        workspace: WorkspaceDocument,
         lspInstance: InitializingServer,
         serverCapabilities: ServerCapabilities,
         rootPath: URL
     ) {
         self.languageId = languageId
         self.binary = binary
+        self.workspace = workspace
         self.lspInstance = lspInstance
         self.serverCapabilities = serverCapabilities
         self.rootPath = rootPath
@@ -71,6 +75,7 @@ class LanguageServer {
     static func createServer(
         for languageId: LanguageIdentifier,
         with binary: LanguageServerBinary,
+        workspace: WorkspaceDocument,
         workspacePath: String
     ) async throws -> LanguageServer {
         let executionParams = Process.ExecutionParameters(
@@ -87,6 +92,7 @@ class LanguageServer {
         return LanguageServer(
             languageId: languageId,
             binary: binary,
+            workspace: workspace,
             lspInstance: server,
             serverCapabilities: capabilities,
             rootPath: URL(filePath: workspacePath)

CodeEdit/Features/LSP/Service/LSPService+Events.swift

@@ -18,7 +18,7 @@ extension LSPService {
         // Create a new Task to listen to the events
         let task = Task.detached { [weak self] in
             for await event in languageClient.lspInstance.eventSequence {
-                await self?.handleEvent(event, for: key)
+                await self?.handleEvent(event, for: languageClient)
             }
         }
         eventListeningTasks[key] = task
@@ -31,20 +31,28 @@ extension LSPService {
         }
     }
 
-    private func handleEvent(_ event: ServerEvent, for key: ClientKey) {
+    private func handleEvent(
+        _ event: ServerEvent,
+        for languageClient: LanguageServer
+    ) {
         // TODO: Handle Events
-//        switch event {
+        switch event {
 //        case let .request(id, request):
-//            print("Request ID: \(id) for \(key.languageId.rawValue)")
-//            handleRequest(request)
-//        case let .notification(notification):
-//            handleNotification(notification)
+//            print("Request ID: \(id) for \(languageClient.languageId.rawValue)")
+//            handleRequest(request, languageClient)
+        case let .notification(notification):
+            handleNotification(notification, languageClient)
 //        case let .error(error):
-//            print("Error from EventStream for \(key.languageId.rawValue): \(error)")
-//        }
+//            print("Error from EventStream for \(languageClient.languageId.rawValue): \(error)")
+        default:
+            return
+        }
     }
 
-    private func handleRequest(_ request: ServerRequest) {
+    private func handleRequest(
+        _ request: ServerRequest,
+        _ languageClient: LanguageServer
+    ) {
         // TODO: Handle Requests
 //        switch request {
 //        case let .workspaceConfiguration(params, _):
@@ -73,15 +81,20 @@ extension LSPService {
 //        }
     }
 
-    private func handleNotification(_ notification: ServerNotification) {
+    private func handleNotification(
+        _ notification: ServerNotification,
+        _ languageClient: LanguageServer
+    ) {
         // TODO: Handle Notifications
-//        switch notification {
+        switch notification {
 //        case let .windowLogMessage(params):
 //            print("windowLogMessage \(params.type)\n```\n\(params.message)\n```\n")
 //        case let .windowShowMessage(params):
 //            print("windowShowMessage \(params.type)\n```\n\(params.message)\n```\n")
-//        case let .textDocumentPublishDiagnostics(params):
-//            print("textDocumentPublishDiagnostics: \(params)")
+        case let .textDocumentPublishDiagnostics(params):
+            print("textDocumentPublishDiagnostics: \(params.diagnostics)")
+            languageClient.workspace.issueNavigatorViewModel?
+                .updateDiagnostics(params: params)
 //        case let .telemetryEvent(params):
 //            print("telemetryEvent: \(params)")
 //        case let .protocolCancelRequest(params):
@@ -90,6 +103,8 @@ extension LSPService {
 //            print("protocolProgress: \(params)")
 //        case let .protocolLogTrace(params):
 //            print("protocolLogTrace: \(params)")
-//        }
+        default:
+            return
+        }
     }
 }

CodeEdit/Features/LSP/Service/LSPService.swift

@@ -173,6 +173,7 @@ final class LSPService: ObservableObject {
     /// - Returns: The new language server.
     func startServer(
         for languageId: LanguageIdentifier,
+        workspace: WorkspaceDocument,
         workspacePath: String
     ) async throws -> LanguageServer {
         guard let serverBinary = languageConfigs[languageId] else {
@@ -184,6 +185,7 @@ final class LSPService: ObservableObject {
         let server = try await LanguageServer.createServer(
             for: languageId,
             with: serverBinary,
+            workspace: workspace,
             workspacePath: workspacePath
         )
         languageClients[ClientKey(languageId, workspacePath)] = server
@@ -208,7 +210,11 @@ final class LSPService: ObservableObject {
                 if let server = self.languageClients[ClientKey(lspLanguage, workspacePath)] {
                     languageServer = server
                 } else {
-                    languageServer = try await self.startServer(for: lspLanguage, workspacePath: workspacePath)
+                    languageServer = try await self.startServer(
+                        for: lspLanguage,
+                        workspace: workspace,
+                        workspacePath: workspacePath
+                    )
                 }
             } catch {
                 // swiftlint:disable:next line_length

CodeEdit/Features/NavigatorArea/IssueNavigator/IssueNavigatorView.swift

@@ -7,10 +7,13 @@
 
 import SwiftUI
 
+/// # Issue Navigator - Sidebar
+///
+/// A list that functions as an issue navigator, showing collapsible issues
+/// within a project.
+///
 struct IssueNavigatorView: View {
     var body: some View {
-        VStack {
-            Spacer()
-        }
+        IssueNavigatorOutlineView()
     }
 }

CodeEdit/Features/NavigatorArea/IssueNavigator/OutlineView/IssueNavigatorOutlineView.swift

@@ -0,0 +1,31 @@
+//
+//  IssueNavigatorOutlineView.swift
+//  CodeEdit
+//
+//  Created by Abe Malla on 3/16/25.
+//
+
+import SwiftUI
+import Combine
+
+/// Wraps an ``OutlineViewController`` inside a `NSViewControllerRepresentable`
+struct IssueNavigatorOutlineView: NSViewControllerRepresentable {
+
+    @EnvironmentObject var workspace: WorkspaceDocument
+    @EnvironmentObject var editorManager: EditorManager
+
+    @StateObject var prefs: Settings = .shared
+
+    typealias NSViewControllerType = IssueNavigatorViewController
+
+    func makeNSViewController(context: Context) -> IssueNavigatorViewController {
+        let controller = IssueNavigatorViewController()
+        controller.workspace = workspace
+        controller.editor = editorManager.activeEditor
+        return controller
+    }
+
+    func updateNSViewController(_ nsViewController: IssueNavigatorViewController, context: Context) {
+        nsViewController.rowHeight = prefs.preferences.general.projectNavigatorSize.rowHeight
+    }
+}

CodeEdit/Features/NavigatorArea/IssueNavigator/OutlineView/IssueNavigatorViewController+NSOutlineViewDataSource.swift

@@ -0,0 +1,53 @@
+//
+//  IssueNavigatorViewController+NSOutlineViewDataSource.swift
+//  CodeEdit
+//
+//  Created by Abe Malla on 3/16/25.
+//
+
+import AppKit
+
+extension IssueNavigatorViewController: NSOutlineViewDataSource {
+    func outlineView(_ outlineView: NSOutlineView, numberOfChildrenOfItem item: Any?) -> Int {
+        if item == nil {
+            // Always show the project node
+            return 1
+        }
+        if let node = item as? ProjectIssueNode {
+            return node.files.count
+        }
+        if let node = item as? FileIssueNode {
+            return node.diagnostics.count
+        }
+        return 0
+    }
+
+    func outlineView(_ outlineView: NSOutlineView, child index: Int, ofItem item: Any?) -> Any {
+        if item == nil {
+            return workspace?.issueNavigatorViewModel?.filteredRootNode as Any
+        }
+        if let node = item as? ProjectIssueNode {
+            return node.files[index]
+        }
+        if let node = item as? FileIssueNode {
+            return node.diagnostics[index]
+        }
+
+        fatalError("Unexpected item type in IssueNavigator outlineView")
+    }
+
+    func outlineView(_ outlineView: NSOutlineView, isItemExpandable item: Any) -> Bool {
+        if let node = item as? any IssueNode {
+            return node.isExpandable
+        }
+        return false
+    }
+
+    func outlineView(
+        _ outlineView: NSOutlineView,
+        objectValueFor tableColumn: NSTableColumn?,
+        byItem item: Any?
+    ) -> Any? {
+        return item
+    }
+}

CodeEdit/Features/NavigatorArea/IssueNavigator/OutlineView/IssueNavigatorViewController+NSOutlineViewDelegate.swift

@@ -0,0 +1,59 @@
+//
+//  IssueNavigatorViewController+NSOutlineViewDelegate.swift
+//  CodeEdit
+//
+//  Created by Abe Malla on 3/16/25.
+//
+
+import AppKit
+
+extension IssueNavigatorViewController: NSOutlineViewDelegate {
+    func outlineView(
+        _ outlineView: NSOutlineView,
+        shouldShowCellExpansionFor tableColumn: NSTableColumn?,
+        item: Any
+    ) -> Bool {
+        true
+    }
+
+    func outlineView(_ outlineView: NSOutlineView, shouldShowOutlineCellForItem item: Any) -> Bool {
+        true
+    }
+
+    func outlineView(_ outlineView: NSOutlineView, viewFor tableColumn: NSTableColumn?, item: Any) -> NSView? {
+        guard let tableColumn else { return nil }
+
+        let frameRect = NSRect(x: 0, y: 0, width: tableColumn.width, height: rowHeight)
+        let cell = StandardTableViewCell(frame: frameRect)
+        if let node = item as? (any IssueNode) {
+            cell.configLabel(
+                    label: NSTextField(string: node.name),
+                    isEditable: false
+                )
+        }
+        return cell
+    }
+
+    func outlineView(_ outlineView: NSOutlineView, heightOfRowByItem item: Any) -> CGFloat {
+        if item is DiagnosticIssueNode {
+            let lines = Double(Settings.shared.preferences.general.issueNavigatorDetail.rawValue)
+            return rowHeight * lines
+        }
+        return rowHeight // This can be changed to 20 to match Xcode's row height.
+    }
+
+    /// Adds a tooltip to the issue row.
+    func outlineView( // swiftlint:disable:this function_parameter_count
+        _ outlineView: NSOutlineView,
+        toolTipFor cell: NSCell,
+        rect: NSRectPointer,
+        tableColumn: NSTableColumn?,
+        item: Any,
+        mouseLocation: NSPoint
+    ) -> String {
+        if let node = item as? (any IssueNode) {
+            return node.name
+        }
+        return ""
+    }
+}