Skip to content

Latest commit

 

History

History
60 lines (33 loc) · 2.91 KB

DEVELOPMENT.md

File metadata and controls

60 lines (33 loc) · 2.91 KB

Development

Targets

Copilot for Xcode

Copilot for Xcode is the host app containing both the XPCService and the editor extension.

EditorExtension

As its name suggests, the 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 to bypass the limitations. The XPCService identifier 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 and performs a wide range of tasks. It redirects requests from the EditorExtension to the CopilotService and returns the updated code back to the extension, or presents it in a GUI outside of Xcode.

Core and Tool

Most of the logics are implemented inside the package Core and Tool.

  • The Service is responsible for handling the requests from the EditorExtension, communicating with the CopilotService, update the code blocks and present the GUI.
  • The Client is basically just a wrapper around the XPCService
  • The SuggestionInjector is responsible for injecting the suggestions into the code. Used in comment mode to present the suggestions, and all modes to accept suggestions.
  • The SuggestionWidget is responsible for the UI of the widgets.

Building and Archiving the App

  1. Update the xcconfig files, launchAgent.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, and update the last function in Core/Package.swift to return false.

Testing Source Editor Extension

Just run both the ExtensionService and the EditorExtension Target. Read 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.

Chat Plugins

To create a chat plugin, please use the TerminalChatPlugin as an example. You should add your plugin to the target ChatPlugin and register it in ChatService.

Code Style

We use SwiftFormat to format the code.

The source code mostly follows the Ray Wenderlich 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.