Issue navigator coordinator, open file on select, right click options, refactors

Author: FastestMolasses

CodeEdit/Assets.xcassets/Custom Colors/ErrorRed.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "display-p3",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.098",
+          "green" : "0.161",
+          "red" : "0.725"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "display-p3",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.255",
+          "green" : "0.231",
+          "red" : "0.855"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

CodeEdit/Assets.xcassets/Custom Colors/WarningYellow.colorset/Contents.json

@@ -0,0 +1,38 @@
+{
+  "colors" : [
+    {
+      "color" : {
+        "color-space" : "display-p3",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.114",
+          "green" : "0.741",
+          "red" : "0.965"
+        }
+      },
+      "idiom" : "universal"
+    },
+    {
+      "appearances" : [
+        {
+          "appearance" : "luminosity",
+          "value" : "dark"
+        }
+      ],
+      "color" : {
+        "color-space" : "display-p3",
+        "components" : {
+          "alpha" : "1.000",
+          "blue" : "0.271",
+          "green" : "0.784",
+          "red" : "0.965"
+        }
+      },
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

CodeEdit/Features/Editor/Models/EditorManager.swift

@@ -29,7 +29,7 @@ class EditorManager: ObservableObject {
     /// History of last-used editors.
     var activeEditorHistory: Deque<() -> Editor?> = []
 
-    /// notify listeners whenever tab selection changes on the active editor.
+    /// Notify listeners whenever tab selection changes on the active editor.
     var tabBarTabIdSubject = PassthroughSubject<String?, Never>()
     var cancellable: AnyCancellable?
 

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

@@ -0,0 +1,72 @@
+//
+//  IssueNavigatorMenu.swift
+//  CodeEdit
+//
+//  Created by Abe Malla on 4/3/25.
+//
+
+import SwiftUI
+
+final class IssueNavigatorMenu: NSMenu {
+    var item: (any IssueNode)?
+
+    /// The workspace, for opening the item
+    var workspace: WorkspaceDocument?
+
+    /// The  `IssueNavigatorViewController` is being called from.
+    /// By sending it, we can access it's variables and functions.
+    var sender: IssueNavigatorViewController
+
+    init(_ sender: IssueNavigatorViewController) {
+        self.sender = sender
+        super.init(title: "Options")
+    }
+
+    @available(*, unavailable)
+    required init(coder _: NSCoder) {
+        fatalError("init(coder:) has not been implemented")
+    }
+
+    /// Creates a `NSMenuItem` depending on the given arguments
+    /// - Parameters:
+    ///   - title: The title of the menu item
+    ///   - action: A `Selector` or `nil` of the action to perform.
+    ///   - key: A `keyEquivalent` of the menu item. Defaults to an empty `String`
+    /// - Returns: A `NSMenuItem` which has the target `self`
+    private func menuItem(_ title: String, action: Selector?, key: String = "") -> NSMenuItem {
+        let mItem = NSMenuItem(title: title, action: action, keyEquivalent: key)
+        mItem.target = self
+        return mItem
+    }
+
+    /// Configures the menu based on the current selection in the outline view.
+    /// - Menu items get added depending on the amount of selected items.
+    private func setupMenu() {
+        guard item != nil else { return }
+
+        let copy = menuItem("Copy", action: #selector(copyIssue))
+        let showInFinder = menuItem("Show in Finder", action: #selector(showInFinder))
+        let revealInProjectNavigator = menuItem(
+            "Reveal in Project Navigator",
+            action: #selector(revealInProjectNavigator)
+        )
+        let openInTab = menuItem("Open in Tab", action: #selector(openInTab))
+        let openWithExternalEditor = menuItem("Open with External Editor", action: #selector(openWithExternalEditor))
+
+        items = [
+            copy,
+            .separator(),
+            showInFinder,
+            revealInProjectNavigator,
+            .separator(),
+            openInTab,
+            openWithExternalEditor,
+        ]
+    }
+
+    /// Updates the menu for the selected item and hides it if no item is provided.
+    override func update() {
+        removeAllItems()
+        setupMenu()
+    }
+}

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

@@ -0,0 +1,129 @@
+//
+//  IssueNavigatorMenuActions.swift
+//  CodeEdit
+//
+//  Created by Abe Malla on 4/3/25.
+//
+
+import AppKit
+import SwiftUI
+
+extension IssueNavigatorMenu {
+    /// - Returns: the currently selected `IssueNode` items in the outline view.
+    func selectedNodes() -> [any IssueNode] {
+        let selectedItems = sender.outlineView.selectedRowIndexes.compactMap {
+            sender.outlineView.item(atRow: $0) as? (any IssueNode)
+        }
+
+        if let menuItem = sender.outlineView.item(atRow: sender.outlineView.clickedRow) as? (any IssueNode) {
+            if !selectedItems.contains(where: { $0.id == menuItem.id }) {
+                return [menuItem]
+            }
+        }
+
+        return selectedItems
+    }
+
+    /// Finds the file node that contains a diagnostic node
+    private func findFileNode(for diagnosticNode: DiagnosticIssueNode) -> FileIssueNode? {
+        // First try to find it by checking parents in the outline view
+        if let parent = sender.outlineView.parent(forItem: diagnosticNode) as? FileIssueNode {
+            return parent
+        }
+
+        // Fallback: Look for a file with matching URI
+        for row in 0..<sender.outlineView.numberOfRows {
+            if let fileNode = sender.outlineView.item(atRow: row) as? FileIssueNode {
+                if fileNode.uri == diagnosticNode.fileUri {
+                    return fileNode
+                }
+            }
+        }
+
+        return nil
+    }
+
+    /// - Returns: the relevant file nodes, converting diagnostic nodes to their parent file nodes if needed
+    private func selectedFileNodes() -> [FileIssueNode] {
+        let nodes = selectedNodes()
+        var fileNodes = [FileIssueNode]()
+
+        for node in nodes {
+            if let fileNode = node as? FileIssueNode {
+                if !fileNodes.contains(where: { $0.id == fileNode.id }) {
+                    fileNodes.append(fileNode)
+                }
+            } else if let diagnosticNode = node as? DiagnosticIssueNode {
+                if let fileNode = findFileNode(for: diagnosticNode),
+                   !fileNodes.contains(where: { $0.id == fileNode.id }) {
+                    fileNodes.append(fileNode)
+                }
+            }
+        }
+
+        return fileNodes
+    }
+
+    /// Copies the details of the issue node that was selected
+    @objc
+    func copyIssue() {
+        let textsToCopy = selectedNodes().compactMap { node -> String? in
+            if let diagnosticNode = node as? DiagnosticIssueNode {
+                return diagnosticNode.name
+            } else if let fileNode = node as? FileIssueNode {
+                return fileNode.name
+            } else {
+                return node.name
+            }
+        }
+
+        if !textsToCopy.isEmpty {
+            let pasteboard = NSPasteboard.general
+            pasteboard.clearContents()
+            pasteboard.writeObjects([textsToCopy.joined(separator: "\n") as NSString])
+        }
+    }
+
+    /// Action that opens **Finder** at the items location.
+    @objc
+    func showInFinder() {
+        let fileURLs = selectedFileNodes().compactMap { URL(string: $0.uri) }
+        NSWorkspace.shared.activateFileViewerSelecting(fileURLs)
+    }
+
+    @objc
+    func revealInProjectNavigator() {
+        guard let fileNode = selectedFileNodes().first,
+              let fileURL = URL(string: fileNode.uri),
+              let workspaceFileManager = workspace?.workspaceFileManager,
+              let file = workspaceFileManager.getFile(fileURL.path) else {
+            return
+        }
+        workspace?.listenerModel.highlightedFileItem = file
+    }
+
+    /// Action that opens the item, identical to clicking it.
+    @objc
+    func openInTab() {
+        for fileNode in selectedFileNodes() {
+            if let fileURL = URL(string: fileNode.uri),
+               let workspaceFileManager = workspace?.workspaceFileManager,
+               let file = workspaceFileManager.getFile(fileURL.path) {
+                workspace?.editorManager?.activeEditor.openTab(file: file)
+            }
+        }
+    }
+
+    /// Action that opens in an external editor
+    @objc
+    func openWithExternalEditor() {
+        let fileURLs = selectedFileNodes().compactMap { URL(string: $0.uri)?.path }
+
+        if !fileURLs.isEmpty {
+            let process = Process()
+            process.launchPath = "/usr/bin/open"
+            process.arguments = fileURLs
+            try? process.run()
+        }
+    }
+}

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

@@ -22,10 +22,41 @@ struct IssueNavigatorOutlineView: NSViewControllerRepresentable {
         let controller = IssueNavigatorViewController()
         controller.workspace = workspace
         controller.editor = editorManager.activeEditor
+
+        context.coordinator.controller = controller
+        context.coordinator.setupObservers()
+
         return controller
     }
 
     func updateNSViewController(_ nsViewController: IssueNavigatorViewController, context: Context) {
         nsViewController.rowHeight = prefs.preferences.general.projectNavigatorSize.rowHeight
     }
+
+    func makeCoordinator() -> Coordinator {
+        Coordinator(workspace: workspace)
+    }
+
+    class Coordinator: NSObject {
+        var cancellables = Set<AnyCancellable>()
+        weak var workspace: WorkspaceDocument?
+        weak var controller: IssueNavigatorViewController?
+
+        init(workspace: WorkspaceDocument?) {
+            self.workspace = workspace
+            super.init()
+        }
+
+        func setupObservers() {
+            guard let viewModel = workspace?.issueNavigatorViewModel else { return }
+
+            viewModel.diagnosticsDidChangePublisher
+                .sink { [weak self] _ in
+                    DispatchQueue.main.async {
+                        self?.controller?.outlineView.reloadData()
+                    }
+                }
+                .store(in: &cancellables)
+        }
+    }
 }

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

@@ -0,0 +1,31 @@
+//
+//  IssueNavigatorViewController+NSMenuDelegate.swift.swift
+//  CodeEdit
+//
+//  Created by Abe Malla on 4/3/25.
+//
+
+import AppKit
+
+extension IssueNavigatorViewController: NSMenuDelegate {
+    /// Once a menu gets requested by a `right click` setup the menu
+    ///
+    /// If the right click happened outside a row this will result in no menu being shown.
+    /// - Parameter menu: The menu that got requested
+    func menuNeedsUpdate(_ menu: NSMenu) {
+        let row = outlineView.clickedRow
+        guard let menu = menu as? IssueNavigatorMenu else { return }
+
+        if row == -1 {
+            menu.item = nil
+        } else {
+            if let item = outlineView.item(atRow: row) as? (any IssueNode) {
+                menu.item = item
+                menu.workspace = workspace
+            } else {
+                menu.item = nil
+            }
+        }
+        menu.update()
+    }
+}

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

@@ -31,6 +31,29 @@ extension IssueNavigatorViewController: NSOutlineViewDelegate {
         return TextTableViewCell(frame: frameRect, startingText: "Unknown item")
     }
 
+    func outlineViewSelectionDidChange(_ notification: Notification) {
+        guard let outlineView = notification.object as? NSOutlineView else { return }
+
+        // If multiple rows are selected, do not open any file.
+        guard outlineView.selectedRowIndexes.count == 1 else { return }
+        guard shouldSendSelectionUpdate else { return }
+
+        let selectedItem = outlineView.item(atRow: outlineView.selectedRow)
+
+        // Get the file and open it if not already opened
+        if let fileURL = URL(
+            string: (selectedItem as? FileIssueNode)?.uri ??
+            (selectedItem as? DiagnosticIssueNode)?.fileUri ?? ""
+        ), !fileURL.path.isEmpty {
+            shouldSendSelectionUpdate = false
+            if let file = workspace?.workspaceFileManager?.getFile(fileURL.path),
+               workspace?.editorManager?.activeEditor.selectedTab?.file != file {
+                workspace?.editorManager?.activeEditor.openTab(file: file, asTemporary: true)
+            }
+            shouldSendSelectionUpdate = true
+        }
+    }
+
     func outlineView(_ outlineView: NSOutlineView, heightOfRowByItem item: Any) -> CGFloat {
         if let diagnosticNode = item as? DiagnosticIssueNode {
             let columnWidth = outlineView.tableColumns.first?.width ?? outlineView.frame.width