Merge pull request #960 from mcecode/vscode-upkeep

VS Code Extension Updates

Author: elijah-potter

packages/vscode-plugin/src/extension.ts

@@ -4,7 +4,7 @@ import type { Executable, LanguageClientOptions } from 'vscode-languageclient/no
 import { Uri, commands, window, workspace } from 'vscode';
 import { LanguageClient, ResponseError, TransportKind } from 'vscode-languageclient/node';
 
-// There's no publicly available extension manifest type except for the internal one from VSCode's
+// There's no publicly available extension manifest type except for the internal one from VS Code's
 // codebase. So, we declare our own with only the fields we need and have. See:
 // https://stackoverflow.com/a/78536803
 type ExtensionManifest = {
@@ -14,7 +14,42 @@ type ExtensionManifest = {
 
 let client: LanguageClient | undefined;
 const serverOptions: Executable = { command: '', transport: TransportKind.stdio };
-const clientOptions: LanguageClientOptions = {};
+const clientOptions: LanguageClientOptions = {
+	middleware: {
+		workspace: {
+			async configuration(params, token, next) {
+				const response = await next(params, token);
+
+				if (response instanceof ResponseError) {
+					return response;
+				}
+
+				return [{ 'harper-ls': response[0].harper }];
+			},
+		},
+		executeCommand(command, args, next) {
+			if (
+				['HarperAddToUserDict', 'HarperAddToFileDict'].includes(command) &&
+				args.find((a) => typeof a === 'string' && a.startsWith('untitled:'))
+			) {
+				window
+					.showInformationMessage(
+						'Save the file to add words to the dictionary.',
+						'Save File',
+						'Dismiss',
+					)
+					.then((selected) => {
+						if (selected === 'Save File') {
+							commands.executeCommand('workbench.action.files.save');
+						}
+					});
+				return;
+			}
+
+			next(command, args);
+		},
+	},
+};
 
 export async function activate(context: ExtensionContext): Promise<void> {
 	serverOptions.command = getExecutablePath(context);
@@ -96,19 +131,6 @@ async function startLanguageServer(): Promise<void> {
 
 	try {
 		client = new LanguageClient('harper', 'Harper', serverOptions, clientOptions);
-
-		client.middleware.workspace = {
-			async configuration(params, token, next) {
-				const response = await next(params, token);
-
-				if (response instanceof ResponseError) {
-					return response;
-				}
-
-				return [{ 'harper-ls': response[0].harper }];
-			},
-		};
-
 		await client.start();
 	} catch (error) {
 		showError('Failed to start harper-ls', error);

packages/vscode-plugin/src/tests/fixtures/integration.md

@@ -1,3 +1,5 @@
 # Integration
 
 This sentence has grammar errorz, like this this one.
+
+On the other hand, you'll realise that this sentence doesn't have an error if you're using British English.

packages/vscode-plugin/src/tests/fixtures/integrationBritish.md

@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 
-# Errorz
 echo "Hello World!"
+# Errorz

packages/vscode-plugin/src/tests/fixtures/languages/shellscript

@@ -80,6 +80,19 @@ export function createRange(
 	return new Range(new Position(startRow, startColumn), new Position(endRow, endColumn));
 }
 
-export function sleep(duration: number): Promise<void> {
+// The numbers used in these functions are what works when running tests in GitHub CI.
+export async function waitForHarperToActivate() {
+	await sleep(500);
+}
+export async function waitForUpdatesFromOpenedFile() {
+	await sleep(75);
+}
+export async function waitForUpdatesFromConfigChange() {
+	await sleep(300);
+}
+export async function waitForUpdatesFromDeletedFile() {
+	await sleep(450);
+}
+function sleep(duration: number): Promise<void> {
 	return new Promise((resolve) => setTimeout(resolve, duration));
 }

packages/vscode-plugin/src/tests/suite/helper.ts

@@ -1,6 +1,6 @@
-import type { Extension } from 'vscode';
+import type { Extension, Uri } from 'vscode';
 
-import { ConfigurationTarget, type Uri, commands, workspace } from 'vscode';
+import { ConfigurationTarget, commands, workspace } from 'vscode';
 
 import {
 	activateHarper,
@@ -12,7 +12,10 @@ import {
 	openFile,
 	openUntitled,
 	setTextDocumentLanguage,
-	sleep,
+	waitForHarperToActivate,
+	waitForUpdatesFromConfigChange,
+	waitForUpdatesFromDeletedFile,
+	waitForUpdatesFromOpenedFile,
 } from './helper';
 
 describe('Integration >', () => {
@@ -22,10 +25,8 @@ describe('Integration >', () => {
 	beforeAll(async () => {
 		await closeAll();
 		harper = await activateHarper();
-		// Open test file so diagnostics can occur
 		markdownUri = await openFile('integration.md');
-		// Wait for `harper-ls` to start
-		await sleep(500);
+		await waitForHarperToActivate();
 	});
 
 	it('runs', () => {
@@ -44,15 +45,17 @@ describe('Integration >', () => {
 					message: 'Did you mean to spell “errorz” this way?',
 					range: createRange(2, 26, 2, 32),
 				},
+				{
+					message: 'Did you mean to spell “realise” this way?',
+					range: createRange(4, 26, 4, 33),
+				},
 			),
 		);
 	});
 
 	it('gives correct diagnostics for untitled', async () => {
 		const untitledUri = await openUntitled('Errorz');
-
-		// Wait for `harper-ls` to send diagnostics
-		await sleep(500);
+		await waitForUpdatesFromOpenedFile();
 
 		compareActualVsExpectedDiagnostics(
 			getActualDiagnostics(untitledUri),
@@ -68,7 +71,7 @@ describe('Integration >', () => {
 		await setTextDocumentLanguage(untitledUri, 'plaintext');
 
 		// Wait for `harper-ls` to send diagnostics
-		await sleep(500);
+		await waitForUpdatesFromConfigChange();
 
 		compareActualVsExpectedDiagnostics(
 			getActualDiagnostics(untitledUri),
@@ -87,7 +90,7 @@ describe('Integration >', () => {
 		await setTextDocumentLanguage(untitledUri, 'shellscript');
 
 		// Wait for `harper-ls` to send diagnostics
-		await sleep(500);
+		await waitForUpdatesFromConfigChange();
 
 		compareActualVsExpectedDiagnostics(
 			getActualDiagnostics(untitledUri),
@@ -101,29 +104,56 @@ describe('Integration >', () => {
 	it('updates diagnostics on configuration change', async () => {
 		const config = workspace.getConfiguration('harper.linters');
 		await config.update('RepeatedWords', false, ConfigurationTarget.Workspace);
-		// Wait for `harper-ls` to update diagnostics
-		await sleep(300);
+		await waitForUpdatesFromConfigChange();
 
 		compareActualVsExpectedDiagnostics(
 			getActualDiagnostics(markdownUri),
-			createExpectedDiagnostics({
-				message: 'Did you mean to spell “errorz” this way?',
-				range: createRange(2, 26, 2, 32),
-			}),
+			createExpectedDiagnostics(
+				{
+					message: 'Did you mean to spell “errorz” this way?',
+					range: createRange(2, 26, 2, 32),
+				},
+				{
+					message: 'Did you mean to spell “realise” this way?',
+					range: createRange(4, 26, 4, 33),
+				},
+			),
 		);
 
 		// Set config back to default value
 		await config.update('RepeatedWords', true, ConfigurationTarget.Workspace);
 	});
 
+	it('accepts British spellings when dialect is set to British', async () => {
+		const config = workspace.getConfiguration('harper');
+		await config.update('dialect', 'British', ConfigurationTarget.Workspace);
+		await waitForUpdatesFromConfigChange();
+
+		compareActualVsExpectedDiagnostics(
+			getActualDiagnostics(markdownUri),
+			createExpectedDiagnostics(
+				{
+					message: 'Did you mean to repeat this word?',
+					range: createRange(2, 39, 2, 48),
+				},
+				{
+					message: 'Did you mean to spell “errorz” this way?',
+					range: createRange(2, 26, 2, 32),
+				},
+			),
+		);
+
+		// Set config back to default value
+		await config.update('dialect', 'American', ConfigurationTarget.Workspace);
+	});
+
 	it('updates diagnostics when files are deleted', async () => {
 		const markdownContent = await workspace.fs.readFile(markdownUri);
 
-		// Delete file through VSCode
+		// Delete file through VS Code
 		await commands.executeCommand('workbench.files.action.showActiveFileInExplorer');
 		await commands.executeCommand('deleteFile');
-		// Wait for `harper-ls` to update diagnostics
-		await sleep(450);
+		await waitForUpdatesFromDeletedFile();
 
 		compareActualVsExpectedDiagnostics(
 			getActualDiagnostics(markdownUri),
@@ -133,13 +163,11 @@ describe('Integration >', () => {
 		// Restore and reopen deleted file
 		await workspace.fs.writeFile(markdownUri, markdownContent);
 		await openFile('integration.md');
-		// Wait for `harper-ls` to update diagnostics
-		await sleep(75);
+		await waitForUpdatesFromOpenedFile();
 
 		// Delete file directly
 		await workspace.fs.delete(markdownUri);
-		// Wait for `harper-ls` to update diagnostics
-		await sleep(450);
+		await waitForUpdatesFromDeletedFile();
 
 		compareActualVsExpectedDiagnostics(
 			getActualDiagnostics(markdownUri),

packages/vscode-plugin/src/tests/suite/integration.test.ts

@@ -1,27 +1,21 @@
 import {
-	activateHarper,
 	compareActualVsExpectedDiagnostics,
 	createExpectedDiagnostics,
 	createRange,
 	getActualDiagnostics,
 	openFile,
-	sleep,
+	waitForUpdatesFromOpenedFile,
 } from './helper';
 
 describe('Languages >', () => {
-	beforeAll(async () => {
-		await activateHarper();
-		// Wait for `harper-ls` to start
-		await sleep(500);
-	});
+	// NOTE: There's no need to activate Harper here since it was already activated in
+	// `integration.test.ts`, which runs first.
 
 	[
 		// Uncomment when #265 is fixed.
 		// { type: 'JavaScript JSX', file: 'javascriptreact.jsx', row: 1, column: 36 },
-		// Uncomment when #65 is fixed.
-		// { type: 'Shellscript without extension', file: 'shellscript', row: 2, column: 2 },
 
-		// VSCode doesn't support CMake, Haskell, Literate Haskell, Nix, TOML, and Typst files out of
+		// VS Code doesn't support CMake, Haskell, Literate Haskell, Nix, TOML, and Typst files out of
 		// the box. Uncomment when you figure out how to support them during testing.
 		// { type: 'CMake', file: 'CMakeLists.txt', row: 2, column: 30 },
 		// { type: 'Haskell', file: 'haskell.hs', row: 1, column: 3 },
@@ -47,6 +41,7 @@ describe('Languages >', () => {
 		{ type: 'Python', file: 'python.py', row: 1, column: 2 },
 		{ type: 'Ruby', file: 'ruby.rb', row: 3, column: 16 },
 		{ type: 'Rust', file: 'rust.rs', row: 0, column: 4 },
+		{ type: 'Shellscript without extension', file: 'shellscript', row: 3, column: 2 },
 		{ type: 'Shellscript with .bash extension', file: 'shellscript.bash', row: 7, column: 9 },
 		{ type: 'Shellscript with .sh extension', file: 'shellscript.sh', row: 0, column: 22 },
 		{ type: 'Swift', file: 'swift.swift', row: 9, column: 26 },
@@ -55,9 +50,7 @@ describe('Languages >', () => {
 	].forEach((testCase) => {
 		it(`gives correct diagnostics for ${testCase.type} files`, async () => {
 			const uri = await openFile('languages', testCase.file);
-
-			// Wait for `harper-ls` to send diagnostics
-			await sleep(75);
+			await waitForUpdatesFromOpenedFile();
 
 			compareActualVsExpectedDiagnostics(
 				getActualDiagnostics(uri),