Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat(vscode-plugin): use bundled `harper-ls`

Matthew Espinod4436eb29d19
diff --git a/packages/vscode-plugin/.gitignore b/packages/vscode-plugin/.gitignore
index 990019d9a..91d7896ec 100644
--- a/packages/vscode-plugin/.gitignore
+++ b/packages/vscode-plugin/.gitignore
@@ -1,3 +1,4 @@
build
*.vsix
LICENSE
+bin
diff --git a/packages/vscode-plugin/.vscodeignore b/packages/vscode-plugin/.vscodeignore
index f481d31a9..b31acac47 100644
--- a/packages/vscode-plugin/.vscodeignore
+++ b/packages/vscode-plugin/.vscodeignore
@@ -3,3 +3,4 @@
!package.json
!LICENSE
!CHANGELOG.md
+!bin
diff --git a/packages/vscode-plugin/src/extension.ts b/packages/vscode-plugin/src/extension.ts
index 3ac44a745..402280487 100644
--- a/packages/vscode-plugin/src/extension.ts
+++ b/packages/vscode-plugin/src/extension.ts
@@ -1,50 +1,94 @@
-import {
- Executable,
- LanguageClient,
- LanguageClientOptions,
- TransportKind
-} from 'vscode-languageclient/node';
-
-let client: LanguageClient;
-
-export function activate() {
- const server: Executable = {
- command: 'harper-ls',
- transport: TransportKind.stdio
- };
-
- const clientOptions: LanguageClientOptions = {
- documentSelector: [
- { language: 'html' },
- { language: 'markdown' },
- { language: 'rust' },
- { language: 'typescriptreact' },
- { language: 'typescript' },
- { language: 'py' },
- { language: 'javascript' },
- { language: 'javascriptreact' },
- { language: 'go' },
- { language: 'c' },
- { language: 'cpp' },
- { language: 'ruby' },
- { language: 'swift' },
- { language: 'csharp' },
- { language: 'toml' },
- { language: 'lua' },
- { language: 'sh' },
- { language: 'java' }
- ]
- };
-
- // Create the language client and start the client.
- client = new LanguageClient('harper-ls', 'Harper', server, clientOptions);
-
- client.start();
+import type { ExtensionContext } from 'vscode';
+import type { Executable, LanguageClientOptions } from 'vscode-languageclient/node';
+
+import { Uri, window } from 'vscode';
+import { LanguageClient, TransportKind } from 'vscode-languageclient/node';
+
+let client: LanguageClient | undefined = undefined;
+const serverOptions: Executable = { command: '', transport: TransportKind.stdio };
+const clientOptions: LanguageClientOptions = {
+ documentSelector: [
+ { language: 'html' },
+ { language: 'markdown' },
+ { language: 'rust' },
+ { language: 'typescriptreact' },
+ { language: 'typescript' },
+ { language: 'py' },
+ { language: 'javascript' },
+ { language: 'javascriptreact' },
+ { language: 'go' },
+ { language: 'c' },
+ { language: 'cpp' },
+ { language: 'ruby' },
+ { language: 'swift' },
+ { language: 'csharp' },
+ { language: 'toml' },
+ { language: 'lua' },
+ { language: 'sh' },
+ { language: 'java' }
+ ]
+};
+
+export async function activate(context: ExtensionContext): Promise<void> {
+ serverOptions.command = Uri.joinPath(
+ context.extensionUri,
+ 'bin',
+ `harper-ls${process.platform === 'win32' ? '.exe' : ''}`
+ ).fsPath;
+
+ clientOptions.outputChannel = window.createOutputChannel('Harper');
+ context.subscriptions.push(clientOptions.outputChannel);
+
+ await startLanguageServer();
+}
+
+async function startLanguageServer(): Promise<void> {
+ if (client) {
+ if (client.diagnostics) {
+ client.diagnostics.clear();
+ }
+
+ try {
+ await client.stop(2000);
+ } catch (error) {
+ showError('Failed to stop harper-ls', error);
+ return;
+ }
+ }
+
+ try {
+ client = new LanguageClient('harper', 'Harper', serverOptions, clientOptions);
+ await client.start();
+ } catch (error) {
+ showError('Failed to start harper-ls', error);
+ client = undefined;
+ }
+}
+
+function showError(message: string, error: Error | unknown): void {
+ let info = '';
+ if (error instanceof Error) {
+ info = error.stack ? error.stack : error.message;
+ }
+
+ window.showErrorMessage(message, 'Show Info', 'Dismiss').then((selected) => {
+ if (selected === 'Show Info') {
+ clientOptions.outputChannel?.appendLine('---');
+ clientOptions.outputChannel?.appendLine(message);
+ clientOptions.outputChannel?.appendLine(info);
+ clientOptions.outputChannel?.appendLine(
+ 'If the issue persists, please report at https://github.com/elijah-potter/harper/issues'
+ );
+ clientOptions.outputChannel?.appendLine('---');
+ clientOptions.outputChannel?.show();
+ }
+ });
}
export function deactivate(): Thenable<void> | undefined {
if (!client) {
return undefined;
}
+
return client.stop();
}