Default to Xcode's sourcekit-lsp on macOS instead of sourcekite

Author: vknabel

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.10.0
+
+- Default to Xcode's sourcekit-lsp on macOS instead of sourcekite
+- README.md instruction improvements #70 by [@fxn](https://github.com/fxn).
+
 ## 2.9.1
 
 - Support iOS for sourcekit-lsp #64 by [@haifengkao](https://github.com/haifengkao)

README.md

@@ -12,14 +12,22 @@
 
 You have the choice between three different language server implementations.
 
-| `sde.languageServerMode` | Comments                                  | Swift Versions                 | Install                                            |
-| ------------------------ | ----------------------------------------- | ------------------------------ | -------------------------------------------------- |
-| `sourcekit-lsp`          | Apple's official one. Activley developed. | 4 and 5                        | [#Using sourcekit-lsp](#Using-sourcekit-lsp)       |
-| `sourcekite` _default_   | SDE's one. Actively maintained.           | 5 and older versions 3.1 and 4 | [#Using sourcekite](#Using-sourcekite)             |
-| `langserver`             | RLovelett's LSP. Not maintained.          | 4.1, macOS only                | [#Using Langserver Swift](#Using-Langserver-Swift) |
+| `sde.languageServerMode`  | Comments                                  | Swift Versions                 | Install                                            |
+| ------------------------- | ----------------------------------------- | ------------------------------ | -------------------------------------------------- |
+| `sourcekit-lsp` _default_ | Apple's official one. Activley developed. | 4 and 5                        | [#Using sourcekit-lsp](#Using-sourcekit-lsp)       |
+| `sourcekite`              | SDE's one. Actively maintained.           | 5 and older versions 3.1 and 4 | [#Using sourcekite](#Using-sourcekite)             |
+| `langserver`              | RLovelett's LSP. Not maintained.          | 4.1, macOS only                | [#Using Langserver Swift](#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 `sde.languageServerMode` to `sourcekite`, `sourcekit-lsp` or `langserver`.
 
+### Using sourcekit-lsp
+
+> **Note:** on macOS SDE defaults to using your Xcode's Swift and sourcekit-lsp. In that case, [SDE](https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-swift-development-environment) should work out of the box!
+
+1. Install [SDE](https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-swift-development-environment).
+2. Recent versions of Xcode ship with `sourcekit-lsp`, you can check its path running `xcrun -f sourcekit-lsp`. If not found, please [install sourcekit-lsp](https://github.com/apple/sourcekit-lsp#building-sourcekit-lsp).
+3. Set `"swift.languageServerPath": "absolute path to the sourcekit-lsp executable"` and `"sde.languageServerMode": "sourcekit-lsp"`.
+
 ### Using sourcekite
 
 1. sourcekite does only work with [SDE](https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-swift-development-environment). Make sure you have it installed.
@@ -44,12 +52,6 @@ sourcekit-lsp is easier to install and will be updated more frequently. On the o
 
 If you experience any problems during installation, file an issue. All kind of feedback helps especially when trying to automate this.
 
-### Using sourcekit-lsp
-
-1. Install [SDE](https://marketplace.visualstudio.com/items?itemName=vknabel.vscode-swift-development-environment).
-2. Recent versions of Xcode ship with `sourcekit-lsp`, you can check its path running `xcrun -f sourcekit-lsp`. If not found, please [install sourcekit-lsp](https://github.com/apple/sourcekit-lsp#building-sourcekit-lsp).
-3. Set `"swift.languageServerPath": "absolute path to the sourcekit-lsp executable"` and `"sde.languageServerMode": "sourcekit-lsp"`.
-
 ### Using Langserver Swift
 
 Besides sourcekit-lsp and sourcekite SDE allows you to use [RLovelett/langserver-swift](https://github.com/RLovelett/langserver-swift).
@@ -122,47 +124,49 @@ With sourcekite, you can add new autocompletion targets through your configurati
 ```
 
 Since Xcode 11.4, you may use its built-in support for sourcekit-lsp
+
 ```json
 // .vscode/settings.json example for iOS
 {
-    "sde.languageservermode": "sourcekit-lsp",
-    "sourcekit-lsp.serverPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/sourcekit-lsp",
-    "sourcekit-lsp.toolchainPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain",
-    "sde.swiftBuildingParams" : [
-        "build",
-        "-Xswiftc",
-        "-sdk",
-        "-Xswiftc",
-        "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk",
-        "-Xswiftc",
-        "-target",
-        "-Xswiftc",
-        "arm64-apple-ios11.0"
-    ]
+  "sde.languageservermode": "sourcekit-lsp",
+  "sourcekit-lsp.serverPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/sourcekit-lsp",
+  "sourcekit-lsp.toolchainPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain",
+  "sde.swiftBuildingParams": [
+    "build",
+    "-Xswiftc",
+    "-sdk",
+    "-Xswiftc",
+    "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk",
+    "-Xswiftc",
+    "-target",
+    "-Xswiftc",
+    "arm64-apple-ios11.0"
+  ]
 }
 ```
 
 ```json
 // .vscode/settings.json example for WatchOS
 {
-    "sde.languageservermode": "sourcekit-lsp",
-    "sourcekit-lsp.serverPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/sourcekit-lsp",
-    "sourcekit-lsp.toolchainPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain",
-    "sde.swiftBuildingParams" : [
-        "build",
-        "-Xswiftc",
-        "-sdk",
-        "-Xswiftc",
-        "/Applications/Xcode.app/Contents/Developer/Platforms/WatchOS.platform/Developer/SDKs/WatchOS.sdk",
-        "-Xswiftc",
-        "-target",
-        "-Xswiftc",
-        "armv7k-apple-watchos4.0"
-    ]
+  "sde.languageservermode": "sourcekit-lsp",
+  "sourcekit-lsp.serverPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/bin/sourcekit-lsp",
+  "sourcekit-lsp.toolchainPath": "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain",
+  "sde.swiftBuildingParams": [
+    "build",
+    "-Xswiftc",
+    "-sdk",
+    "-Xswiftc",
+    "/Applications/Xcode.app/Contents/Developer/Platforms/WatchOS.platform/Developer/SDKs/WatchOS.sdk",
+    "-Xswiftc",
+    "-target",
+    "-Xswiftc",
+    "armv7k-apple-watchos4.0"
+  ]
 }
 ```
 
 ### Build failed! What should I do?
+
 Go to vscode `OUTPUT` window, then select `SPM`. The `OUTPUT` window will tell you what's wrong.
 
 ### Other questions?

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/vknabel"
   },
   "license": "Apache-2.0",
-  "version": "2.9.1",
+  "version": "2.10.0",
   "publisher": "vknabel",
   "icon": "icons/icon.png",
   "galleryBanner": {
@@ -60,11 +60,11 @@
       "properties": {
         "sourcekit-lsp.serverPath": {
           "type": "string",
-          "description": "The path of the sourcekit-lsp executable"
+          "description": "The path of the sourcekit-lsp executable\nIn SDE: defaults to the toolchain's sourcekit-lsp."
         },
         "sourcekit-lsp.toolchainPath": {
           "type": "string",
-          "description": "The path of the swift toolchain"
+          "description": "The path of the swift toolchain.\nIn SDE: defaults to Xcode's default toolchain."
         },
         "swift.languageServerPath": {
           "type": "string",

src/clientMain.ts

@@ -23,6 +23,7 @@ import {
   Executable
 } from "vscode-languageclient";
 import { absolutePath } from "./AbsolutePath";
+import { promisify } from "util";
 
 let swiftBinPath: string | null = null;
 let swiftBuildParams: string[] = ["build"];
@@ -43,7 +44,9 @@ function shouldBuildOnSave(): boolean {
   }
 }
 
-function currentServerOptions(context: ExtensionContext) {
+async function currentServerOptions(
+  context: ExtensionContext
+): Promise<ServerOptions> {
   function sourcekiteServerOptions() {
     // The server is implemented in node
     const serverModule = context.asAbsolutePath(
@@ -90,32 +93,57 @@ function currentServerOptions(context: ExtensionContext) {
     return serverOptions;
   }
 
-  function sourcekitLspServerOptions() {
-    // Load the path to the language server from settings
-    const executableCommand =
-      workspace.getConfiguration("sourcekit-lsp").get<string>("serverPath") ||
-      workspace
-        .getConfiguration("swift")
-        .get("languageServerPath", "/usr/local/bin/sourcekit-lsp");
+  async function sourcekitLspServerOptions() {
     const toolchain = workspace
       .getConfiguration("sourcekit-lsp")
       .get<string>("toolchainPath");
 
+    async function sourceKitLSPLocation() {
+      const explicit = workspace
+        .getConfiguration("sourcekit-lsp")
+        .get<string | null>("serverPath", null);
+      if (explicit) return explicit;
+
+      const sourcekitLSPPath = path.resolve(
+        toolchain ||
+          "/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain",
+        "usr/bin/sourcekit-lsp"
+      );
+      const isPreinstalled = await promisify(fs.exists)(
+        path.resolve(toolchain, "usr/bin/sourcekit-lsp")
+      );
+      if (isPreinstalled) {
+        return sourcekitLSPPath;
+      }
+
+      return workspace
+        .getConfiguration("swift")
+        .get("languageServerPath", "/usr/local/bin/sourcekit-lsp");
+    }
+
     // sourcekit-lsp takes -Xswiftc arguments like "swift build", but it doesn't need "build" argument
-    let sourceKitArgs = (<string[]>(
-      workspace.getConfiguration().get("sde.swiftBuildingParams")
-    ) || []).filter(param => param !== "build")
+    let sourceKitArgs = (
+      <string[]>workspace.getConfiguration().get("sde.swiftBuildingParams") ||
+      []
+    ).filter(param => param !== "build");
 
     const env: NodeJS.ProcessEnv = toolchain
       ? { ...process.env, SOURCEKIT_TOOLCHAIN_PATH: toolchain }
       : process.env;
 
-    const run: Executable = { command: executableCommand, options: { env }, args: sourceKitArgs};
+    const run: Executable = {
+      command: await sourceKitLSPLocation(),
+      options: { env },
+      args: sourceKitArgs
+    };
     const serverOptions: ServerOptions = run;
     return serverOptions;
   }
 
-  const lspMode = workspace.getConfiguration("sde").get("languageServerMode");
+  const lspMode = workspace
+    .getConfiguration("sde")
+    .get("languageServerMode", "sourcekit-lsp");
+
   if (lspMode === "sourcekit-lsp") {
     return sourcekitLspServerOptions();
   } else if (lspMode === "langserver") {
@@ -139,7 +167,7 @@ function currentClientOptions(
   }
 }
 
-export function activate(context: ExtensionContext) {
+export async function activate(context: ExtensionContext) {
   if (workspace.getConfiguration().get<boolean>("sde.enable") === false) {
     return;
   }
@@ -178,7 +206,7 @@ export function activate(context: ExtensionContext) {
   // Create the language client and start the client.
   const langClient = new LanguageClient(
     "Swift",
-    currentServerOptions(context),
+    await currentServerOptions(context),
     clientOptions
   );
   let disposable = langClient.start();