harper.js 0.14.0 → 0.16.0

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.49.1"
+    }
+  ]
+}

package/docs.sh

@@ -0,0 +1,24 @@
+#! /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
+  sed -i 's/"\(.*\).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/{index.cjs → index.js}

@@ -1,4 +1,4 @@
-let harper = require('harper.js');
+import * as harper from 'harper.js';
 
 async function main() {
 	// We cannot use `WorkerLinter` on Node.js since it relies on web-specific APIs.

package/examples/commonjs-simple/package.json

@@ -3,9 +3,9 @@
 	"version": "0.0.1",
 	"private": true,
 	"scripts": {
-		"start": "node index.cjs"
+		"start": "node index.js"
 	},
 	"dependencies": {
-		"harper.js": "^0.13.0"
+		"harper.js": "^0.14.0"
 	}
 }

package/examples/commonjs-simple/yarn.lock

@@ -2,13 +2,7 @@
 # yarn lockfile v1
 
 
-harper.js@^0.13.0:
-  version "0.13.0"
-  resolved "https://registry.yarnpkg.com/harper.js/-/harper.js-0.13.0.tgz#f9e945c842f4e07e1b7042e3eef00a8040b2e0dd"
-  integrity sha512-XjiQG7kpooKCU2xp46mvNra9PUq5n3z5kXOaWvKjOBRyWIllvuEwvDv40cEUODhWD2ABVTEMea8odXRORfyruw==
-  dependencies:
-    wasm "link:../../../../../../.cache/yarn/v6/npm-harper-js-0.13.0-f9e945c842f4e07e1b7042e3eef00a8040b2e0dd-integrity/harper-wasm/pkg"
-
-"wasm@link:../../../../../../.cache/yarn/v6/npm-harper-js-0.13.0-f9e945c842f4e07e1b7042e3eef00a8040b2e0dd-integrity/harper-wasm/pkg":
-  version "0.0.0"
-  uid ""
+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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "harper.js",
-	"version": "0.14.0",
+	"version": "0.16.0",
 	"license": "Apache-2.0",
 	"author": "Elijah Potter",
 	"description": "The grammar checker for developers.",
@@ -17,17 +17,19 @@
 	"scripts": {
 		"dev": "vite",
 		"build": "tsc && vite build",
-		"test": "vitest run --browser firefox && vitest run --browser chromium"
+		"test": "vitest run --browser chromium && vitest run --browser firefox"
 	},
 	"devDependencies": {
-		"wasm": "link:../../harper-wasm/pkg",
+		"@microsoft/api-documenter": "^7.26.5",
+		"@microsoft/api-extractor": "^7.49.1",
 		"@vitest/browser": "^2.1.8",
 		"playwright": "^1.49.1",
 		"typescript": "~5.6.2",
 		"vite": "^5.1.8",
-		"vite-plugin-dts": "^4.3.0",
+		"vite-plugin-dts": "^4.5.0",
 		"vite-plugin-virtual": "^0.3.0",
-		"vitest": "^2.1.8"
+		"vitest": "^2.1.8",
+		"wasm": "link:../../harper-wasm/pkg"
 	},
 	"main": "dist/harper.js",
 	"types": "dist/harper.d.ts"

package/src/Linter.ts

@@ -1,5 +1,5 @@
 import type { Lint, Span, Suggestion } from 'wasm';
-import { LintConfig } from './main';
+import { LintConfig, LintOptions } from './main';
 
 /** An interface for an object that can perform linting actions. */
 export default interface Linter {
@@ -9,7 +9,7 @@ export default interface Linter {
 	setup(): Promise<void>;
 
 	/** Lint the provided text. */
-	lint(text: string): Promise<Lint[]>;
+	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>;

package/src/LocalLinter.ts

@@ -1,9 +1,10 @@
 import type { Lint, Span, Suggestion, Linter as WasmLinter } from 'wasm';
+import { Language } from 'wasm';
 import Linter from './Linter';
 import loadWasm from './loadWasm';
-import { LintConfig } from './main';
+import { LintConfig, LintOptions } from './main';
 
-/** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop). */
+/** 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;
 
@@ -18,15 +19,15 @@ export default class LocalLinter implements Linter {
 
 	async setup(): Promise<void> {
 		await this.initialize();
-		this.inner!.lint('');
+		this.inner!.lint('', Language.Plain);
 	}
 
-	async lint(text: string): Promise<Lint[]> {
+	async lint(text: string, options?: LintOptions): Promise<Lint[]> {
 		await this.initialize();
-		let lints = this.inner!.lint(text);
-
-		// We only want to show fixable errors.
-		lints = lints.filter((lint) => lint.suggestion_count() > 0);
+		const lints = this.inner!.lint(
+			text,
+			options?.language === 'plaintext' ? Language.Plain : Language.Markdown
+		);
 
 		return lints;
 	}

package/src/WorkerLinter/index.ts

@@ -3,7 +3,7 @@ import type { Lint, Suggestion, Span } from 'wasm';
 import Linter from '../Linter';
 import Worker from './worker.js?worker&inline';
 import { getWasmUri } from '../loadWasm';
-import { LintConfig } from '../main';
+import { LintConfig, LintOptions } from '../main';
 
 /** The data necessary to complete a request once the worker has responded. */
 type RequestItem = {
@@ -15,8 +15,7 @@ type RequestItem = {
 /** A Linter that spins up a dedicated web worker to do processing on a separate thread.
  * Main benefit: this Linter will not block the event loop for large documents.
  *
- * NOTE: This class will not work properly in Node. In that case, just use `LocalLinter`.
- * Also requires top-level await to work. */
+ * NOTE: This class will not work properly in Node. In that case, just use `LocalLinter`. */
 export default class WorkerLinter implements Linter {
 	private worker;
 	private requestQueue: RequestItem[];
@@ -62,8 +61,8 @@ export default class WorkerLinter implements Linter {
 		return this.rpc('setup', []);
 	}
 
-	lint(text: string): Promise<Lint[]> {
-		return this.rpc('lint', [text]);
+	lint(text: string, options?: LintOptions): Promise<Lint[]> {
+		return this.rpc('lint', [text, options]);
 	}
 
 	applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string> {

package/src/main.ts

@@ -1,14 +1,18 @@
 import type { Lint, Span, Suggestion } from 'wasm';
+import { SuggestionKind } from 'wasm';
 import Linter from './Linter';
 import LocalLinter from './LocalLinter';
 import WorkerLinter from './WorkerLinter';
 
-export { LocalLinter, WorkerLinter };
+export { LocalLinter, WorkerLinter, SuggestionKind };
 export type { Linter, Lint, Span, Suggestion };
 
-export enum SuggestionKind {
-	Replace = 0,
-	Remove = 1
-}
-
+/** A linting rule configuration dependent on upstream Harper's available rules.
+ * This is a record, since you shouldn't hard-code the existence of any particular rules and should generalize based on this struct. */
 export type LintConfig = Record<string, boolean | undefined>;
+
+/** The option used to configure the parser for an individual linting operation. */
+export type LintOptions = {
+	/** The markup language that is being passed. Defaults to `markdown`. */
+	language?: 'plaintext' | 'markdown';
+};

package/tsconfig.json

@@ -16,7 +16,10 @@
 		"noUnusedLocals": true,
 		"noUnusedParameters": true,
 		"noFallthroughCasesInSwitch": true,
-		"types": ["vite/client"]
+		"types": ["vite/client"],
+		"paths": {
+			"wasm": ["../../harper-wasm/pkg"]
+		}
 	},
 	"include": ["src"]
 }

package/vite.config.js

@@ -2,6 +2,12 @@ import { resolve } from 'path';
 import dts from 'vite-plugin-dts';
 import { defineConfig } from 'vite';
 import virtual from 'vite-plugin-virtual';
+import fs from 'fs';
+
+function fileAsObject(path) {
+	let content = fs.readFileSync(path);
+	return JSON.parse(content);
+}
 
 export default defineConfig({
 	build: {
@@ -19,7 +25,11 @@ export default defineConfig({
 	},
 	base: './',
 	plugins: [
-		dts({ rollupTypes: true, tsconfigPath: './tsconfig.json' }),
+		dts({
+			...fileAsObject('./api-extractor.json'),
+			rollupTypes: true,
+			tsconfigPath: './tsconfig.json'
+		}),
 		virtual({
 			'virtual:wasm': `import wasmUri from 'wasm/harper_wasm_bg.wasm?inline'; export default wasmUri`
 		})

package/src/main.test.ts

@@ -1,8 +0,0 @@
-import { expect, test } from 'vitest';
-import { SuggestionKind as WasmSuggestionKind } from 'wasm';
-import { SuggestionKind } from './main';
-
-test('Wasm and JS SuggestionKinds agree', async () => {
-	expect(SuggestionKind.Remove).toBe(WasmSuggestionKind.Remove);
-	expect(SuggestionKind.Replace).toBe(WasmSuggestionKind.Replace);
-});