Add CmuxExtensionKit sidebar prototypes

Examples/CmuxExtensionSidebarExamples/Package.swift

@@ -0,0 +1,23 @@
+// swift-tools-version: 6.0
+
+import PackageDescription
+
+let package = Package(
+    name: "CmuxExtensionSidebarExamples",
+    platforms: [.macOS(.v14)],
+    products: [
+        .library(
+            name: "CmuxExtensionSidebarExamples",
+            targets: ["CmuxExtensionSidebarExamples"]
+        ),
+    ],
+    dependencies: [
+        .package(path: "../../Packages/CmuxExtensionKit"),
+    ],
+    targets: [
+        .target(
+            name: "CmuxExtensionSidebarExamples",
+            dependencies: ["CmuxExtensionKit"]
+        ),
+    ]
+)

Examples/CmuxExtensionSidebarExamples/Sources/CmuxExtensionSidebarExamples/AttentionQueueSidebar.swift

@@ -0,0 +1,81 @@
+import CmuxExtensionKit
+
+public struct AttentionQueueSidebar: CmuxExtensionSidebarProvider {
+    public let descriptor = CmuxExtensionSidebarProviderDescriptor(
+        id: "com.example.cmux.sidebar.attention-queue",
+        title: localized("example.sidebar.attentionQueue.title", "Attention Queue"),
+        subtitle: localized("example.sidebar.attentionQueue.subtitle", "User extension"),
+        systemImageName: "bell",
+        mode: nil,
+        isHostProvided: false
+    )
+
+    public init() {}
+
+    public func render(snapshot: CmuxExtensionSidebarSnapshot) -> CmuxExtensionSidebarRenderModel {
+        let selected = snapshot.selectedWorkspaceId
+        let active = snapshot.workspaces.filter { $0.id == selected }
+        let pinned = snapshot.workspaces.filter { $0.isPinned && $0.id != selected }
+        let attention = snapshot.workspaces.filter { workspace in
+            workspace.id != selected && !workspace.isPinned && needsAttention(workspace)
+        }
+        let quiet = snapshot.workspaces.filter { workspace in
+            workspace.id != selected && !workspace.isPinned && !needsAttention(workspace)
+        }
+
+        let sections = [
+            ExampleSidebarSection(
+                id: "active",
+                title: localized("example.sidebar.group.active", "Active"),
+                systemImageName: "circle.fill",
+                projectRootPath: nil,
+                workspaces: active
+            )
+            .render(subtitle: rowSubtitle),
+            ExampleSidebarSection(
+                id: "pinned",
+                title: localized("example.sidebar.group.pinned", "Pinned"),
+                systemImageName: "pin",
+                projectRootPath: nil,
+                workspaces: pinned
+            )
+            .render(subtitle: rowSubtitle),
+            ExampleSidebarSection(
+                id: "attention",
+                title: localized("example.sidebar.group.needsAttention", "Needs Attention"),
+                systemImageName: "bell",
+                projectRootPath: nil,
+                workspaces: attention
+            )
+            .render(subtitle: rowSubtitle),
+            ExampleSidebarSection(
+                id: "quiet",
+                title: localized("example.sidebar.group.quiet", "Quiet"),
+                systemImageName: "checkmark.circle",
+                projectRootPath: nil,
+                workspaces: quiet
+            )
+            .render(subtitle: rowSubtitle),
+        ]
+
+        return renderModel(providerId: descriptor.id, snapshot: snapshot, sections: sections)
+    }
+
+    private func needsAttention(_ workspace: CmuxExtensionWorkspaceSnapshot) -> Bool {
+        workspace.unreadCount > 0
+            || trimmed(workspace.latestNotificationText) != nil
+            || workspace.remoteConnectionState == "connecting"
+            || workspace.remoteConnectionState == "reconnecting"
+            || workspace.remoteConnectionState == "disconnected"
+    }
+
+    private func rowSubtitle(_ workspace: CmuxExtensionWorkspaceSnapshot) -> CmuxExtensionSidebarRenderText? {
+        if let notification = trimmed(workspace.latestNotificationText) {
+            return .plain(notification)
+        }
+        if let remoteState = trimmed(workspace.remoteConnectionState), remoteState != "connected" {
+            return .plain(remoteState)
+        }
+        return trimmed(workspace.customDescription).map(CmuxExtensionSidebarRenderText.plain)
+    }
+}

Examples/CmuxExtensionSidebarExamples/Sources/CmuxExtensionSidebarExamples/DevServerSidebar.swift

@@ -0,0 +1,70 @@
+import CmuxExtensionKit
+
+public struct DevServerSidebar: CmuxExtensionSidebarProvider {
+    public let descriptor = CmuxExtensionSidebarProviderDescriptor(
+        id: "com.example.cmux.sidebar.dev-servers",
+        title: localized("example.sidebar.devServers.title", "Dev Servers"),
+        subtitle: localized("example.sidebar.devServers.subtitle", "User extension"),
+        systemImageName: "terminal",
+        mode: nil,
+        isHostProvided: false
+    )
+
+    public init() {}
+
+    public func render(snapshot: CmuxExtensionSidebarSnapshot) -> CmuxExtensionSidebarRenderModel {
+        let liveServers = snapshot.workspaces.filter(hasServerSignal)
+        let remote = snapshot.workspaces.filter { workspace in
+            !hasServerSignal(workspace) && trimmed(workspace.remoteDisplayTarget) != nil
+        }
+        let local = snapshot.workspaces.filter { workspace in
+            !hasServerSignal(workspace) && trimmed(workspace.remoteDisplayTarget) == nil
+        }
+
+        let sections = [
+            ExampleSidebarSection(
+                id: "live",
+                title: localized("example.sidebar.group.liveServers", "Live Servers"),
+                systemImageName: "terminal",
+                projectRootPath: nil,
+                workspaces: liveServers
+            )
+            .render(subtitle: serverSubtitle),
+            ExampleSidebarSection(
+                id: "remote",
+                title: localized("example.sidebar.group.remote", "Remote"),
+                systemImageName: "network",
+                projectRootPath: nil,
+                workspaces: remote
+            )
+            .render(subtitle: serverSubtitle),
+            ExampleSidebarSection(
+                id: "local",
+                title: localized("example.sidebar.group.local", "Local"),
+                systemImageName: "folder",
+                projectRootPath: nil,
+                workspaces: local
+            )
+            .render(subtitle: serverSubtitle),
+        ]
+
+        return renderModel(providerId: descriptor.id, snapshot: snapshot, sections: sections)
+    }
+
+    private func hasServerSignal(_ workspace: CmuxExtensionWorkspaceSnapshot) -> Bool {
+        if !workspace.listeningPorts.isEmpty {
+            return true
+        }
+        guard let description = trimmed(workspace.customDescription)?.lowercased() else {
+            return false
+        }
+        return description.contains("server") || description.contains(":")
+    }
+
+    private func serverSubtitle(_ workspace: CmuxExtensionWorkspaceSnapshot) -> CmuxExtensionSidebarRenderText? {
+        if !workspace.listeningPorts.isEmpty {
+            return .plain(workspace.listeningPorts.map { ":\($0)" }.joined(separator: ", "))
+        }
+        return trimmed(workspace.customDescription).map(CmuxExtensionSidebarRenderText.plain)
+    }
+}

Examples/CmuxExtensionSidebarExamples/Sources/CmuxExtensionSidebarExamples/LastPromptSidebar.swift

@@ -0,0 +1,56 @@
+import CmuxExtensionKit
+
+public struct LastPromptSidebar: CmuxExtensionSidebarProvider {
+    public let descriptor = CmuxExtensionSidebarProviderDescriptor(
+        id: "com.example.cmux.sidebar.last-prompt",
+        title: localized("example.sidebar.lastPrompt.title", "Last Prompt"),
+        subtitle: localized("example.sidebar.lastPrompt.subtitle", "User extension"),
+        systemImageName: "clock",
+        mode: nil,
+        isHostProvided: false
+    )
+
+    public init() {}
+
+    public func render(snapshot: CmuxExtensionSidebarSnapshot) -> CmuxExtensionSidebarRenderModel {
+        let recent = snapshot.workspaces
+            .filter { $0.latestSubmittedAt != nil }
+            .sorted { lhs, rhs in
+                guard let lhsDate = lhs.latestSubmittedAt else { return false }
+                guard let rhsDate = rhs.latestSubmittedAt else { return true }
+                return lhsDate > rhsDate
+            }
+
+        let sections = [
+            ExampleSidebarSection(
+                id: "recent",
+                title: localized("example.sidebar.group.recentPrompts", "Recent Prompts"),
+                systemImageName: "clock",
+                projectRootPath: nil,
+                workspaces: recent
+            )
+            .render(subtitle: promptSubtitle, trailingText: promptTrailingText),
+            ExampleSidebarSection(
+                id: "none",
+                title: localized("example.sidebar.group.noPrompts", "No Prompts"),
+                systemImageName: "tray",
+                projectRootPath: nil,
+                workspaces: snapshot.workspaces.filter { $0.latestSubmittedAt == nil }
+            )
+            .render(subtitle: promptSubtitle, trailingText: promptTrailingText),
+        ]
+
+        return renderModel(providerId: descriptor.id, snapshot: snapshot, sections: sections)
+    }
+
+    private func promptSubtitle(_ workspace: CmuxExtensionWorkspaceSnapshot) -> CmuxExtensionSidebarRenderText? {
+        if let message = trimmed(workspace.latestSubmittedMessage) {
+            return .plain(message)
+        }
+        return .plain("No prompts yet")
+    }
+
+    private func promptTrailingText(_ workspace: CmuxExtensionWorkspaceSnapshot) -> CmuxExtensionSidebarRenderText? {
+        workspace.latestSubmittedAt.map { .relativeDate($0, style: .compact) }
+    }
+}

Examples/CmuxExtensionSidebarExamples/Sources/CmuxExtensionSidebarExamples/ProjectWorktreeSidebar.swift

@@ -0,0 +1,62 @@
+import CmuxExtensionKit
+import Foundation
+
+public struct ProjectWorktreeSidebar: CmuxExtensionSidebarProvider {
+    public let descriptor = CmuxExtensionSidebarProviderDescriptor(
+        id: "com.example.cmux.sidebar.project-worktrees",
+        title: localized("example.sidebar.projectWorktrees.title", "Project Worktrees"),
+        subtitle: localized("example.sidebar.projectWorktrees.subtitle", "User extension"),
+        systemImageName: "folder",
+        mode: .projectTree,
+        isHostProvided: false
+    )
+
+    public init() {}
+
+    public func render(snapshot: CmuxExtensionSidebarSnapshot) -> CmuxExtensionSidebarRenderModel {
+        var sections: [CmuxExtensionSidebarRenderSection] = []
+
+        sections.append(
+            ExampleSidebarSection(
+                id: "pinned",
+                title: localized("example.sidebar.group.pinned", "Pinned"),
+                systemImageName: "pin",
+                projectRootPath: nil,
+                workspaces: snapshot.workspaces.filter(\.isPinned)
+            )
+            .render(subtitle: branchSubtitle)
+        )
+
+        var grouped: [String: [CmuxExtensionWorkspaceSnapshot]] = [:]
+        var orderedProjectRoots: [String] = []
+
+        for workspace in snapshot.workspaces where !workspace.isPinned {
+            let key = projectRoot(for: workspace) ?? "no-folder"
+            if grouped[key] == nil {
+                grouped[key] = []
+                orderedProjectRoots.append(key)
+            }
+            grouped[key]?.append(workspace)
+        }
+
+        for root in orderedProjectRoots {
+            let title = root == "no-folder" ? "No Folder" : displayName(for: root)
+            sections.append(
+                ExampleSidebarSection(
+                    id: "project:\(root)",
+                    title: localized("example.sidebar.group.project.\(title)", title),
+                    systemImageName: root == "no-folder" ? "tray" : "folder",
+                    projectRootPath: root == "no-folder" ? nil : root,
+                    workspaces: grouped[root] ?? []
+                )
+                .render(subtitle: branchSubtitle)
+            )
+        }
+
+        return renderModel(providerId: descriptor.id, snapshot: snapshot, sections: sections)
+    }
+
+    private func branchSubtitle(_ workspace: CmuxExtensionWorkspaceSnapshot) -> CmuxExtensionSidebarRenderText? {
+        trimmed(workspace.branchSummary).map(CmuxExtensionSidebarRenderText.plain)
+    }
+}

Examples/CmuxExtensionSidebarExamples/Sources/CmuxExtensionSidebarExamples/SidebarExamples.swift

@@ -0,0 +1,90 @@
+import CmuxExtensionKit
+import Foundation
+
+public enum SidebarExamples {
+    public static let providers: [any CmuxExtensionSidebarProvider] = [
+        ProjectWorktreeSidebar(),
+        AttentionQueueSidebar(),
+        DevServerSidebar(),
+        LastPromptSidebar(),
+        SuperCompactSidebar(),
+    ]
+}
+
+struct ExampleSidebarSection {
+    var id: String
+    var title: CmuxExtensionLocalizedText
+    var systemImageName: String
+    var projectRootPath: String?
+    var workspaces: [CmuxExtensionWorkspaceSnapshot]
+
+    func render(
+        rowTitle: (CmuxExtensionWorkspaceSnapshot) -> String = { $0.title },
+        accessory: CmuxExtensionWorkspaceRowAccessory? = .inspector,
+        subtitle: (CmuxExtensionWorkspaceSnapshot) -> CmuxExtensionSidebarRenderText? = { _ in nil },
+        trailingText: (CmuxExtensionWorkspaceSnapshot) -> CmuxExtensionSidebarRenderText? = { _ in nil }
+    ) -> CmuxExtensionSidebarRenderSection {
+        CmuxExtensionSidebarRenderSection(
+            id: id,
+            treeSection: CmuxExtensionWorkspaceTreeSection(
+                id: id,
+                title: title.defaultValue,
+                titleText: title,
+                subtitle: nil,
+                systemImageName: systemImageName,
+                projectRootPath: projectRootPath,
+                workspaceIds: workspaces.map(\.id)
+            ),
+            rows: workspaces.map { workspace in
+                CmuxExtensionSidebarRenderRow(
+                    id: workspace.id,
+                    title: rowTitle(workspace),
+                    workspaceId: workspace.id,
+                    accessory: accessory,
+                    subtitle: subtitle(workspace),
+                    trailingText: trailingText(workspace)
+                )
+            }
+        )
+    }
+}
+
+func localized(_ key: String, _ defaultValue: String) -> CmuxExtensionLocalizedText {
+    CmuxExtensionLocalizedText(key: key, defaultValue: defaultValue)
+}
+
+func renderModel(
+    providerId: String,
+    snapshot: CmuxExtensionSidebarSnapshot,
+    sections: [CmuxExtensionSidebarRenderSection]
+) -> CmuxExtensionSidebarRenderModel {
+    CmuxExtensionSidebarRenderModel(
+        providerId: providerId,
+        snapshotSequence: snapshot.sequence,
+        sections: sections.filter { !$0.rows.isEmpty }
+    )
+}
+
+func trimmed(_ value: String?) -> String? {
+    guard let trimmed = value?.trimmingCharacters(in: .whitespacesAndNewlines),
+          !trimmed.isEmpty else {
+        return nil
+    }
+    return trimmed
+}
+
+func projectRoot(for workspace: CmuxExtensionWorkspaceSnapshot) -> String? {
+    trimmed(workspace.projectRootPath)
+        ?? trimmed(workspace.rootPath).map {
+            URL(fileURLWithPath: $0, isDirectory: true)
+                .standardizedFileURL
+                .deletingLastPathComponent()
+                .path
+        }
+}
+
+func displayName(for path: String) -> String {
+    let url = URL(fileURLWithPath: path, isDirectory: true).standardizedFileURL
+    let name = url.lastPathComponent
+    return name.isEmpty ? path : name
+}