Merge pull request #1 from RainbowScientist5/raindrops.ai

Rainbowbeast_Copilot_Pull_Request
github · Jan 6, 2025 · 1599797 · 1599797
2 parents dfe1195 + 486c77d
commit 1599797
Show file tree

Hide file tree

Showing 12 changed files with 192 additions and 37 deletions.
diff --git a/DEVELOPMENT.md → Base.lproj/DEVELOPMENT.md b/DEVELOPMENT.md → Base.lproj/DEVELOPMENT.md
diff --git a/Copilot for Xcode.xcworkspace/contents.xcworkspacedata b/Copilot for Xcode.xcworkspace/contents.xcworkspacedata
diff --git a/Copilot for Xcode.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/Copilot for Xcode.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict/>
+</plist>
diff --git a/Copilot for Xcode.xcodeproj/project.pbxproj → ...pilot for Xcode.xcodeproj/project.pbxproj b/Copilot for Xcode.xcodeproj/project.pbxproj → ...pilot for Xcode.xcodeproj/project.pbxproj
diff --git a/...ject.xcworkspace/contents.xcworkspacedata → ...ject.xcworkspace/contents.xcworkspacedata b/...ject.xcworkspace/contents.xcworkspacedata → ...ject.xcworkspace/contents.xcworkspacedata
diff --git a/...ace/xcshareddata/IDEWorkspaceChecks.plist → ...ace/xcshareddata/IDEWorkspaceChecks.plist b/...ace/xcshareddata/IDEWorkspaceChecks.plist → ...ace/xcshareddata/IDEWorkspaceChecks.plist
diff --git a/...ta/xcschemes/CommunicationBridge.xcscheme → ...ta/xcschemes/CommunicationBridge.xcscheme b/...ta/xcschemes/CommunicationBridge.xcscheme → ...ta/xcschemes/CommunicationBridge.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1540"
+   LastUpgradeVersion = "1620"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/...data/xcschemes/Copilot for Xcode.xcscheme → ...data/xcschemes/Copilot for Xcode.xcscheme b/...data/xcschemes/Copilot for Xcode.xcscheme → ...data/xcschemes/Copilot for Xcode.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1410"
+   LastUpgradeVersion = "1620"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"
@@ -35,7 +35,7 @@
       </TestPlans>
    </TestAction>
    <LaunchAction
-      buildConfiguration = "Debug"
+      buildConfiguration = "Release"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
       launchStyle = "0"
@@ -46,14 +46,23 @@
       allowLocationSimulation = "YES">
       <BuildableProductRunnable
          runnableDebuggingMode = "0">
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "C8189B152938972F00C9DCDA"
+            BuildableName = "GitHub Rainbowbeast_Copilot for Xcode Dev.app"
+            BlueprintName = "Rainbowbeast_Copilot for Xcode"
+            ReferencedContainer = "container:Rainbowbeast_Copilot for Xcode.xcodeproj">
+         </BuildableReference>
+      </BuildableProductRunnable>
+      <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "C8189B152938972F00C9DCDA"
             BuildableName = "GitHub Copilot for Xcode.app"
             BlueprintName = "Copilot for Xcode"
             ReferencedContainer = "container:Copilot for Xcode.xcodeproj">
          </BuildableReference>
-      </BuildableProductRunnable>
+      </MacroExpansion>
       <CommandLineArguments>
          <CommandLineArgument
             argument = "-_NS_4445425547 YES"
@@ -77,6 +86,15 @@
             ReferencedContainer = "container:Copilot for Xcode.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "C8189B152938972F00C9DCDA"
+            BuildableName = "GitHub Copilot for Xcode.app"
+            BlueprintName = "Copilot for Xcode"
+            ReferencedContainer = "container:Copilot for Xcode.xcodeproj">
+         </BuildableReference>
+      </MacroExpansion>
    </ProfileAction>
    <AnalyzeAction
       buildConfiguration = "Debug">

diff --git a/...eddata/xcschemes/EditorExtension.xcscheme → ...eddata/xcschemes/EditorExtension.xcscheme b/...eddata/xcschemes/EditorExtension.xcscheme → ...eddata/xcschemes/EditorExtension.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1410"
+   LastUpgradeVersion = "1620"
    wasCreatedForAppExtension = "YES"
    version = "2.0">
    <BuildAction

diff --git a/...ddata/xcschemes/ExtensionService.xcscheme → ...ddata/xcschemes/ExtensionService.xcscheme b/...ddata/xcschemes/ExtensionService.xcscheme → ...ddata/xcschemes/ExtensionService.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1420"
+   LastUpgradeVersion = "1620"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/.../xcschemes/SandboxedClientTester.xcscheme → .../xcschemes/SandboxedClientTester.xcscheme b/.../xcschemes/SandboxedClientTester.xcscheme → .../xcschemes/SandboxedClientTester.xcscheme
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
-   LastUpgradeVersion = "1540"
+   LastUpgradeVersion = "1620"
    version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"

diff --git a/en.lproj/DEVELOPMENT.md b/en.lproj/DEVELOPMENT.md
@@ -0,0 +1,70 @@
+# Development
+
+## Prerequisites
+
+Requires Node installed and `npm` available on your system path, e.g.
+
+```sh
+sudo ln -s `which npm` /usr/local/bin
+sudo ln -s `which node` /usr/local/bin
+```
+
+For context, this is used by an Xcode run script as part of the build. Run
+scripts use a very limited path to resolve commands.
+
+## Targets 
+
+### Copilot for Xcode
+
+Copilot for Xcode is the host app containing both the XPCService and the editor extension. It provides the settings UI.
+
+### EditorExtension
+
+As its name suggests, the Xcode source editor extension. Its sole purpose is to forward editor content to the XPCService for processing, and update the editor with the returned content. Due to the sandboxing requirements for editor extensions, it has to communicate with a trusted, non-sandboxed XPCService (CommunicationBridge and ExtensionService) to bypass the limitations. The XPCService service name must be included in the `com.apple.security.temporary-exception.mach-lookup.global-name` entitlements.
+
+### ExtensionService
+
+The `ExtensionService` is a program that operates in the background. All features are implemented in this target.
+
+### CommunicationBridge
+
+It's responsible for maintaining the communication between the Copilot for Xcode/EditorExtension and ExtensionService.
+
+### Core and Tool
+
+Most of the logics are implemented inside the package `Core` and `Tool`.
+
+- The `Service` contains the implementations of the ExtensionService target.
+- The `HostApp` contains the implementations of the Copilot for Xcode target.
+
+## Building and Archiving the App
+
+1. Update the xcconfig files, bridgeLaunchAgent.plist, and Tool/Configs/Configurations.swift.
+2. Build or archive the Copilot for Xcode target.
+3. If Xcode complains that the pro package doesn't exist, please remove the package from the project.
+
+## Testing Source Editor Extension
+
+Just run both the `ExtensionService`, `CommunicationBridge` and the `EditorExtension` Target. Read [Testing Your Source Editor Extension](https://developer.apple.com/documentation/xcodekit/testing_your_source_editor_extension) for more details.
+
+## SwiftUI Previews
+
+Looks like SwiftUI Previews are not very happy with Objective-C packages when running with app targets. To use previews, please switch schemes to the package product targets.
+
+## Unit Tests
+
+To run unit tests, just run test from the `Copilot for Xcode` target.
+
+For new tests, they should be added to the `TestPlan.xctestplan`.
+
+## 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`.