feat(harper.js): export both binary and inlinedBinary for different runtimes

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "packages/harper.js/node_modules/typescript/lib"
+}

packages/harper.js/api-extractor.json

@@ -9,11 +9,14 @@
 	"dtsRollup": {
 		"enabled": false
 	},
-	"bundledPackages": ["wasm"],
+	"bundledPackages": ["harper-wasm"],
 	"messages": {
 		"extractorMessageReporting": {
 			"ae-missing-release-tag": {
 				"logLevel": "none"
+			},
+			"ae-forgotten-export": {
+				"logLevel": "none"
 			}
 		}
 	}

packages/harper.js/examples/commonjs-simple/index.js

@@ -1,9 +1,9 @@
 async function main() {
 	const harper = await import('harper.js');
 	// We cannot use `WorkerLinter` on Node.js since it relies on web-specific APIs.
-	let linter = new harper.LocalLinter();
+	const linter = new harper.LocalLinter({ binary: harper.binary });
 
-	let lints = await linter.lint('This is a example of how to use `harper.js`.');
+	const lints = await linter.lint('This is a example of how to use `harper.js`.');
 
 	console.log('Here are the results of linting the above text:');
 

packages/harper.js/examples/commonjs-simple/package.json

@@ -6,6 +6,6 @@
 		"start": "node index.js"
 	},
 	"dependencies": {
-		"harper.js": "^0.14.0"
+		"harper.js": "*"
 	}
 }

packages/harper.js/examples/raw-web/index.html

@@ -4,6 +4,7 @@
 		<meta charset="utf-8" />
 		<script type="module">
 			// We can import `harper.js` using native ECMAScript syntax.
+			// TODO: Update to the latest version.
 			import { WorkerLinter } from 'https://unpkg.com/harper.js@0.13.0/dist/harper.js';
 
 			// Since we are working in the browser, we can use either `WorkerLinter`, which doesn't block the event loop, or `LocalLinter`, which does.

packages/harper.js/package.json

@@ -17,7 +17,10 @@
 	"scripts": {
 		"dev": "vite",
 		"build": "tsc && vite build",
-		"test": "vitest run --browser chromium"
+		"test": "vitest run",
+		"test:debug": "vitest run --browser.headless false --testTimeout 0",
+		"api:extractor": "api-extractor run",
+		"api:documenter": "api-documenter markdown -i temp"
 	},
 	"devDependencies": {
 		"@microsoft/api-documenter": "^7.26.10",
@@ -29,8 +32,15 @@
 		"vite-plugin-dts": "^4.5.0",
 		"vite-plugin-virtual": "^0.3.0",
 		"vitest": "^3.0.5",
-		"wasm": "link:../../harper-wasm/pkg"
+		"harper-wasm": "link:../../harper-wasm/pkg",
+		"type-fest": "^4.37.0",
+		"p-memoize": "^7.1.1",
+		"p-lazy": "^5.0.0"
 	},
 	"main": "dist/harper.js",
-	"types": "dist/harper.d.ts"
+	"types": "dist/harper.d.ts",
+	"sideEffects": false,
+	"files": [
+		"dist"
+	]
 }

packages/harper.js/src/Linter.bench.ts

@@ -1,14 +1,15 @@
 import { bench } from 'vitest';
 import LocalLinter from './LocalLinter';
 import WorkerLinter from './WorkerLinter';
+import { binary } from './binary';
 
 const linters = {
 	WorkerLinter: WorkerLinter,
 	LocalLinter: LocalLinter
 };
 
 for (const [linterName, Linter] of Object.entries(linters)) {
-	const linter = new Linter();
+	const linter = new Linter({ binary });
 
 	// Prime caches
 	linter.setup();

packages/harper.js/src/Linter.test.ts

@@ -1,6 +1,7 @@
 import { expect, test } from 'vitest';
 import WorkerLinter from './WorkerLinter';
 import LocalLinter from './LocalLinter';
+import { binary } from './binary';
 
 const linters = {
 	WorkerLinter: WorkerLinter,
@@ -9,27 +10,23 @@ const linters = {
 
 for (const [linterName, Linter] of Object.entries(linters)) {
 	test(`${linterName} detects repeated words`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const lints = await linter.lint('The the problem is...');
 
 		expect(lints.length).toBe(1);
 	});
 
 	test(`${linterName} detects repeated words with multiple synchronous requests`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const promises = [
 			linter.lint('The problem is that that...'),
 			linter.lint('The problem is...'),
 			linter.lint('The the problem is...')
 		];
 
-		const results = [];
-
-		for (const promise of promises) {
-			results.push(await promise);
-		}
+		const results = await Promise.all(promises);
 
 		expect(results[0].length).toBe(1);
 		expect(results[0][0].suggestions().length).toBe(1);
@@ -38,7 +35,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	});
 
 	test(`${linterName} detects repeated words with concurrent requests`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const promises = [
 			linter.lint('The problem is that that...'),
@@ -55,7 +52,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	});
 
 	test(`${linterName} detects lorem ipsum paragraph as not english`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const result = await linter.isLikelyEnglish(
 			'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.'
@@ -66,20 +63,20 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	});
 
 	test(`${linterName} can run setup without issues`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		await linter.setup();
 	});
 
 	test(`${linterName} contains configuration option for repetition`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const lintConfig = await linter.getLintConfig();
 		expect(lintConfig).toHaveProperty('RepeatedWords');
 	});
 
 	test(`${linterName} can both get and set its configuration`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		let lintConfig = await linter.getLintConfig();
 
@@ -96,23 +93,23 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	});
 
 	test(`${linterName} can make things title case`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const titleCase = await linter.toTitleCase('this is a test for making titles');
 
 		expect(titleCase).toBe('This Is a Test for Making Titles');
 	});
 
 	test(`${linterName} can get rule descriptions`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const descriptions = await linter.getLintDescriptions();
 
 		expect(descriptions).toBeTypeOf('object');
 	});
 
 	test(`${linterName} rule descriptions are not empty`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const descriptions = await linter.getLintDescriptions();
 
@@ -123,7 +120,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	});
 
 	test(`${linterName} default lint config has no null values`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 
 		const lintConfig = await linter.getDefaultLintConfig();
 
@@ -133,7 +130,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	});
 
 	test(`${linterName} can ignore lints`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 		const source = 'This is an test.';
 
 		const firstRound = await linter.lint(source);
@@ -150,7 +147,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	test(`${linterName} can reimport ignored lints.`, async () => {
 		const source = 'This is an test of xporting lints.';
 
-		const firstLinter = new Linter();
+		const firstLinter = new Linter({ binary });
 
 		const firstLints = await firstLinter.lint(source);
 
@@ -161,7 +158,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 		const exported = await firstLinter.exportIgnoredLints();
 
 		/// Create a new instance and reimport the lints.
-		const secondLinter = new Linter();
+		const secondLinter = new Linter({ binary });
 		await secondLinter.importIgnoredLints(exported);
 
 		const secondLints = await secondLinter.lint(source);
@@ -173,7 +170,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	test(`${linterName} can add words to the dictionary`, async () => {
 		const source = 'asdf is not a word';
 
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 		let lints = await linter.lint(source);
 
 		expect(lints).toHaveLength(1);
@@ -185,7 +182,7 @@ for (const [linterName, Linter] of Object.entries(linters)) {
 	});
 
 	test(`${linterName} allows correct capitalization of "United States"`, async () => {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
 		const lints = await linter.lint('The United States is a big country.');
 
 		expect(lints).toHaveLength(0);
@@ -196,12 +193,28 @@ test('Linters have the same config format', async () => {
 	const configs = [];
 
 	for (const Linter of Object.values(linters)) {
-		const linter = new Linter();
+		const linter = new Linter({ binary });
+
+		configs.push(await linter.getLintConfig());
+	}
+
+	for (const config of configs) {
+		expect(config).toEqual(configs[0]);
+		expect(config).toBeTypeOf('object');
+	}
+});
+
+test('Linters have the same JSON config format', async () => {
+	const configs = [];
+
+	for (const Linter of Object.values(linters)) {
+		const linter = new Linter({ binary });
 
 		configs.push(await linter.getLintConfig());
 	}
 
 	for (const config of configs) {
+		// The keys of stringified configs would be unstable, so we'll just check the object.
 		expect(config).toEqual(configs[0]);
 		expect(config).toBeTypeOf('object');
 	}

packages/harper.js/src/Linter.ts

@@ -1,5 +1,6 @@
-import type { Lint, Span, Suggestion } from 'wasm';
+import type { Lint, Span, Suggestion } from 'harper-wasm';
 import { LintConfig, LintOptions } from './main';
+import { BinaryModule } from './binary';
 
 /** An interface for an object that can perform linting actions. */
 export default interface Linter {
@@ -71,3 +72,8 @@ export default interface Linter {
 	 * only words from previous calls to `this.importWords`. */
 	exportWords(): Promise<string[]>;
 }
+
+export interface LinterInit {
+	/** The module or path to the WebAssembly binary. */
+	binary: BinaryModule;
+}