Merge tag '0.5.0' into develop

Author: intitni

Copilot for Xcode.xcodeproj/project.pbxproj

@@ -493,7 +493,7 @@
 				CODE_SIGN_ENTITLEMENTS = EditorExtension/EditorExtension.entitlements;
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
-				CURRENT_PROJECT_VERSION = 1;
+				CURRENT_PROJECT_VERSION = "$(APP_BUILD)";
 				DEVELOPMENT_TEAM = 5YKZ4Y3DAW;
 				ENABLE_HARDENED_RUNTIME = YES;
 				INFOPLIST_FILE = EditorExtension/Info.plist;
@@ -505,7 +505,7 @@
 					"@executable_path/../../../../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 12.0;
-				MARKETING_VERSION = 1.0;
+				MARKETING_VERSION = "$(APP_VERSION)";
 				PRODUCT_BUNDLE_IDENTIFIER = "$(BUNDLE_IDENTIFIER_BASE).EditorExtension";
 				PRODUCT_NAME = Copilot;
 				SKIP_INSTALL = YES;
@@ -520,7 +520,7 @@
 				CODE_SIGN_ENTITLEMENTS = EditorExtension/EditorExtension.entitlements;
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
-				CURRENT_PROJECT_VERSION = 1;
+				CURRENT_PROJECT_VERSION = "$(APP_BUILD)";
 				DEVELOPMENT_TEAM = 5YKZ4Y3DAW;
 				ENABLE_HARDENED_RUNTIME = YES;
 				INFOPLIST_FILE = EditorExtension/Info.plist;
@@ -532,7 +532,7 @@
 					"@executable_path/../../../../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 12.0;
-				MARKETING_VERSION = 1.0;
+				MARKETING_VERSION = "$(APP_VERSION)";
 				PRODUCT_BUNDLE_IDENTIFIER = "$(BUNDLE_IDENTIFIER_BASE).EditorExtension";
 				PRODUCT_NAME = Copilot;
 				SKIP_INSTALL = YES;
@@ -703,7 +703,7 @@
 				CODE_SIGN_ENTITLEMENTS = "Copilot for Xcode/Copilot_for_Xcode.entitlements";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
-				CURRENT_PROJECT_VERSION = 13;
+				CURRENT_PROJECT_VERSION = "$(APP_BUILD)";
 				DEVELOPMENT_ASSET_PATHS = "\"Copilot for Xcode/Preview Content\"";
 				DEVELOPMENT_TEAM = 5YKZ4Y3DAW;
 				ENABLE_HARDENED_RUNTIME = YES;
@@ -717,7 +717,7 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 12.0;
-				MARKETING_VERSION = 0.4.0;
+				MARKETING_VERSION = "$(APP_VERSION)";
 				PRODUCT_BUNDLE_IDENTIFIER = "$(BUNDLE_IDENTIFIER_BASE)";
 				PRODUCT_MODULE_NAME = Copilot_for_Xcode;
 				PRODUCT_NAME = "Copilot for Xcode Dev";
@@ -735,7 +735,7 @@
 				CODE_SIGN_ENTITLEMENTS = "Copilot for Xcode/Copilot_for_Xcode.entitlements";
 				CODE_SIGN_STYLE = Automatic;
 				COMBINE_HIDPI_IMAGES = YES;
-				CURRENT_PROJECT_VERSION = 13;
+				CURRENT_PROJECT_VERSION = "$(APP_BUILD)";
 				DEVELOPMENT_ASSET_PATHS = "\"Copilot for Xcode/Preview Content\"";
 				DEVELOPMENT_TEAM = 5YKZ4Y3DAW;
 				ENABLE_HARDENED_RUNTIME = YES;
@@ -749,7 +749,7 @@
 					"@executable_path/../Frameworks",
 				);
 				MACOSX_DEPLOYMENT_TARGET = 12.0;
-				MARKETING_VERSION = 0.4.0;
+				MARKETING_VERSION = "$(APP_VERSION)";
 				PRODUCT_BUNDLE_IDENTIFIER = "$(BUNDLE_IDENTIFIER_BASE)";
 				PRODUCT_NAME = "Copilot for Xcode";
 				SWIFT_EMIT_LOC_STRINGS = YES;

Core/Sources/Service/AutoTrigger.swift

@@ -64,7 +64,7 @@ public actor AutoTrigger {
         if task == nil {
             task = Task { [stream = eventObserver.stream] in
                 var triggerTask: Task<Void, Error>?
-                for await _ in stream {
+                for await eventType in stream {
                     triggerTask?.cancel()
                     if Task.isCancelled { break }
                     guard await Environment.isXcodeActive() else { continue }
@@ -77,16 +77,17 @@ public actor AutoTrigger {
                         }
                     }
 
+                    guard eventType == .keyUp else { continue }
+
                     triggerTask = Task { @ServiceActor in
-                        try? await Task.sleep(nanoseconds: 2_000_000_000)
+                        try? await Task.sleep(nanoseconds: 1_500_000_000)
                         if Task.isCancelled { return }
                         let fileURL = try? await Environment.fetchCurrentFileURL()
-                        guard let folderURL = try? await Environment
-                            .fetchCurrentProjectRootURL(fileURL)
-                        else { return }
-                        let workspace = workspaces[folderURL] ??
-                            Workspace(projectRootURL: folderURL)
-                        workspaces[folderURL] = workspace
+                        let folderURL = try? await Environment.fetchCurrentProjectRootURL(fileURL)
+                        guard let workspaceURL = folderURL ?? fileURL else { return }
+                        let workspace = workspaces[workspaceURL]
+                            ?? Workspace(projectRootURL: workspaceURL)
+                        workspaces[workspaceURL] = workspace
                         guard workspace.isRealtimeSuggestionEnabled else { return }
                         if Task.isCancelled { return }
                         try? await Environment.triggerAction("Prefetch Suggestions")

Core/Sources/Service/CGEventObserver.swift

@@ -6,17 +6,22 @@ public protocol CGEventObserverType {
     @discardableResult
     func activateIfPossible() -> Bool
     func deactivate()
-    var stream: AsyncStream<Void> { get }
+    var stream: AsyncStream<CGEventType> { get }
     var isEnabled: Bool { get }
 }
 
 final class CGEventObserver: CGEventObserverType {
-    let stream: AsyncStream<Void>
+    let stream: AsyncStream<CGEventType>
     var isEnabled: Bool { port != nil }
 
-    private var continuation: AsyncStream<Void>.Continuation
+    private var continuation: AsyncStream<CGEventType>.Continuation
     private var port: CFMachPort?
-    private let eventsOfInterest: Set<CGEventType> = [.keyUp]
+    private let eventsOfInterest: Set<CGEventType> = [
+        .keyUp,
+        .keyDown,
+        .rightMouseDown,
+        .leftMouseDown,
+    ]
     private let tapLocation: CGEventTapLocation = .cghidEventTap
     private let tapPlacement: CGEventTapPlacement = .tailAppendEventTap
     private let tapOptions: CGEventTapOptions = .listenOnly
@@ -28,7 +33,7 @@ final class CGEventObserver: CGEventObserverType {
     }
 
     init() {
-        var continuation: AsyncStream<Void>.Continuation!
+        var continuation: AsyncStream<CGEventType>.Continuation!
         stream = AsyncStream { c in
             continuation = c
         }
@@ -66,9 +71,9 @@ final class CGEventObserver: CGEventObserverType {
             }
 
             if let continuation = continuationPointer?
-                .assumingMemoryBound(to: AsyncStream<Void>.Continuation.self)
+                .assumingMemoryBound(to: AsyncStream<CGEventType>.Continuation.self)
             {
-                continuation.pointee.yield(())
+                continuation.pointee.yield(eventType)
             }
 
             return .passRetained(event)

DEVELOPMENT.md

@@ -34,6 +34,14 @@ Testing Real-time Suggestions is a little bit different because the Apple Script
 
 Just run both the XPCService and the EditorExtension Target. 
 
+## Code Style
+
+We use SwiftFormat to format the code.
+
+The source code mostly follows the [Ray Wenderlich Style Guide](https://github.com/raywenderlich/swift-style-guide) very closely with the following exception:
+
+- Use the Xcode default of 4 spaces for indentation.
+
 ## App Versioning
 
 The app version and all targets' version in controlled by `Version.xcconfig`.

EditorExtension/Info.plist

@@ -3,7 +3,7 @@
 <plist version="1.0">
 <dict>
 	<key>CFBundleShortVersionString</key>
-	<string>$(APP_VERSION)</string>
+	<string>$(MARKETING_VERSION)</string>
 	<key>NSHumanReadableCopyright</key>
 	<string></string>
 	<key>CFBundleDevelopmentRegion</key>
@@ -15,7 +15,7 @@
 	<key>CFBundleExecutable</key>
 	<string>$(EXECUTABLE_NAME)</string>
 	<key>CFBundleVersion</key>
-	<string>$(APP_BUILD)</string>
+	<string>$(CURRENT_PROJECT_VERSION)</string>
 	<key>CFBundleInfoDictionaryVersion</key>
 	<string>6.0</string>
 	<key>CFBundleIdentifier</key>

README.md

@@ -20,17 +20,28 @@ Thanks to [LSP-copilot](https://github.com/TerminalFi/LSP-copilot) for showing t
 
 ## Installation and Setup
 
-1. Download the Copilot for Xcode.app from the latest release, and extract it to the Applications folder.
+### Install
+
+1. Download the Copilot for Xcode.app from the latest [release](https://github.com/intitni/CopilotForXcode/releases), and extract it to the Applications folder.
 2. Open the app, and click "Set Up Launch Agents" to set up a background running XPC Service that does the real job.
-3. Refresh the Copilot status, if it fails, quit and restart the app. 
-4. Sign in. You will be directed to a verification website provided by GitHub, and a user code will be pasted into your clipboard.
-5. After signing in, go back to the app and click "Confirm Sign-in" to finish.
-5. Enable the extension in the Settings.app, then maybe restart Xcode.
+3. Enable the extension in the Settings.app, then maybe restart Xcode.
+
+### Sign In Github Copilot
+ 
+1. In the app, refresh the Copilot status, if it fails, quit and restart the app. 
+2. Click "Sign In", you will be directed to a verification website provided by GitHub, and a user code will be pasted into your clipboard.
+3. After signing in, go back to the app and click "Confirm Sign-in" to finish.
 
 The first time the commands run, the extension will ask for 2 types of permissions:
 1. Accessibility API: which the extension uses to get the editing file path.
 2. Folder Access: the extension needs, to run some Apple Scripts to get the project/workspace path. 
 
+## Update 
+
+You can manually download the latest release. After updating the app, don't forget to click `Restart XPC Service` in the app to kill the old version and run the new version.
+
+If you want to keep track of the new releases, you can watch this repo's releases to get notifications on updates.
+
 ## Commands
 
 - Get Suggestions: Get suggestions for the editing file at the current cursor position.
@@ -91,6 +102,8 @@ fi
 **Q: I turned on real-time suggestions, but nothing happens**
 
 > A: Check the list in `Settings.app > Privacy & Security > Input Monitoring`. Turn the toggle on for `Copilot for Xcode`. If it's not on the list, add it manually. After that, you may have to restart the XPC Service.
+>
+> If that doesn't help, try to restart the XPC Service again.
 
 **Q: Will it work in future Xcode updates?**
 

Version.xcconfig

@@ -1,2 +1,2 @@
-APP_VERSION = 0.4.0
-APP_BUILD = 13
+APP_VERSION = 0.5.0
+APP_BUILD = 18