Merge tag '0.28.0' into develop

Author: intitni

.github/ISSUE_TEMPLATE/feature_reqeust.yaml

@@ -8,7 +8,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to fill out this feature request! 
+        Thanks for taking the time to fill out this feature request! But please firstly [post your idea in discussion](https://github.com/intitni/CopilotForXcode/discussions/new?category=ideas) so that we can discuss about it in advance.
   - type: checkboxes
     id: before-reporting
     attributes:
@@ -25,4 +25,4 @@ body:
       placeholder: Tell us what you want!
       value: "I want a feature!"
     validations:
-      required: true
+      required: true

Core/Sources/ChatService/DynamicContextController.swift

@@ -101,6 +101,7 @@ final class DynamicContextController {
             .flatMap(\.retrievedContent)
             .filter { !$0.document.content.isEmpty }
             .sorted { $0.priority > $1.priority }
+            .prefix(15)
 
         let contextualSystemPrompt = """
         \(language.isEmpty ? "" : "You must always reply in \(language)")

Core/Sources/HostApp/DebugView.swift

@@ -42,7 +42,7 @@ struct DebugSettingsView: View {
                     Text("Use custom scroll view workaround for smooth scrolling")
                 }
                 Toggle(isOn: $settings.triggerActionWithAccessibilityAPI) {
-                    Text("Trigger command with AccessibilityAPI")
+                    Text("Trigger command with Accessibility API")
                 }
                 Group {
                     Toggle(isOn: $settings.alwaysAcceptSuggestionWithAccessibilityAPI) {
@@ -62,14 +62,14 @@ struct DebugSettingsView: View {
                     }
 
                     Toggle(isOn: $settings.disableEnhancedWorkspace) {
-                        Text("Disable Enhanced Workspace")
+                        Text("Disable enhanced workspace")
                     }
 
                     Toggle(isOn: $settings.disableGitIgnoreCheck) {
-                        Text("Disable Git Ignore Check")
+                        Text("Disable git ignore check")
                     }
 
-                    Button("Reset Migration Version to 0") {
+                    Button("Reset migration version to 0") {
                         UserDefaults.shared.set(nil, forKey: "OldMigrationVersion")
                     }
 

Pro

@@ -67,6 +67,14 @@ For chat and prompt to code features:
 
 ## Installation and Setup
 
+> The installation process is a bit complicated. Here is a quick overview:
+> 
+> 1. Install the app into the Applications folder, open it once.
+> 2. Enable the source editor extension.
+> 3. Grant Accessibility API permission to the extension app.
+> 4. Setup accounts and models in the host app.
+> 5. Optionally, update the settings of each feature in the host app, and setup keybindings.
+
 ### Install
 
 You can install it via [Homebrew](http://brew.sh/):
@@ -172,20 +180,16 @@ You can also set it to quit automatically when the above 2 apps are closed.
 
 ## Update
 
-If the app was installed via Homebrew, you can update it by running:
-
-```bash
-brew upgrade --cask copilot-for-xcode
-```
-
-Alternatively, You can use the in-app updater or download the latest version manually from the latest [release](https://github.com/intitni/CopilotForXcode/releases).
+You can use the in-app updater or download the latest version manually from the latest [release](https://github.com/intitni/CopilotForXcode/releases).
 
 After updating, please open Copilot for Xcode.app once and restart Xcode to allow the extension to reload.
 
 If you find that some of the features are no longer working, please first try regranting permissions to the app.
 
 ## Feature
 
+> Files in gitignore will not receive suggestion. Both chat and prompt to code feature will not have access to them unless you manually select code from them.
+
 ### Suggestion
 
 The app can provide real-time code suggestions based on the files you have opened. It's powered by GitHub Copilot and Codeium.
@@ -302,6 +306,18 @@ This feature is recommended when you need to update a specific piece of code. So
 - Polishing and correcting grammar and spelling errors in the documentation.
 - Translating a localizable strings file.
 
+#### Prompt to Code Scope
+
+The chat panel allows for chat scope to temporarily control the context of the conversation for the latest message. To use a scope, simply prefix the message with `@scope`.
+
+|   Scope    | Description                                                                              |
+| :--------: | ---------------------------------------------------------------------------------------- |
+|  `@sense`  | Experimental. Read the relevant information of the focused code                          |
+
+To use scopes, you can prefix a message with `@sense`.
+
+You can use shorthand to represent a scope, such as `@sense`, and enable multiple scopes with `@c+web`.
+
 #### Commands
 
 - Prompt to Code: Open a prompt to code window, where you can use natural language to write or edit selected code.
@@ -334,6 +350,9 @@ These features are included in another repo, and are not open sourced.
 
 The currently available Plus features include:
 
+- `@project` scope in chat.
+- Suggestion Cheatsheet that provides relevant content to the suggestion service.
+- `@sense` scope in chat and prompt to code.
 - Terminal tab in chat panel.
 - Unlimited chat/embedding models.
 - Tab to accept suggestions.

README.md

@@ -105,6 +105,7 @@ let package = Package(
             name: "Environment",
             dependencies: [
                 "ActiveApplicationMonitor",
+                "XcodeInspector",
                 "AXExtension",
                 "Preferences",
             ]
@@ -173,7 +174,6 @@ let package = Package(
             dependencies: [
                 "AXExtension",
                 "SuggestionModel",
-                "Environment",
                 "AXNotificationStream",
                 "Logger",
                 .product(name: "AsyncAlgorithms", package: "swift-async-algorithms"),

Tool/Package.swift

@@ -4,6 +4,7 @@ import AXExtension
 import Foundation
 import Logger
 import Preferences
+import XcodeInspector
 
 public struct NoAccessToAccessibilityAPIError: Error, LocalizedError {
     public var errorDescription: String? {
@@ -149,9 +150,16 @@ public enum Environment {
     }
 
     public static var triggerAction: (_ name: String) async throws -> Void = { name in
-        guard let activeXcode = ActiveApplicationMonitor.shared.activeXcode
-            ?? ActiveApplicationMonitor.shared.latestXcode
-        else { return }
+        struct CantRunCommand: Error, LocalizedError {
+            let name: String
+            var errorDescription: String? {
+                "Can't run command \(name)."
+            }
+        }
+
+        guard let activeXcode = XcodeInspector.shared.latestActiveXcode?.runningApplication
+        else { throw CantRunCommand(name: name) }
+
         let bundleName = Bundle.main
             .object(forInfoDictionaryKey: "EXTENSION_BUNDLE_NAME") as! String
 
@@ -186,12 +194,6 @@ public enum Environment {
                     return
                 }
             }
-            struct CantRunCommand: Error, LocalizedError {
-                let name: String
-                var errorDescription: String? {
-                    "Can't run command \(name)."
-                }
-            }
 
             throw CantRunCommand(name: name)
         } else {

Tool/Sources/Environment/Environment.swift

@@ -112,7 +112,7 @@ struct OpenAICompletionAPI: CompletionAPI {
             return try JSONDecoder().decode(CompletionResponseBody.self, from: result)
         } catch {
             dump(error)
-            fatalError()
+            throw error
         }
     }
 }

Tool/Sources/OpenAIService/CompletionAPI.swift

@@ -30,7 +30,7 @@ public actor AutoManagedChatGPTMemory: ChatGPTMemory {
     static let encoder: TokenEncoder = TiktokenCl100kBaseTokenEncoder()
 
     var onHistoryChange: () -> Void = {}
-    
+
     let composeHistory: HistoryComposer
 
     public init(
@@ -251,14 +251,17 @@ extension AutoManagedChatGPTMemory {
         usage: Int,
         references: [ChatMessage.Reference]
     ) {
+        /// the available tokens count for retrieved content
+        let thresholdMaxTokenCount = min(maxTokenCount, configuration.maxTokens / 2)
+
         var retrievedContentTokenCount = 0
         let separator = String(repeating: "=", count: 32) // only 1 token
         var message = ""
         var references = [ChatMessage.Reference]()
 
         func appendToMessage(_ text: String) -> Bool {
             let tokensCount = encoder.countToken(text: text)
-            if tokensCount + retrievedContentTokenCount > maxTokenCount { return false }
+            if tokensCount + retrievedContentTokenCount > thresholdMaxTokenCount { return false }
             retrievedContentTokenCount += tokensCount
             message += text
             return true

Tool/Sources/OpenAIService/Memory/AutoManagedChatGPTMemory.swift

@@ -1,3 +1,3 @@
-APP_VERSION = 0.27.1
-APP_BUILD = 281
+APP_VERSION = 0.28.0
+APP_BUILD = 290