Enhance: support trigger install kcl-language-server by command (#28)

* enhance: add feedback and manually download url * support trigger install latest kcl-language-server from command palatte
kcl-lang · Aug 1, 2023 · 442a44b · 442a44b
1 parent 757cae8
commit 442a44b
Show file tree

Hide file tree

Showing 3 changed files with 222 additions and 197 deletions.
diff --git a/package.json b/package.json
@@ -68,6 +68,13 @@
                 "scopeName": "source.kcl",
                 "path": "./syntaxes/KCL.tmLanguage.json"
             }
+        ],
+        "commands": [
+            {
+                "command": "kcl.installLanguageServer",
+                "title": "Install KCL Language Server",
+                "category": "KCL"
+            }
         ]
     },
     "icon": "icon.png",

diff --git a/src/extension.ts b/src/extension.ts
@@ -15,186 +15,28 @@ import {
 let client: LanguageClient;
 
 export async function activate(context: vscode.ExtensionContext) {
-	const provider1 = vscode.languages.registerCompletionItemProvider('KCL', {
+	const autoCompletionProvider = vscode.languages.registerCompletionItemProvider('KCL', {
 		provideCompletionItems(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken, context: vscode.CompletionContext) {
-			// a completion item that inserts its text as snippet,
-			// the `insertText`-property is a `SnippetString` which will be
-			// honored by the editor.
-			const importAsCompletion = new vscode.CompletionItem('import as');
-			importAsCompletion.insertText = new vscode.SnippetString('import ${1} as ');
-
-			const mixinCompletion = new vscode.CompletionItem('mixin');
-			mixinCompletion.insertText = new vscode.SnippetString('mixin [\n    ${1}\n]');
-
-			const checkCompletion = new vscode.CompletionItem('check');
-			checkCompletion.insertText = new vscode.SnippetString('check:\n    ');
+			return autoCompletionItems();
+		}
+	});
 
-			const schemaCompletion = new vscode.CompletionItem('schema');
-			schemaCompletion.insertText = new vscode.SnippetString('schema ${1}:\n    ');
-			// schemaCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
-
-			const schemaRelaxedCompletion = new vscode.CompletionItem('schema relaxed');
-			schemaRelaxedCompletion.insertText = new vscode.SnippetString('schema relaxed ${1}:\n    ');
-			// schemaRelaxedCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
-
-			const strValueCompletion = new vscode.CompletionItem('str = ${value}');
-			strValueCompletion.insertText = new vscode.SnippetString('str = "${1}"');
-			// strValueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
-
-			const boolTrueCompletion = new vscode.CompletionItem('bool = True');
-			boolTrueCompletion.insertText = new vscode.SnippetString('bool = True\n');
-			// boolTrueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
-
-			const boolFalseCompletion = new vscode.CompletionItem('bool = False');
-			boolFalseCompletion.insertText = new vscode.SnippetString('bool = False\n');
-			// boolFalseCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
-
-			const intValueCompletion = new vscode.CompletionItem('int = ${value}');
-			intValueCompletion.insertText = new vscode.SnippetString('int = ${1}');
-			// intValueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
-
-			const floatValueCompletion = new vscode.CompletionItem('float = ${value}');
-			floatValueCompletion.insertText = new vscode.SnippetString('float = ${1}');
-			// floatValueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
-
-
-			// a completion item that retriggers IntelliSense when being accepted, Also, the `insertText` is set so that 
-			// a space is inserted after `import`
-			const importCompletion = new vscode.CompletionItem('import');
-			importCompletion.kind = vscode.CompletionItemKind.Keyword;
-			importCompletion.insertText = 'import ';
-
-			const assertCompletion = new vscode.CompletionItem('assert');
-			assertCompletion.kind = vscode.CompletionItemKind.Keyword;
-			assertCompletion.insertText = 'assert ';
-
-			const ifCompletion = new vscode.CompletionItem('if');
-			ifCompletion.kind = vscode.CompletionItemKind.Keyword;
-			ifCompletion.insertText = 'if ';
-
-			const finalCompletion = new vscode.CompletionItem('final');
-			finalCompletion.kind = vscode.CompletionItemKind.Keyword;
-			finalCompletion.insertText = 'final ';
-
-			const orCompletion = new vscode.CompletionItem('or');
-			orCompletion.kind = vscode.CompletionItemKind.Keyword;
-			orCompletion.insertText = 'or ';
-
-			const andCompletion = new vscode.CompletionItem('and');
-			andCompletion.kind = vscode.CompletionItemKind.Keyword;
-			andCompletion.insertText = 'and ';
-
-			const notCompletion = new vscode.CompletionItem('not');
-			notCompletion.kind = vscode.CompletionItemKind.Keyword;
-			notCompletion.insertText = 'not ';
-
-			const inCompletion = new vscode.CompletionItem('in');
-			inCompletion.kind = vscode.CompletionItemKind.Keyword;
-			inCompletion.insertText = 'in ';
-
-			const isCompletion = new vscode.CompletionItem('is');
-			isCompletion.kind = vscode.CompletionItemKind.Keyword;
-			isCompletion.insertText = 'is ';
-
-			const strCompletion = new vscode.CompletionItem('str');
-			strCompletion.kind = vscode.CompletionItemKind.Keyword;
-			strCompletion.insertText = 'str\n';
-
-			const boolCompletion = new vscode.CompletionItem('bool');
-			boolCompletion.kind = vscode.CompletionItemKind.Keyword;
-			boolCompletion.insertText = 'bool\n';
-
-			const floatCompletion = new vscode.CompletionItem('float');
-			floatCompletion.kind = vscode.CompletionItemKind.Keyword;
-			floatCompletion.insertText = 'str\n';
-
-			const intCompletion = new vscode.CompletionItem('int');
-			intCompletion.kind = vscode.CompletionItemKind.Keyword;
-			intCompletion.insertText = 'int\n';
-
-			const trueCompletion = new vscode.CompletionItem('True');
-			trueCompletion.kind = vscode.CompletionItemKind.Keyword;
-			trueCompletion.insertText = 'True';
-
-			const falseCompletion = new vscode.CompletionItem('False');
-			falseCompletion.kind = vscode.CompletionItemKind.Keyword;
-			falseCompletion.insertText = 'False';
-
-			const noneCompletion = new vscode.CompletionItem('None');
-			noneCompletion.kind = vscode.CompletionItemKind.Keyword;
-			noneCompletion.insertText = 'None';
-
-
-			// return all completion items as array
-			return [
-				importAsCompletion,
-				mixinCompletion,
-				checkCompletion,
-				schemaRelaxedCompletion,
-				strValueCompletion,
-				boolTrueCompletion,
-				boolFalseCompletion,
-				intValueCompletion,
-				floatValueCompletion,
-				importCompletion,
-				schemaCompletion,
-				assertCompletion,
-				ifCompletion,
-				finalCompletion,
-				orCompletion,
-				andCompletion,
-				notCompletion,
-				inCompletion,
-				isCompletion,
-				strCompletion,
-				boolCompletion,
-				floatCompletion,
-				intCompletion,
-				trueCompletion,
-				falseCompletion,
-				noneCompletion
-			];
+	const installLanguageServer = vscode.commands.registerCommand('kcl.installLanguageServer', async () => {
+		const language_server_path = await install.installLanguageServer(client);
+		if (language_server_path) {
+			startLanguageServerWith(language_server_path);
 		}
 	});
 
-	context.subscriptions.push(provider1);
+	context.subscriptions.push(autoCompletionProvider, installLanguageServer);
+
 	let language_server_path: string | undefined = install.kcl_rust_lsp_location();
 	if (!language_server_path) {
 		language_server_path = await install.promptInstallLanguageServer(client);
 	}
 
 	if (language_server_path) {
-		install.outputMsg(`Starting language server with ${language_server_path}`);
-		// start language server
-		const traceOutputChannel = vscode.window.createOutputChannel("KCL Language Server trace");
-		const run: Executable = {
-			command: language_server_path,
-			options: {
-				env: {
-					...process.env,
-					RUST_LOG: "debug",
-				},
-			},
-		};
-		const serverOptions: ServerOptions = {
-			run,
-			debug: run,
-		};
-		// If the extension is launched in debug mode then the debug server options are used
-		// Otherwise the run options are used
-		// Options to control the language client
-		const clientOptions: LanguageClientOptions = {
-			// Register the server for plain text documents
-			documentSelector: [{ scheme: "file", language: "KCL" }],
-			synchronize: {
-				fileEvents: vscode.workspace.createFileSystemWatcher("**/.k"),
-			},
-			traceOutputChannel,
-		};
-
-		client = new LanguageClient(install.KCL_LANGUAGE_SERVER, "kcl language server", serverOptions, clientOptions);
-		client.start();
-		install.outputMsg(`${install.KCL_LANGUAGE_SERVER} started!`);
+		startLanguageServerWith(language_server_path);
 	}
 }
 
@@ -203,4 +45,182 @@ export function deactivate(): Thenable<void> | undefined {
 		return undefined;
 	}
 	return client.stop();
+}
+
+function startLanguageServerWith(language_server_path: string) {
+	if (client) {
+		// stop the running client if exists
+		client.stop();
+	}
+	install.outputMsg(`Starting language server with ${language_server_path}`);
+	// start language server
+	const traceOutputChannel = vscode.window.createOutputChannel("KCL Language Server trace");
+	const run: Executable = {
+		command: language_server_path,
+		options: {
+			env: {
+				...process.env,
+				RUST_LOG: "debug",
+			},
+		},
+	};
+	const serverOptions: ServerOptions = {
+		run,
+		debug: run,
+	};
+	// If the extension is launched in debug mode then the debug server options are used
+	// Otherwise the run options are used
+	// Options to control the language client
+	const clientOptions: LanguageClientOptions = {
+		// Register the server for plain text documents
+		documentSelector: [{ scheme: "file", language: "KCL" }],
+		synchronize: {
+			fileEvents: vscode.workspace.createFileSystemWatcher("**/.k"),
+		},
+		traceOutputChannel,
+	};
+
+	client = new LanguageClient(install.KCL_LANGUAGE_SERVER, "kcl language server", serverOptions, clientOptions);
+	client.start();
+	install.outputMsg(`${install.KCL_LANGUAGE_SERVER} started!`);
+}
+
+function autoCompletionItems(): vscode.CompletionItem[] {
+	// a completion item that inserts its text as snippet,
+	// the `insertText`-property is a `SnippetString` which will be
+	// honored by the editor.
+	const importAsCompletion = new vscode.CompletionItem('import as');
+	importAsCompletion.insertText = new vscode.SnippetString('import ${1} as ');
+
+	const mixinCompletion = new vscode.CompletionItem('mixin');
+	mixinCompletion.insertText = new vscode.SnippetString('mixin [\n    ${1}\n]');
+
+	const checkCompletion = new vscode.CompletionItem('check');
+	checkCompletion.insertText = new vscode.SnippetString('check:\n    ');
+
+	const schemaCompletion = new vscode.CompletionItem('schema');
+	schemaCompletion.insertText = new vscode.SnippetString('schema ${1}:\n    ');
+	// schemaCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
+
+	const schemaRelaxedCompletion = new vscode.CompletionItem('schema relaxed');
+	schemaRelaxedCompletion.insertText = new vscode.SnippetString('schema relaxed ${1}:\n    ');
+	// schemaRelaxedCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
+
+	const strValueCompletion = new vscode.CompletionItem('str = ${value}');
+	strValueCompletion.insertText = new vscode.SnippetString('str = "${1}"');
+	// strValueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
+
+	const boolTrueCompletion = new vscode.CompletionItem('bool = True');
+	boolTrueCompletion.insertText = new vscode.SnippetString('bool = True\n');
+	// boolTrueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
+
+	const boolFalseCompletion = new vscode.CompletionItem('bool = False');
+	boolFalseCompletion.insertText = new vscode.SnippetString('bool = False\n');
+	// boolFalseCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
+
+	const intValueCompletion = new vscode.CompletionItem('int = ${value}');
+	intValueCompletion.insertText = new vscode.SnippetString('int = ${1}');
+	// intValueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
+
+	const floatValueCompletion = new vscode.CompletionItem('float = ${value}');
+	floatValueCompletion.insertText = new vscode.SnippetString('float = ${1}');
+	// floatValueCompletion.command = { command: 'editor.action.triggerSuggest', title: 'Re-trigger completions...' };
+
+
+	// a completion item that retriggers IntelliSense when being accepted, Also, the `insertText` is set so that 
+	// a space is inserted after `import`
+	const importCompletion = new vscode.CompletionItem('import');
+	importCompletion.kind = vscode.CompletionItemKind.Keyword;
+	importCompletion.insertText = 'import ';
+
+	const assertCompletion = new vscode.CompletionItem('assert');
+	assertCompletion.kind = vscode.CompletionItemKind.Keyword;
+	assertCompletion.insertText = 'assert ';
+
+	const ifCompletion = new vscode.CompletionItem('if');
+	ifCompletion.kind = vscode.CompletionItemKind.Keyword;
+	ifCompletion.insertText = 'if ';
+
+	const finalCompletion = new vscode.CompletionItem('final');
+	finalCompletion.kind = vscode.CompletionItemKind.Keyword;
+	finalCompletion.insertText = 'final ';
+
+	const orCompletion = new vscode.CompletionItem('or');
+	orCompletion.kind = vscode.CompletionItemKind.Keyword;
+	orCompletion.insertText = 'or ';
+
+	const andCompletion = new vscode.CompletionItem('and');
+	andCompletion.kind = vscode.CompletionItemKind.Keyword;
+	andCompletion.insertText = 'and ';
+
+	const notCompletion = new vscode.CompletionItem('not');
+	notCompletion.kind = vscode.CompletionItemKind.Keyword;
+	notCompletion.insertText = 'not ';
+
+	const inCompletion = new vscode.CompletionItem('in');
+	inCompletion.kind = vscode.CompletionItemKind.Keyword;
+	inCompletion.insertText = 'in ';
+
+	const isCompletion = new vscode.CompletionItem('is');
+	isCompletion.kind = vscode.CompletionItemKind.Keyword;
+	isCompletion.insertText = 'is ';
+
+	const strCompletion = new vscode.CompletionItem('str');
+	strCompletion.kind = vscode.CompletionItemKind.Keyword;
+	strCompletion.insertText = 'str\n';
+
+	const boolCompletion = new vscode.CompletionItem('bool');
+	boolCompletion.kind = vscode.CompletionItemKind.Keyword;
+	boolCompletion.insertText = 'bool\n';
+
+	const floatCompletion = new vscode.CompletionItem('float');
+	floatCompletion.kind = vscode.CompletionItemKind.Keyword;
+	floatCompletion.insertText = 'str\n';
+
+	const intCompletion = new vscode.CompletionItem('int');
+	intCompletion.kind = vscode.CompletionItemKind.Keyword;
+	intCompletion.insertText = 'int\n';
+
+	const trueCompletion = new vscode.CompletionItem('True');
+	trueCompletion.kind = vscode.CompletionItemKind.Keyword;
+	trueCompletion.insertText = 'True';
+
+	const falseCompletion = new vscode.CompletionItem('False');
+	falseCompletion.kind = vscode.CompletionItemKind.Keyword;
+	falseCompletion.insertText = 'False';
+
+	const noneCompletion = new vscode.CompletionItem('None');
+	noneCompletion.kind = vscode.CompletionItemKind.Keyword;
+	noneCompletion.insertText = 'None';
+
+
+	// return all completion items as array
+	return [
+		importAsCompletion,
+		mixinCompletion,
+		checkCompletion,
+		schemaRelaxedCompletion,
+		strValueCompletion,
+		boolTrueCompletion,
+		boolFalseCompletion,
+		intValueCompletion,
+		floatValueCompletion,
+		importCompletion,
+		schemaCompletion,
+		assertCompletion,
+		ifCompletion,
+		finalCompletion,
+		orCompletion,
+		andCompletion,
+		notCompletion,
+		inCompletion,
+		isCompletion,
+		strCompletion,
+		boolCompletion,
+		floatCompletion,
+		intCompletion,
+		trueCompletion,
+		falseCompletion,
+		noneCompletion
+	];
 }