Development

Prerequisites

Requires Node installed and npm available on your system path, e.g.

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 for more details.

Local Build

To build the application locally, follow these steps:

1. Navigate to the Script directory and run the build scripts:

   shCopy

   cd ./Script
   sh ./uninstall-app.sh    # Remove any previous installation
   rm -rf ../build          # Clean the build directory
   sh ./localbuild-app.sh   # Build a fresh copy of the app
   

2. After successful build, the application will be available in the build directory. Copy GitHub Copilot for Xcode.app to your Applications folder to test it locally.

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 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.