New Compiler options setting to support UIKit

Author: vknabel

CHANGELOG.md

@@ -1,9 +1,15 @@
 # Changelog
 
 ## 2.2.0
-* Autocompletion for external libraries like AppKit #8, UIKit still missing
+* Autocompletion for external libraries like AppKit and UIKit after restart #8
 * Display short documentation on autocompletion
 * More reliable autocompletion, especially for global namespace
+* New `"sde.sourcekit.compilerOptions"` setting
+
+### How do I get autocompletion for UIKit?
+
+Just add `"sde.sourcekit.compilerOptions": ["-target", "arm64-apple-ios11.0"]` to your workspace settings in Visual Studio Code and restart it.
+
 
 ## 2.1.3
 * Improved new README

README.md

@@ -15,13 +15,13 @@
 	```bash
 	$ git clone https://github.com/vknabel/sourcekite
 	$ cd sourcekite
-	
+
 	# For Linux
 	$ swift build
-	
+
 	# For macOS (when using swiftenv or multiple Toolchains)
 	$ swift build -Xswiftc -framework -Xswiftc sourcekitd -Xswiftc -F -Xswiftc /Library/Developer/Toolchains/swift-latest.xctoolchain/usr/lib -Xlinker -rpath -Xlinker /Library/Developer/Toolchains/swift-latest.xctoolchain/usr/lib -c release
-	
+
 	# For macOS (using Xcode's Toolchain)
 	$ swift build -Xswiftc -framework -Xswiftc sourcekitd -Xswiftc -F -Xswiftc /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/ -Xlinker -rpath -Xlinker /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/ -c release
 	```
@@ -35,7 +35,7 @@ SDE has a built-in Swift debugger which has been deprecated. Instead use [LLDB D
 
 An example config can be seen below. `program` should contain the path to your built executable, the `preLaunchTask` is optional, but will run `swift build` before each debug session to keep your binaries up to date.
 
-> **Note:** Currently I don't know of any reliable solution to debug your Swift tests. 
+> **Note:** Currently I don't know of any reliable solution to debug your Swift tests.
 > If you do, please file an issue or write me an [email](mailto:[email protected]).
 
 ```js
@@ -83,6 +83,10 @@ If you mean contributions to the **sources**, this is truely another topic. The
 
 There aren't too much documents about the development of this project. If you have any questions or interests, don't hesitate to file an [issue](https://github.com/vknabel/swift-development-environment/issues) or write me an [email](mailto:[email protected]). I will help you and then drop more readings as time goes by. This is **_the way of "open source"_**.
 
+### How do I get autocompletion for UIKit?
+
+Just add `"sde.sourcekit.compilerOptions": ["-target", "arm64-apple-ios11.0"]` to your workspace settings in Visual Studio Code and restart it.
+
 ### Other questions?
 
 If so, file an [issue](https://github.com/vknabel/swift-development-environment/issues), please :)

package.json

@@ -8,7 +8,7 @@
     "url": "https://github.com/vknabel"
   },
   "license": "Apache-2.0",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "publisher": "vknabel",
   "icon": "icons/icon.png",
   "galleryBanner": {
@@ -77,6 +77,14 @@
           "default": "/bin/sh",
           "description": "The fully path to the shell binary."
         },
+        "sde.sourcekit.compilerOptions": {
+          "type": "array",
+          "description": "Optional compiler options like the target or search paths.",
+          "default": [],
+          "items": {
+            "type": "string"
+          }
+        },
         "sde.enableTracing.client": {
           "type": "boolean",
           "default": false,

src/clientMain.ts

@@ -18,10 +18,10 @@ import { SwiftConfigurationProvider } from './SwiftConfigurationProvider';
 const LENGTH_PKG_FILE_NAME: number = "Package.swift".length
 const PUBLISHER_NAME = "jinmingjian.sde"
 
-let swiftBinPath = null
-let swiftPackageManifestPath = null
-let skProtocolProcess = null
-let skProtocolProcessAsShellCmd = null
+let swiftBinPath: string | null = null
+let swiftPackageManifestPath: string | null = null
+let skProtocolProcess: string | null = null
+let skProtocolProcessAsShellCmd: string | null = null
 export let isTracingOn: boolean = false
 export let isLSPServerTracingOn: boolean = false
 export let diagnosticCollection: DiagnosticCollection
@@ -57,7 +57,8 @@ export function activate(context: ExtensionContext) {
 		initializationOptions: {
 			'isLSPServerTracingOn': isLSPServerTracingOn,
 			'skProtocolProcess': skProtocolProcess,
-			'skProtocolProcessAsShellCmd': skProtocolProcessAsShellCmd
+			'skProtocolProcessAsShellCmd': skProtocolProcessAsShellCmd,
+			'skCompilerOptions': workspace.getConfiguration().get('sde.sourcekit.compilerOptions')
 		},
 	}
 
@@ -90,7 +91,11 @@ export function activate(context: ExtensionContext) {
 	);
 	// build on save
 	workspace.onDidSaveTextDocument(
-		document => buildSPMPackage(),//FIXME filter to swift files
+		document => {
+			if (document.languageId === 'swift') {
+				buildSPMPackage()
+			}
+		},
 		null,
 		context.subscriptions
 	);
@@ -104,14 +109,9 @@ function initConfig() {
 
 	workspace.getConfiguration().update('editor.quickSuggestions', false, false)
 	workspace.getConfiguration().update('sde.buildOnSave', true, false)
-	// console.log('sde.enableTracing: '+workspace.getConfiguration().get('sde.enableTracing.client'))
 
 	isTracingOn = <boolean>workspace.getConfiguration().get('sde.enableTracing.client')
 	isLSPServerTracingOn = <boolean>workspace.getConfiguration().get('sde.enableTracing.LSPServer')
-	console.log('isTracingOn: ' + isTracingOn)
-	if (isTracingOn) {
-		//TODO
-	}
 	//FIXME rootPath may be undefined for adhoc file editing mode???
 	swiftPackageManifestPath = path.join(workspace.rootPath, "Package.swift");
 
@@ -126,7 +126,7 @@ function initBuildStatusItem() {
 }
 
 const frames = ['⠋', '⠙', '⠹', '⠸', '⠼', '⠴', '⠦', '⠧', '⠇', '⠏']
-let building = null
+let building: NodeJS.Timer | null = null
 
 function makeBuildStatusStarted() {
 	buildStatusItem.color = originalBuildStatusItemColor
@@ -165,9 +165,9 @@ function isSPMProject(): boolean {
 }
 
 
-export function trace(msg) {
+export function trace(...msg: any[]) {
 	if (isTracingOn) {
-		console.log(msg)
+		console.log(...msg)
 	}
 }
 

src/server/server.ts

@@ -94,6 +94,7 @@ connection.onInitialize((params: InitializeParams, cancellationToken): Initializ
 	isTracingOn = params.initializationOptions.isLSPServerTracingOn
 	skProtocolPath = params.initializationOptions.skProtocolProcess
 	skProtocolProcessAsShellCmd = params.initializationOptions.skProtocolProcessAsShellCmd
+	skCompilerOptions = params.initializationOptions.skCompilerOptions
 	trace("-->onInitialize ", `isTracingOn=[${isTracingOn}],
 	skProtocolProcess=[${skProtocolPath}],skProtocolProcessAsShellCmd=[${skProtocolProcessAsShellCmd}]`)
 	workspaceRoot = params.rootPath
@@ -134,6 +135,7 @@ export let maxBytesAllowedForCodeCompletionResponse: number = 0;
 //internal
 export let skProtocolPath = null
 export let skProtocolProcessAsShellCmd = false
+export let skCompilerOptions: string[] = []
 let maxNumProblems = null
 let shellPath = null
 // The settings have changed. Is send on server activation
@@ -519,11 +521,18 @@ export function loadArgsImportPaths(): string[] {
 		//FIXME system paths can not be available automatically?
 		// rt += " -I"+"/usr/lib/swift/linux/x86_64"
 		argsImportPaths.push("-sdk")
-		argsImportPaths.push("/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.13.sdk")
+		argsImportPaths.push("/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk")
+		argsImportPaths.push("-sdk")
+		argsImportPaths.push("/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk")
+		argsImportPaths.push("-sdk")
+		argsImportPaths.push("/Applications/Xcode.app/Contents/Developer/Platforms/WatchOS.platform/Developer/SDKs/WatchOS.sdk")
+		argsImportPaths.push("-sdk")
+		argsImportPaths.push("/Applications/Xcode.app/Contents/Developer/Platforms/AppleTVOS.platform/Developer/SDKs/AppleTVOS.sdk")
 		argsImportPaths.push("-I")
 		argsImportPaths.push("/System/Library/Frameworks/")
 		argsImportPaths.push("-I")
 		argsImportPaths.push("/usr/lib/swift/pm/")
+		argsImportPaths.push(...skCompilerOptions)
 		return argsImportPaths
 	} else {
 		return argsImportPaths

src/server/sourcekites.ts

@@ -172,7 +172,7 @@ function request(
     offset: number): Promise<any> {
 
     const sourcePaths = server.getAllSourcePaths(srcPath)
-    const compilerargs = JSON.stringify((sourcePaths ? sourcePaths : [srcPath])
+    const compilerargs = JSON.stringify(sourcePaths || [srcPath]
         .concat(server.loadArgsImportPaths())
     )
     srcText = JSON.stringify(srcText)