harper.js 0.20.0 → 0.22.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "harper.js",
-	"version": "0.20.0",
+	"version": "0.22.1",
 	"license": "Apache-2.0",
 	"author": "Elijah Potter",
 	"description": "The grammar checker for developers.",
@@ -17,7 +17,7 @@
 	"scripts": {
 		"dev": "vite",
 		"build": "tsc && vite build",
-		"test": "vitest run --browser chromium && vitest run --browser firefox"
+		"test": "vitest run --browser chromium"
 	},
 	"devDependencies": {
 		"@microsoft/api-documenter": "^7.26.5",

package/src/Linter.test.ts

@@ -169,6 +169,20 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 		expect(firstLints.length).toBeGreaterThan(secondLints.length);
 		expect(secondLints.length).toBe(0);
 	});
+
+	test(`${linterName} can add words to the dictionary`, async () => {
+		const source = 'asdf is not a word';
+
+		const linter = new Linter();
+		let lints = await linter.lint(source);
+
+		expect(lints).toHaveLength(1);
+
+		await linter.importWords(['asdf']);
+		lints = await linter.lint(source);
+
+		expect(lints).toHaveLength(0);
+	});
 }
 
 test('Linters have the same config format', async () => {

package/src/Linter.ts

@@ -63,4 +63,11 @@ export default interface Linter {
 
 	/** Clear records of all previously ignored lints. */
 	clearIgnoredLints(): Promise<void>;
+
+	/** Import words into the dictionary. This is a significant operation, so try to batch words. */
+	importWords(words: string[]): Promise<void>;
+
+	/** Export all added words from the dictionary. Note that this will NOT export anything from the curated dictionary,
+	 * only words from previous calls to `this.importWords`. */
+	exportWords(): Promise<string[]>;
 }

package/src/LocalLinter.ts

@@ -124,4 +124,16 @@ export default class LocalLinter implements Linter {
 
 		return this.inner!.clear_ignored_lints();
 	}
+
+	async importWords(words: string[]): Promise<void> {
+		await this.initialize();
+
+		return this.inner!.import_words(words);
+	}
+
+	async exportWords(): Promise<string[]> {
+		await this.initialize();
+
+		return this.inner!.export_words();
+	}
 }

package/src/WorkerLinter/index.ts

@@ -129,6 +129,14 @@ export default class WorkerLinter implements Linter {
 		return this.rpc('clearIgnoredLints', []);
 	}
 
+	async importWords(words: string[]): Promise<void> {
+		return this.rpc('importWords', [words]);
+	}
+
+	async exportWords(): Promise<string[]> {
+		return this.rpc('exportWords', []);
+	}
+
 	/** Run a procedure on the remote worker. */
 	private async rpc(procName: string, args: any[]): Promise<any> {
 		const promise = new Promise((resolve, reject) => {