Swift Development Environment
SDE adds Swift code completion and hover help to Visual Studio Code on macOS and Linux.
Fork Notice: This is the new home of SDE initially been developed by @jinmingjian. It is now maintained by @vknabel. jinmingjian/sde is no longer maintained and does only support Swift 3. This fork supports Swift 3.1, 4 and 5.
You have the choice between three different language server implementations.
|Apple's official one. Activley developed.
||4 and 5
|SDE's one. Actively maintained.
||5 and older versions 3.1 and 4
|RLovelett's LSP. Not maintained.
||4.1, macOS only
||#Using Langserver Swift
sourcekit-lsp is easier to install and will be updated more frequently. On the other hand sourcekite treats standalone files, Xcode projects and SwiftPM modules differently and is more configurable. If you can't decide, you can install both and swap out the used LSP by setting
sourcekite does only work with SDE. Make sure you have it installed.
Install the companion project sourcekite.
$ git clone https://github.com/vknabel/sourcekite
$ cd sourcekite
# For Linux
# Ensure you have libcurl4-openssl-dev installed (not pre-installed)
# $ apt-get update && apt-get install libcurl4-openssl-dev
# Ensure LD_LIBRARY_PATH contains /your/swift/usr/lib
# And have $ sudo ln -s /your/swift/usr/lib/libsourcekitdInProc.so /usr/lib/libsourcekitdInProc.so
$ make install PREFIX=/usr/local
# For macOS
$ make install PREFIX=/usr/local
Add the absolute path to your compiled sourcekite binary
swift.path.sourcekite to your vscode settings as
If you experience any problems during installation, file an issue. All kind of feedback helps especially when trying to automate this.
- Install SDE.
- Install sourcekit-lsp.
- Add the absolute path to your compiled sourcekite binary
sourcekit-lsp.serverPath, optionally to your toolchain
sourcekit-lsp.toolchainPath and tell SDE to use sourcekit-lsp
Using Langserver Swift
Besides sourcekit-lsp and sourcekite SDE allows you to use RLovelett/langserver-swift.
If you prefer using an alternative language server, set set
langserver and let
swift.languageServerPath point to your installed language server.
Though in most cases sourcekit-lsp and sourcekite should produce better results and performance.
- Valentin Knabel, @vknabel, twitter, maintainer
- Jin Mingjian, @JinMingjian, twitter, author, not involved anymore
- Felix Fischer, @felix91gr, twitter
- Mijo Gračanin, @mijo-gracanin
How to contribute to this project?
There are a lot of ways you could contribute to either this project or the Swift on VS Code itself. For more information head over to CONTRIBUTING.md.
How do I get autocompletion when using TensorFlow?
You can add the following configs. This will improve your autocompletion. Though currently the
TensorFlow module will not be indexed yet.
// .vscode/settings.json example for TensorFlow
"sde.swiftBuildingParams": ["build", "-Xlinker", "-ltensorflow"],
In case you find a way to get autocompletion for the
TensorFlow module to work, please submit a PR or open an issue.
How do I get autocompletion for UIKit?
You can add new autocomplation targets through your configuration.
// .vscode/settings.json example for iOS and WatchOS
If so, file an issue, please :)
Apache License v2.
3rd-party Sources Thanks
- dbgmits, very nice structure of sources, but of which in my heavy modification to support non-MI and much more