harper.js 0.25.0 → 0.26.0

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.51.1"
+      "packageVersion": "7.52.1"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "harper.js",
-	"version": "0.25.0",
+	"version": "0.26.0",
 	"license": "Apache-2.0",
 	"author": "Elijah Potter",
 	"description": "The grammar checker for developers.",
@@ -17,20 +17,28 @@
 	"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",
 		"@microsoft/api-extractor": "^7.50.1",
 		"@vitest/browser": "^3.0.6",
 		"playwright": "^1.49.1",
-		"typescript": "~5.8.2",
+		"typescript": "catalog:",
 		"vite": "^6.1.0",
 		"vite-plugin-dts": "^4.5.0",
 		"vite-plugin-virtual": "^0.3.0",
 		"vitest": "^3.0.5",
-		"wasm": "link:../../harper-wasm/pkg"
+		"harper-wasm": "workspace:*",
+		"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"]
 }

package/api-extractor.json

@@ -1,20 +0,0 @@
-{
-	"mainEntryPointFilePath": "./dist/harper.d.ts",
-	"apiReport": {
-		"enabled": false
-	},
-	"docModel": {
-		"enabled": true
-	},
-	"dtsRollup": {
-		"enabled": false
-	},
-	"bundledPackages": ["wasm"],
-	"messages": {
-		"extractorMessageReporting": {
-			"ae-missing-release-tag": {
-				"logLevel": "none"
-			}
-		}
-	}
-}

package/docs.sh

@@ -1,24 +0,0 @@
-#! /bin/bash
-
-set -eo pipefail
-
-yarn run api-extractor run 
-yarn run api-documenter markdown -i temp
-
-rm -r html || true
-mkdir html || true
-
-echo Rendering HTML...
-
-for file in ./markdown/*.md
-do 
-  BASE=$(basename $file .md)
-  pandoc $file -o html/$BASE.html
-  perl -pi -e 's/"\K([^"]+)\.md(?=")/\1.html/g' html/$BASE.html
-
-  echo '<link rel="stylesheet" href="https://unpkg.com/mvp.css">' >> html/$BASE.html
-done
-
-rm -r ../web/static/docs/harperjs || true
-mkdir -p ../web/static/docs/harperjs || true
-mv -f html ../web/static/docs/harperjs/ref 

package/examples/commonjs-simple/README.md

@@ -1,11 +0,0 @@
-# `commonjs-simple`
-
-An example of using `harper.js` in a Node.js application.
-Read the source code in `index.cjs` to see what's going on.
-
-You can run it using Yarn:
-
-```
-yarn install
-yarn start
-```

package/examples/commonjs-simple/index.js

@@ -1,27 +0,0 @@
-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();
-
-	let 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:');
-
-	for (let lint of lints) {
-		console.log(' - ', lint.span().start, ':', lint.span().end, lint.message());
-
-		if (lint.suggestion_count() != 0) {
-			console.log('Suggestions:');
-
-			for (let sug of lint.suggestions()) {
-				console.log(
-					'\t - ',
-					sug.kind() == 1 ? 'Remove' : 'Replace with',
-					sug.get_replacement_text()
-				);
-			}
-		}
-	}
-}
-
-main();

package/examples/commonjs-simple/package.json

@@ -1,11 +0,0 @@
-{
-	"name": "commonjs-simple",
-	"version": "0.0.1",
-	"private": true,
-	"scripts": {
-		"start": "node index.js"
-	},
-	"dependencies": {
-		"harper.js": "^0.14.0"
-	}
-}

package/examples/commonjs-simple/yarn.lock

@@ -1,8 +0,0 @@
-# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
-# yarn lockfile v1
-
-
-harper.js@^0.14.0:
-  version "0.14.0"
-  resolved "https://registry.yarnpkg.com/harper.js/-/harper.js-0.14.0.tgz#16d511070d4474dca501d4de1c76f7849ec0accb"
-  integrity sha512-WRzop2PmFK2AZiqNMHHWDFIqFmS7DeoNVhyibyu7T6wuSe24E1Tunolz8ZzMPfcaKuBB2SY+yGbyTOyj+/QD8g==

package/examples/raw-web/README.md

@@ -1,4 +0,0 @@
-# `raw-web`
-
-An example of using `harper.js` in a raw HTML webpage.
-You can open it using [`microserver`](https://crates.io/crates/microserver):

package/examples/raw-web/index.html

@@ -1,55 +0,0 @@
-<!doctype html>
-<html lang="en">
-	<head>
-		<meta charset="utf-8" />
-		<script type="module">
-			// We can import `harper.js` using native ECMAScript syntax.
-			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.
-			let linter = new WorkerLinter();
-
-			// Every time the `<textarea/>` received an input, we process it and update our list.
-			async function onInput(e) {
-				let lints = await linter.lint(e.target.value);
-
-				let list = document.getElementById('errorlist');
-				// Clear previous results
-				list.innerHTML = '';
-
-				for (let lint of lints) {
-					let item = document.createElement('LI');
-					var text = document.createTextNode(lint.message());
-					item.appendChild(text);
-					list.appendChild(item);
-				}
-			}
-
-			let inputField = document.getElementById('maininput');
-			inputField.addEventListener('input', onInput);
-			onInput({ target: inputField });
-		</script>
-
-		<!--Make the page look good using SimpleCSS-->
-		<link rel="stylesheet" href="https://cdn.simplecss.org/simple.min.css" />
-	</head>
-
-	<body>
-		<h1>Demo</h1>
-
-		<p>
-			This page is a simple example of using <code>harper.js</code> on a plain HTML page with a CDN.
-			It isn't pretty, but it demonstrates the fundamentals of using Harper. Start typing in the
-			text box below to start getting suggestions right in your browser.
-		</p>
-
-		<!--This is an intentional mistake to highlight the technology.-->
-		<textarea id="maininput">This is an test</textarea>
-
-		<h2>Errors</h2>
-
-		<ul id="errorlist">
-			Loading...
-		</ul>
-	</body>
-</html>

package/src/Linter.bench.ts

@@ -1,31 +0,0 @@
-import { bench } from 'vitest';
-import LocalLinter from './LocalLinter';
-import WorkerLinter from './WorkerLinter';
-
-const linters = {
-	WorkerLinter: WorkerLinter,
-	LocalLinter: LocalLinter
-};
-
-for (const [linterName, Linter] of Object.entries(linters)) {
-	const linter = new Linter();
-
-	// Prime caches
-	linter.setup();
-
-	const defaultConfig = await linter.getDefaultLintConfig();
-	const emptyIgnoreState = await linter.exportIgnoredLints();
-
-	bench(`${linterName} set lint configuration`, async () => {
-		await linter.setLintConfig(defaultConfig);
-	});
-
-	bench(`${linterName} get lint configuration`, async () => {
-		await linter.getLintConfig();
-	});
-
-	bench(`${linterName} reset ignore state`, async () => {
-		await linter.clearIgnoredLints();
-		await linter.importIgnoredLints(emptyIgnoreState);
-	});
-}

package/src/Linter.test.ts

@@ -1,208 +0,0 @@
-import { expect, test } from 'vitest';
-import WorkerLinter from './WorkerLinter';
-import LocalLinter from './LocalLinter';
-
-const linters = {
-	WorkerLinter: WorkerLinter,
-	LocalLinter: LocalLinter
-};
-
-for (const [linterName, Linter] of Object.entries(linters)) {
-	test(`${linterName} detects repeated words`, async () => {
-		const linter = new Linter();
-
-		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 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);
-		}
-
-		expect(results[0].length).toBe(1);
-		expect(results[0][0].suggestions().length).toBe(1);
-		expect(results[1].length).toBe(0);
-		expect(results[2].length).toBe(1);
-	});
-
-	test(`${linterName} detects repeated words with concurrent requests`, async () => {
-		const linter = new Linter();
-
-		const promises = [
-			linter.lint('The problem is that that...'),
-			linter.lint('The problem is...'),
-			linter.lint('The the problem is...')
-		];
-
-		const results = await Promise.all(promises);
-
-		expect(results[0].length).toBe(1);
-		expect(results[0][0].suggestions().length).toBe(1);
-		expect(results[1].length).toBe(0);
-		expect(results[2].length).toBe(1);
-	});
-
-	test(`${linterName} detects lorem ipsum paragraph as not english`, async () => {
-		const linter = new Linter();
-
-		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.'
-		);
-
-		expect(result).toBeTypeOf('boolean');
-		expect(result).toBe(false);
-	});
-
-	test(`${linterName} can run setup without issues`, async () => {
-		const linter = new Linter();
-
-		await linter.setup();
-	});
-
-	test(`${linterName} contains configuration option for repetition`, async () => {
-		const linter = new Linter();
-
-		const lintConfig = await linter.getLintConfig();
-		expect(lintConfig).toHaveProperty('RepeatedWords');
-	});
-
-	test(`${linterName} can both get and set its configuration`, async () => {
-		const linter = new Linter();
-
-		let lintConfig = await linter.getLintConfig();
-
-		for (const key of Object.keys(lintConfig)) {
-			lintConfig[key] = true;
-		}
-
-		await linter.setLintConfig(lintConfig);
-		lintConfig = await linter.getLintConfig();
-
-		for (const key of Object.keys(lintConfig)) {
-			expect(lintConfig[key]).toBe(true);
-		}
-	});
-
-	test(`${linterName} can make things title case`, async () => {
-		const linter = new Linter();
-
-		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 descriptions = await linter.getLintDescriptions();
-
-		expect(descriptions).toBeTypeOf('object');
-	});
-
-	test(`${linterName} rule descriptions are not empty`, async () => {
-		const linter = new Linter();
-
-		const descriptions = await linter.getLintDescriptions();
-
-		for (const value of Object.values(descriptions)) {
-			expect(value).toBeTypeOf('string');
-			expect(value).not.toHaveLength(0);
-		}
-	});
-
-	test(`${linterName} default lint config has no null values`, async () => {
-		const linter = new Linter();
-
-		const lintConfig = await linter.getDefaultLintConfig();
-
-		for (const value of Object.values(lintConfig)) {
-			expect(value).not.toBeNull();
-		}
-	});
-
-	test(`${linterName} can ignore lints`, async () => {
-		const linter = new Linter();
-		const source = 'This is an test.';
-
-		const firstRound = await linter.lint(source);
-
-		expect(firstRound.length).toBeGreaterThanOrEqual(1);
-
-		await linter.ignoreLint(firstRound[0]);
-
-		const secondRound = await linter.lint(source);
-
-		expect(secondRound.length).toBeLessThan(firstRound.length);
-	});
-
-	test(`${linterName} can reimport ignored lints.`, async () => {
-		const source = 'This is an test of xporting lints.';
-
-		const firstLinter = new Linter();
-
-		const firstLints = await firstLinter.lint(source);
-
-		for (const lint of firstLints) {
-			await firstLinter.ignoreLint(lint);
-		}
-
-		const exported = await firstLinter.exportIgnoredLints();
-
-		/// Create a new instance and reimport the lints.
-		const secondLinter = new Linter();
-		await secondLinter.importIgnoredLints(exported);
-
-		const secondLints = await secondLinter.lint(source);
-
-		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(`${linterName} allows correct capitalization of "United States"`, async () => {
-		const linter = new Linter();
-		const lints = await linter.lint('The United States is a big country.');
-
-		expect(lints).toHaveLength(0);
-	});
-}
-
-test('Linters have the same config format', async () => {
-	const configs = [];
-
-	for (const Linter of Object.values(linters)) {
-		const linter = new Linter();
-
-		configs.push(await linter.getLintConfig());
-	}
-
-	for (const config of configs) {
-		expect(config).toEqual(configs[0]);
-		expect(config).toBeTypeOf('object');
-	}
-});

package/src/Linter.ts

@@ -1,73 +0,0 @@
-import type { Lint, Span, Suggestion } from 'wasm';
-import { LintConfig, LintOptions } from './main';
-
-/** An interface for an object that can perform linting actions. */
-export default interface Linter {
-	/** Complete any setup that is necessary before linting. This may include downloading and compiling the WebAssembly binary.
-	 * This setup will complete when needed regardless of whether you call this function.
-	 * This function exists to allow you to do this work when it is of least impact to the user experiences (i.e. while you're loading something else). */
-	setup(): Promise<void>;
-
-	/** Lint the provided text. */
-	lint(text: string, options?: LintOptions): Promise<Lint[]>;
-
-	/** Apply a suggestion to the given text, returning the transformed result. */
-	applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
-
-	/** Determine if the provided text is likely to be intended to be English.
-	 * The algorithm can be described as "proof of concept" and as such does not work terribly well.*/
-	isLikelyEnglish(text: string): Promise<boolean>;
-
-	/** Determine which parts of a given string are intended to be English, returning those bits.
-	 * The algorithm can be described as "proof of concept" and as such does not work terribly well.*/
-	isolateEnglish(text: string): Promise<string>;
-
-	/** Get the linter's current configuration. */
-	getLintConfig(): Promise<LintConfig>;
-
-	/** Get the default (unset) linter configuration as JSON.
-	 * This method does not effect the caller's lint configuration, nor does it return the current one. */
-	getDefaultLintConfigAsJSON(): Promise<string>;
-
-	/** Get the default (unset) linter configuration.
-	 * This method does not effect the caller's lint configuration, nor does it return the current one. */
-	getDefaultLintConfig(): Promise<LintConfig>;
-
-	/** Set the linter's current configuration. */
-	setLintConfig(config: LintConfig): Promise<void>;
-
-	/** Get the linter's current configuration as JSON. */
-	getLintConfigAsJSON(): Promise<string>;
-
-	/** Set the linter's current configuration from JSON. */
-	setLintConfigWithJSON(config: string): Promise<void>;
-
-	/** Get the linting rule descriptions as a JSON map. */
-	getLintDescriptionsAsJSON(): Promise<string>;
-
-	/** Get the linting rule descriptions as an object */
-	getLintDescriptions(): Promise<Record<string, string>>;
-
-	/** Convert a string to Chicago-style title case. */
-	toTitleCase(text: string): Promise<string>;
-
-	/** Ignore future instances of a lint from a previous linting run in future invocations. */
-	ignoreLint(lint: Lint): Promise<void>;
-
-	/** Export the ignored lints to a JSON list of privacy-respecting hashes. */
-	exportIgnoredLints(): Promise<string>;
-
-	/** Import ignored lints from a JSON list to the linter.
-	 * This function appends to the existing lints, if any. */
-	importIgnoredLints(json: string): Promise<void>;
-
-	/** 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

@@ -1,139 +0,0 @@
-import type { Lint, Span, Suggestion, Linter as WasmLinter } from 'wasm';
-import { Language } from 'wasm';
-import Linter from './Linter';
-import loadWasm from './loadWasm';
-import { LintConfig, LintOptions } from './main';
-
-/** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop).  */
-export default class LocalLinter implements Linter {
-	private inner: WasmLinter | undefined;
-
-	/** Initialize the WebAssembly and construct the inner Linter. */
-	private async initialize(): Promise<void> {
-		if (!this.inner) {
-			const wasm = await loadWasm();
-			wasm.setup();
-			this.inner = wasm.Linter.new();
-		}
-	}
-
-	async setup(): Promise<void> {
-		await this.initialize();
-		this.inner!.lint('', Language.Plain);
-
-		const exported = await this.exportIgnoredLints();
-		await this.importIgnoredLints(exported);
-	}
-
-	async lint(text: string, options?: LintOptions): Promise<Lint[]> {
-		await this.initialize();
-		const lints = this.inner!.lint(
-			text,
-			options?.language === 'plaintext' ? Language.Plain : Language.Markdown
-		);
-
-		return lints;
-	}
-
-	async applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string> {
-		const wasm = await loadWasm();
-		return wasm.apply_suggestion(text, span, suggestion);
-	}
-
-	async isLikelyEnglish(text: string): Promise<boolean> {
-		await this.initialize();
-		return this.inner!.is_likely_english(text);
-	}
-
-	async isolateEnglish(text: string): Promise<string> {
-		await this.initialize();
-		return this.inner!.isolate_english(text);
-	}
-
-	async getLintConfig(): Promise<LintConfig> {
-		await this.initialize();
-
-		return this.inner!.get_lint_config_as_object();
-	}
-
-	async getDefaultLintConfigAsJSON(): Promise<string> {
-		const wasm = await loadWasm();
-
-		return wasm.get_default_lint_config_as_json();
-	}
-
-	async getDefaultLintConfig(): Promise<LintConfig> {
-		const wasm = await loadWasm();
-
-		return wasm.get_default_lint_config();
-	}
-
-	async setLintConfig(config: LintConfig): Promise<void> {
-		await this.initialize();
-
-		this.inner!.set_lint_config_from_object(config);
-	}
-
-	async getLintConfigAsJSON(): Promise<string> {
-		await this.initialize();
-
-		return this.inner!.get_lint_config_as_json();
-	}
-
-	async setLintConfigWithJSON(config: string): Promise<void> {
-		await this.initialize();
-
-		this.inner!.set_lint_config_from_json(config);
-	}
-
-	async toTitleCase(text: string): Promise<string> {
-		const wasm = await loadWasm();
-		return wasm.to_title_case(text);
-	}
-
-	async getLintDescriptions(): Promise<Record<string, string>> {
-		await this.initialize();
-		return this.inner!.get_lint_descriptions_as_object();
-	}
-
-	async getLintDescriptionsAsJSON(): Promise<string> {
-		await this.initialize();
-		return this.inner!.get_lint_descriptions_as_json();
-	}
-
-	async ignoreLint(lint: Lint): Promise<void> {
-		await this.initialize();
-
-		this.inner!.ignore_lint(lint);
-	}
-
-	async exportIgnoredLints(): Promise<string> {
-		await this.initialize();
-
-		return this.inner!.export_ignored_lints();
-	}
-
-	async importIgnoredLints(json: string): Promise<void> {
-		await this.initialize();
-
-		return this.inner!.import_ignored_lints(json);
-	}
-
-	async clearIgnoredLints(): Promise<void> {
-		await this.initialize();
-
-		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();
-	}
-}