Merge tag '0.9.0' into develop

Author: intitni

Config.xcconfig

@@ -3,5 +3,5 @@ SLASH = /
 
 BUNDLE_IDENTIFIER_BASE = com.intii.CopilotForXcode
 EXTENSION_BUNDLE_NAME = Copilot
-SPARKLE_FEED_URL = https:$(SLASH)$(SLASH)github.com/intitni/CopilotForXcode/blob/main/appcast.xml
+SPARKLE_FEED_URL = https:$(SLASH)$(SLASH)raw.githubusercontent.com/intitni/CopilotForXcode/main/appcast.xml
 SPARKLE_PUBLIC_KEY = WDzm5GHnc6c8kjeJEgX5GuGiPpW6Lc/ovGjLnrrZvPY=

Core/Sources/Environment/Environment.swift

@@ -138,6 +138,15 @@ public enum Environment {
 
         try await runAppleScript(appleScript)
     }
+
+    public static var makeXcodeActive: () async throws -> Void = {
+        let appleScript = """
+        tell application "Xcode"
+            activate
+        end tell
+        """
+        try await runAppleScript(appleScript)
+    }
 }
 
 @discardableResult

Core/Sources/Service/SuggestionCommandHandler/WindowBaseCommandHandler.swift

@@ -279,7 +279,7 @@ struct WindowBaseCommandHandler: SuggestionCommandHandler {
                     history.append(.init(
                         role: .user,
                         content: "",
-                        summary: "Chat about selected code from `\(selection.start.line + 1):\(selection.start.character + 1)` to `\(selection.end.line + 1):\(selection.end.character)`.\nThe code will persisted in the conversation."
+                        summary: "Chat about selected code from `\(selection.start.line + 1):\(selection.start.character + 1)` to `\(selection.end.line + 1):\(selection.end.character)`.\nThe code will persist in the conversation."
                     ))
                 }
             }

Core/Sources/SuggestionWidget/Styles.swift

@@ -2,8 +2,8 @@ import AppKit
 import SwiftUI
 
 enum Style {
-    static let panelHeight: Double = 300
-    static let panelWidth: Double = 450
+    static let panelHeight: Double = 304
+    static let panelWidth: Double = 454
     static let widgetHeight: Double = 30
     static var widgetWidth: Double { widgetHeight }
     static let widgetPadding: Double = 4

Core/Sources/SuggestionWidget/SuggestionPanelContent/ChatPanel.swift

@@ -28,9 +28,9 @@ struct ChatPanel: View {
                 chat.close()
             }) {
                 Image(systemName: "xmark")
-                    .padding(8)
-                    .background(.regularMaterial, in: Circle())
                     .padding(4)
+                    .background(.regularMaterial, in: Circle())
+                    .padding(2)
                     .foregroundStyle(.secondary)
             }
             .buttonStyle(.plain)
@@ -112,6 +112,7 @@ struct ChatPanelMessages: View {
                         )
                         .xcodeStyleFrame()
                         .rotationEffect(Angle(degrees: 180))
+                        
                 }
             }
         }

Core/Sources/SuggestionWidget/SuggestionPanelView.swift

@@ -1,3 +1,4 @@
+import Environment
 import SwiftUI
 
 @MainActor
@@ -40,15 +41,8 @@ final class SuggestionPanelViewModel: ObservableObject {
 
     @Published var activeTab: ActiveTab {
         didSet {
-            #warning("""
-            TODO: There should be a better way for that
-            Currently, we have to make the app an accessory so that we can type things in the chat mode.
-            But in other modes, we want to keep it prohibited so the helper app won't take over the focus.
-            """)
-            if case .chat = activeTab {
-                NSApp.setActivationPolicy(.accessory)
-            } else {
-                NSApp.setActivationPolicy(.prohibited)
+            if activeTab != oldValue {
+                onActiveTabChanged?(activeTab)
             }
         }
     }
@@ -61,6 +55,7 @@ final class SuggestionPanelViewModel: ObservableObject {
     var onRejectButtonTapped: (() -> Void)?
     var onPreviousButtonTapped: (() -> Void)?
     var onNextButtonTapped: (() -> Void)?
+    var onActiveTabChanged: ((ActiveTab) -> Void)?
 
     public init(
         content: Content? = nil,
@@ -71,7 +66,8 @@ final class SuggestionPanelViewModel: ObservableObject {
         onAcceptButtonTapped: (() -> Void)? = nil,
         onRejectButtonTapped: (() -> Void)? = nil,
         onPreviousButtonTapped: (() -> Void)? = nil,
-        onNextButtonTapped: (() -> Void)? = nil
+        onNextButtonTapped: (() -> Void)? = nil,
+        onActiveTabChanged: ((ActiveTab) -> Void)? = nil
     ) {
         self.content = content
         self.chat = chat
@@ -82,6 +78,7 @@ final class SuggestionPanelViewModel: ObservableObject {
         self.onRejectButtonTapped = onRejectButtonTapped
         self.onPreviousButtonTapped = onPreviousButtonTapped
         self.onNextButtonTapped = onNextButtonTapped
+        self.onActiveTabChanged = onActiveTabChanged
     }
 
     func adjustActiveTabAndShowHideIfNeeded(tab: ActiveTab) {
@@ -90,11 +87,13 @@ final class SuggestionPanelViewModel: ObservableObject {
             if content != nil {
                 activeTab = .suggestion
                 isPanelDisplayed = true
+                return
             }
         case .chat:
             if chat != nil {
                 activeTab = .chat
                 isPanelDisplayed = true
+                return
             }
         }
 
@@ -158,6 +157,7 @@ struct SuggestionPanelView: View {
                                 Color.userChatContentBackground,
                                 in: RoundedRectangle(cornerRadius: 8, style: .continuous)
                             )
+                            .fixedSize(horizontal: false, vertical: true)
                         })
                         .buttonStyle(.plain)
                         .xcodeStyleFrame()
@@ -187,6 +187,7 @@ struct SuggestionPanelView: View {
                                 Color.userChatContentBackground,
                                 in: RoundedRectangle(cornerRadius: 8, style: .continuous)
                             )
+                            .fixedSize(horizontal: false, vertical: true)
                         })
                         .buttonStyle(.plain)
                         .xcodeStyleFrame()
@@ -211,6 +212,9 @@ struct SuggestionPanelView: View {
         .animation(.easeInOut(duration: 0.2), value: viewModel.chat)
         .animation(.easeInOut(duration: 0.2), value: viewModel.activeTab)
         .animation(.easeInOut(duration: 0.2), value: viewModel.isPanelDisplayed)
+        .shadow(color: .black.opacity(0.1), radius: 2)
+        .padding(2)
+        .frame(maxWidth: Style.panelWidth, maxHeight: Style.panelHeight)
     }
 }
 
@@ -221,7 +225,7 @@ struct CommandButtonStyle: ButtonStyle {
         configuration.label
             .padding(.vertical, 4)
             .padding(.horizontal, 8)
-            .foregroundColor(.white)
+            .foregroundColor(.white) 
             .background(
                 RoundedRectangle(cornerRadius: 4, style: .continuous)
                     .fill(color.opacity(configuration.isPressed ? 0.8 : 1))

Core/Sources/SuggestionWidget/SuggestionWidgetController.swift

@@ -197,6 +197,24 @@ public final class SuggestionWidgetController {
                 context: nil
             )
         }
+
+        Task { @MainActor in
+            suggestionPanelViewModel.onActiveTabChanged = { [weak self] activeTab in
+                #warning("""
+                TODO: There should be a better way for that
+                Currently, we have to make the app an accessory so that we can type things in the chat mode.
+                But in other modes, we want to keep it prohibited so the helper app won't take over the focus.
+                """)
+                if case .chat = activeTab {
+                    NSApp.setActivationPolicy(.accessory)
+                } else {
+                    Task {
+                        try await Environment.makeXcodeActive()
+                        NSApp.setActivationPolicy(.prohibited)
+                    }
+                }
+            }
+        }
     }
 }
 
@@ -384,7 +402,8 @@ extension SuggestionWidgetController {
                         activeScreen: firstScreen
                     )
                     widgetWindow.setFrame(result.widgetFrame, display: false, animate: animated)
-                    panelWindow.setFrame(result.panelFrame, display: false, animate: animated)
+                    panelWindow.setFrame(result.panelFrame, display: true, animate: animated)
+                    
                     suggestionPanelViewModel.alignTopToAnchor = result.alignPanelTopToAnchor
                 case .alignToTextCursor:
                     let result = UpdateLocationStrategy.AlignToTextCursor().framesForWindows(

EditorExtension/ChatWithSelection.swift

@@ -4,7 +4,7 @@ import Foundation
 import XcodeKit
 
 class ChatWithSelectionCommand: NSObject, XCSourceEditorCommand, CommandType {
-    var name: String { "Chat With Selection" }
+    var name: String { "Chat with Selection" }
 
     func perform(
         with invocation: XCSourceEditorCommandInvocation,

ExtensionService/AppDelegate.swift

@@ -54,13 +54,13 @@ class AppDelegate: NSObject, NSApplicationDelegate, NSWindowDelegate {
 
         #if DEBUG
         let copilotName = NSMenuItem(
-            title: "Copilot for Xcode",
+            title: "Copilot for Xcode - DEBUG",
             action: nil,
             keyEquivalent: ""
         )
         #else
         let copilotName = NSMenuItem(
-            title: "Copilot for Xcode - DEBUG",
+            title: "Copilot for Xcode",
             action: nil,
             keyEquivalent: ""
         )

README.md

@@ -2,7 +2,7 @@
 
 ![Screenshot](/Screenshot.png)
 
-Copilot for Xcode is an Xcode Source Editor Extension that provides Github Copilot support for Xcode. It uses the LSP provided through [Copilot.vim](https://github.com/github/copilot.vim/tree/release/copilot/dist) to generate suggestions and displays them as comments or in a separate window.
+Copilot for Xcode is an Xcode Source Editor Extension that provides Github Copilot and ChatGPT support for Xcode. It uses the LSP provided through [Copilot.vim](https://github.com/github/copilot.vim/tree/release/copilot/dist) to generate suggestions and displays them as comments or in a separate window.
 
 Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing the way to interact with Copilot. And thanks to [LanguageClient](https://github.com/ChimeHQ/LanguageClient) for the Language Server Protocol support in Swift.
 
@@ -31,7 +31,8 @@ For development instruction, check [Development.md](DEVELOPMENT.md).
 
 - [Node](https://nodejs.org/) installed to run the Copilot LSP.
 - Public network connection.
-- Active GitHub Copilot subscription.  
+- Active GitHub Copilot subscription (to use suggestion features).
+- Valid OpenAI API key (to use chat features).  
 
 ## Permissions Required
 
@@ -94,7 +95,7 @@ If the app was installed via Homebrew, you can update it by running:
 brew upgrade --cask copilot-for-xcode
 ```
 
-Alternatively, You can download the latest version manually from the latest [release](https://github.com/intitni/CopilotForXcode/releases).  
+Alternatively, You can use the in-app updater or download the latest version manually from the latest [release](https://github.com/intitni/CopilotForXcode/releases).  
 
 If you are upgrading from a version lower than **0.7.0**, please run `Copilot for Xcode.app` at least once to let it set up the new launch agent for you and re-grant the permissions according to the new rules.
 
@@ -104,26 +105,27 @@ If you find that some of the features are no longer working, please first try re
 
 ## Commands
 
+### Suggestion
+
 - Get Suggestions: Get suggestions for the editing file at the current cursor position.
 - Next Suggestion: If there is more than one suggestion, switch to the next one.
 - Previous Suggestion: If there is more than one suggestion, switch to the previous one.
 - Accept Suggestion: Add the suggestion to the code.
 - Reject Suggestion: Remove the suggestion comments.
 - Toggle Real-time Suggestions: When turn on, Copilot will auto-insert suggestion comments to your code while editing.
 - Real-time Suggestions: Call only by Copilot for Xcode. When suggestions are successfully fetched, Copilot for Xcode will run this command to present the suggestions.
-- Prefetch Suggestions: Call only by Copilot for Xcode. In the background, Copilot for Xcode will occasionally run this command to prefetch real-time suggestions. 
+- Prefetch Suggestions: Call only by Copilot for Xcode. In the background, Copilot for Xcode will occasionally run this command to prefetch real-time suggestions.
 
 **About real-time suggestions**
 
-The on/off state is persisted, so be sure to turn it off manually when you no longer want it. When real-time suggestion is turned on, a dot will show up next to the text cursor. 
-
 Whenever you stop typing for a few milliseconds, the app will automatically fetch suggestions for you, you can cancel this by clicking the mouse, or pressing **Escape** or the **arrow keys**.
 
-When a fetch occurs, the dot will play an animation. If you don't see it, your permissions may not be set correctly.
+### Chat
 
-The implementation won't feel as smooth as that of VSCode. The magic behind it is that it will keep calling the command from the menu when you are not typing or clicking the mouse. So it will have to listen to those events, I am not sure if people like it. Hope that next year, Apple can spend some time on Xcode Extensions.  
+- Chat with Selection: Open a chat window, if there is a selection, the selected code will be added to the prompt.
+- Explain Selection: Open a chat window and explain the selected code.
 
-It will be a better experience if you use the "Floating Widget" mode with real-time suggestions turned on.
+Chat commands are not available in comment mode.
 
 ## Key Bindings
 
@@ -141,6 +143,8 @@ A [recommended setup](https://github.com/intitni/CopilotForXcode/issues/14) that
 
 Essentially using `⌥⇧` as the "access" key combination for all bindings.
 
+Another convenient method to access commands is by using the `⇧⌘/` shortcut to search for a command in the menu bar.
+
 ## Prevent Suggestions Being Committed (in comment mode)
 
 Since the suggestions are presented as comments, they are in your code. If you are not careful enough, they can be committed to your git repo. To avoid that, I would recommend adding a pre-commit git hook to prevent this from happening.