https://github.com/solawing/xcode-build-server
a build server protocol implementation for integrate xcode with sourcekit-lsp
https://github.com/solawing/xcode-build-server
language-server-protocol sourcekit-lsp swift xcode
Last synced: 18 days ago
JSON representation
a build server protocol implementation for integrate xcode with sourcekit-lsp
- Host: GitHub
- URL: https://github.com/solawing/xcode-build-server
- Owner: SolaWing
- License: mit
- Created: 2020-04-04T14:01:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T06:35:48.000Z (3 months ago)
- Last Synced: 2025-04-29T21:47:26.313Z (about 1 month ago)
- Topics: language-server-protocol, sourcekit-lsp, swift, xcode
- Language: Python
- Homepage:
- Size: 111 KB
- Stars: 619
- Watchers: 11
- Forks: 26
- Open Issues: 4
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Xcode-Build-Server
Apple's [sourcekit-lsp](https://github.com/apple/sourcekit-lsp) doesn't support xcode project. But I found it provides a [build server protocol](https://build-server-protocol.github.io/docs/specification.html) to integrate with other build system. This is why I created this repo.
This repo aims to integrate xcode with sourcekit-lsp and support all the languages (swift, c, cpp, objc, objcpp) xcode supports, so I can develop iOS with my favorate editor.
# Install
This repo requires Python 3.9. The latest macOS already comes with this tool.
After you've made sure you have Python 3.9, just clone this repo, and add a symbolic link to your bin folder by running: `ln -s ABSPATH/TO/xcode-build-server /usr/local/bin`
Here is a script for quick install if your working directory is your desired destination for the installation:
`git clone "[email protected]:SolaWing/xcode-build-server.git" && ln -s "$PWD"/xcode-build-server/xcode-build-server /usr/local/bin`
or
`git clone "https://github.com/SolaWing/xcode-build-server.git" && ln -s "$PWD"/xcode-build-server/xcode-build-server /usr/local/bin`
or install using homebrew
`brew install xcode-build-server`
or install using [Macports](https://github.com/macports/macports-ports/blob/master/devel/xcode-build-server/Portfile):
`sudo port install xcode-build-server`
# Usage
Choose one of the following methods. (No matter which method you use, you need to ensure that the directory where `buildServer.json` is created in is **the root/working directory** of the LSP)
### Bind to Xcode
Go to your workspace directory and execute one of the following commands:
```bash
# *.xcworkspace or *.xcodeproj should be unique. This can be omitted and the build server will automatically choose the unique workspace or project.
# -scheme can also be omitted to automatically bind the latest scheme build result. even change it in xcode after the buildServer.json generated
xcode-build-server config -workspace *.xcworkspace -scheme
xcode-build-server config -project *.xcodeproj -scheme
```
This will create or update the `buildServer.json` file, with a `kind: xcode` key, which instructs xcode-build-server to watch and use compile flags from the newest xcode build log.
After this, you can open your file with sourcekit-lsp enabled and it should work.
If your compile info is outdated and something is not working properly, just build in xcode to refresh compile flags.
> PS: xcodebuild can generate same build log as xcode if you don't overwrite build dir and specify a -resultBundlePath. This way you don't have to open xcode to build. eg:
```bash
rm .bundle; xcodebuild -workspace *.xcworkspace -scheme -destination 'generic/platform=iOS Simulator' -resultBundlePath .bundle build
```
### Manual Parse Xcodebuild log
If you are not building with Xcode, you can manually parse the build log to extract compile info using one of the following commands:
```bash
xcode-build-server parse [-a]
| xcode-build-server parse [-a]
```
this will parse the log, save compile info in a `.compile` file, and update `buildServer.json` with a `kind: manual` key to instruct `xcode-build-server` to use the flags from the `.compile` file.
`` can be created by redirecting `xcodebuild build` output to a file, or exported from xcode's build log UI.
`` will usually be xcodebuild, or `pbpaste` if copied from xcode's build log. for example:
```base
xcodebuild -workspace *.xcworkspace -scheme -configuration Debug build | xcode-build-server parse [-a]
pbpaste | xcode-build-server parse [-a]
```
When running for the first time, **you need to ensure that the log is complete**, otherwise some files won't be able to obtain correct flags.
After completing these steps, restart your language server, and it should work as expected.
If your build environment changes(eg: add new files, switch sdk, toggle debug/release, conditional macro, etc..) and your language server stops working, just repeat the previous steps to update the compile info. In these incremental update cases, **you should make sure to use the `-a` flag**, which will only add new flags, and other irrelevant old flags will remain unchanged.
if you use xcodebuild and want to see raw output, currently you can use the following commands: `xcodebuild ... | tee build.log; xcode-build-server parse -a build.log >/dev/null 2>&1`
### [Deprecated] Sync Xcodebuild log
> this usage is deprecated by `bind xcodeproj`, which is just a command and won't pollute your xcodeproj's config.
> switch from this usage to `bind xcodeproj`, you'll need to delete the `post-build-action` first. Otherwise, bind may not work properly. Since kind will change to manual by post-build-action.
xcode-build-server provider `post-build-action` script to auto parse newest log into .compile and generate `buildServer.json`.
just add `xcode-build-server postaction | bash &` into script in **scheme -> Build -> Post-actions**. and script should choose provide build settings from target
after this, the compile info should auto generate when xcode builds and no need for further manual parsing.
## Indexing While Building
[sourcekit-lsp](https://github.com/apple/sourcekit-lsp#indexing-while-building) uses indexing while building.
If you find that find definitions or references are not working correctly, just build it to update index
# More
Current implementation is basicly working, but may have some rough edges. Please report issue if you have any problem. If you want to help, you can check the open issue list. PR's are always welcome.
When reporting an issue, you may provide your buildServer.json and run LSP with the environment variable SOURCEKIT_LOGGING=3 to provide detailed logs to help locate the problem.
# Common Issues
* If you use multiple versions of xcode or sourcekit-lsp, and it doesn't work properly, such as Loading the standard library failed, you should check that the build and sourcekit-lsp versions are **consistent**. Usually you can use `xcode-select` to switch toolchains, and use `xcrun sourcekit-lsp` to use the corresponding lsp version.
* If cross-file references don't work for you, the "build_root" property might not be configured correctly in `buildServer.json`. It should look like `"build_root": "/Users/yourusername/Library/Developer/Xcode/DerivedData/Simulator_Controller-adadrfjxhdizubdktugddworgvuj"` rather than `"build_root": "/Users/yourusername"`. Fix this by running `sudo xcode-select -s /Applications/Xcode.app/Contents/Developer` in the root of your XCode project. For more details, see [this issue](https://github.com/SolaWing/xcode-build-server/issues/55).
# Development
## Release new version
1. Create a new tag with `git tag -a v0.1.0 -m "release 0.1.0"`
2. Push tag with `git push origin v0.1.0`
3. GitHub action will create release