Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat: modify all the use cases

Asuka109e866b4a9714c
diff --git a/packages/harper.js/api-extractor.json b/packages/harper.js/api-extractor.json
index 9f9fbc444..5663c502e 100644
--- a/packages/harper.js/api-extractor.json
+++ b/packages/harper.js/api-extractor.json
@@ -9,7 +9,7 @@
"dtsRollup": {
"enabled": false
},
- "bundledPackages": ["wasm"],
+ "bundledPackages": ["harper-wasm"],
"messages": {
"extractorMessageReporting": {
"ae-missing-release-tag": {
diff --git a/packages/harper.js/examples/raw-web/index.html b/packages/harper.js/examples/raw-web/index.html
index f73e21f0b..87489a712 100644
--- a/packages/harper.js/examples/raw-web/index.html
+++ b/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/[email protected]/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.
diff --git a/packages/harper.js/package.json b/packages/harper.js/package.json
index e0f4ca8a3..d44b0ad62 100644
--- a/packages/harper.js/package.json
+++ b/packages/harper.js/package.json
@@ -20,16 +20,16 @@
"test": "vitest run --browser"
},
"devDependencies": {
- "@microsoft/api-documenter": "^7.26.5",
- "@microsoft/api-extractor": "^7.49.1",
+ "@microsoft/api-documenter": "^7.26.7",
+ "@microsoft/api-extractor": "^7.49.2",
"@vitest/browser": "^3.0.5",
"playwright": "^1.49.1",
- "typescript": "^5.7.3",
+ "typescript": "^5.7.2",
"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": "link:../../harper-wasm/pkg"
},
"main": "dist/harper.js",
"types": "dist/harper.d.ts",
diff --git a/packages/harper.js/src/Linter.ts b/packages/harper.js/src/Linter.ts
index 270ef286b..ab72124ff 100644
--- a/packages/harper.js/src/Linter.ts
+++ b/packages/harper.js/src/Linter.ts
@@ -1,4 +1,4 @@
-import type { Lint, Span, Suggestion, InitInput as BinaryInitInput } from 'wasm';
+import type { Lint, Span, Suggestion, InitInput as BinaryInitInput } from 'harper-wasm';
import { LintConfig, LintOptions } from './main';
/** An interface for an object that can perform linting actions. */
diff --git a/packages/harper.js/src/LocalLinter.ts b/packages/harper.js/src/LocalLinter.ts
index 984a87d06..f87e733d8 100644
--- a/packages/harper.js/src/LocalLinter.ts
+++ b/packages/harper.js/src/LocalLinter.ts
@@ -1,5 +1,5 @@
-import type { Lint, Span, Suggestion, Linter as WasmLinter } from 'wasm';
-import { Language } from 'wasm';
+import type { Lint, Span, Suggestion, Linter as WasmLinter } from 'harper-wasm';
+import { Language } from 'harper-wasm';
import Linter, { LinterInit } from './Linter';
import { LintConfig, LintOptions } from './main';
import { binary, BinaryInit, loadBinary } from './binary';
diff --git a/packages/harper.js/src/WorkerLinter/communication.test.ts b/packages/harper.js/src/WorkerLinter/communication.test.ts
index 3dbf7511f..b8299cb62 100644
--- a/packages/harper.js/src/WorkerLinter/communication.test.ts
+++ b/packages/harper.js/src/WorkerLinter/communication.test.ts
@@ -1,6 +1,6 @@
import { expect, test } from 'vitest';
import { deserializeArg, serializeArg } from './communication';
-import { Span } from 'wasm';
+import { Span } from 'harper-wasm';
import LocalLinter from '../LocalLinter';
import { binary } from '../binary';
diff --git a/packages/harper.js/src/WorkerLinter/index.ts b/packages/harper.js/src/WorkerLinter/index.ts
index dcce0712f..86b404808 100644
--- a/packages/harper.js/src/WorkerLinter/index.ts
+++ b/packages/harper.js/src/WorkerLinter/index.ts
@@ -1,5 +1,5 @@
import { DeserializedRequest, deserializeArg, serialize } from './communication';
-import type { Lint, Suggestion, Span } from 'wasm';
+import type { Lint, Suggestion, Span } from 'harper-wasm';
import Linter, { LinterInit } from '../Linter';
import Worker from './worker?worker&inline';
import { LintConfig, LintOptions } from '../main';
diff --git a/packages/harper.js/src/binary.ts b/packages/harper.js/src/binary.ts
index 4ebe92616..2160d3633 100644
--- a/packages/harper.js/src/binary.ts
+++ b/packages/harper.js/src/binary.ts
@@ -1,12 +1,13 @@
-import type { InitInput as BinaryInitInput } from 'wasm';
+import type { InitInput as BinaryInitInput } from 'harper-wasm';
+import * as wasm from 'harper-wasm';
export type BinaryInit = BinaryInitInput | Promise<BinaryInitInput>;
-export async function loadBinary(binary: BinaryInit) {
- const wasm = await import('wasm');
- await wasm.default({ module_or_path: binary });
- return wasm;
+export async function loadBinary(binary: BinaryInit): Promise<typeof wasm> {
+ const exports = await import('harper-wasm');
+ await exports.default({ module_or_path: binary });
+ return exports;
}
-export { default as binary } from 'wasm/harper_wasm_bg.wasm?url';
-export { default as inlinedBinary } from 'wasm/harper_wasm_bg.wasm?inline';
+export { default as binary } from 'harper-wasm/harper_wasm_bg.wasm?url';
+export { default as inlinedBinary } from 'harper-wasm/harper_wasm_bg.wasm?inline';
diff --git a/packages/harper.js/src/main.ts b/packages/harper.js/src/main.ts
index 3092c28e1..353be053d 100644
--- a/packages/harper.js/src/main.ts
+++ b/packages/harper.js/src/main.ts
@@ -1,4 +1,4 @@
-export { Lint, Span, Suggestion, SuggestionKind } from 'wasm';
+export { Lint, Span, Suggestion, SuggestionKind } from 'harper-wasm';
export { default as LocalLinter } from './LocalLinter';
export { default as WorkerLinter } from './WorkerLinter';
export type { default as Linter } from './Linter';
diff --git a/packages/harper.js/tsconfig.json b/packages/harper.js/tsconfig.json
index 4e216e7e3..5dad1a394 100644
--- a/packages/harper.js/tsconfig.json
+++ b/packages/harper.js/tsconfig.json
@@ -18,7 +18,7 @@
"noFallthroughCasesInSwitch": true,
"types": ["vite/client"],
"paths": {
- "wasm": ["../../harper-wasm/pkg"]
+ "harper-wasm": ["../../harper-wasm/pkg"]
}
},
"include": ["src"]
diff --git a/packages/harper.js/vite.config.js b/packages/harper.js/vite.config.js
index 9bf5ab888..1fa0af05f 100644
--- a/packages/harper.js/vite.config.js
+++ b/packages/harper.js/vite.config.js
@@ -23,7 +23,7 @@ export default defineConfig({
dts({
...require('./api-extractor.json'),
rollupTypes: true,
- tsconfigPath: './tsconfig.json'
+ tsconfigPath: './tsconfig.json',
}),
],
worker: {
diff --git a/packages/obsidian-plugin/src/index.ts b/packages/obsidian-plugin/src/index.ts
index ab2d23852..ad10eecab 100644
--- a/packages/obsidian-plugin/src/index.ts
+++ b/packages/obsidian-plugin/src/index.ts
@@ -1,7 +1,7 @@
import logoSvg from '../logo.svg';
import { Plugin, Menu, PluginManifest, App, Notice } from 'obsidian';
import { LintConfig, Linter, Suggestion } from 'harper.js';
-import { LocalLinter, SuggestionKind, WorkerLinter } from 'harper.js';
+import { LocalLinter, SuggestionKind, WorkerLinter, binary } from 'harper.js';
import { linter } from './lint';
import { Extension } from '@codemirror/state';
import { HarperSettingTab } from './HarperSettingTab';
@@ -28,7 +28,7 @@ export default class HarperPlugin extends Plugin {
constructor(app: App, manifest: PluginManifest) {
super(app, manifest);
- this.harper = new WorkerLinter();
+ this.harper = new WorkerLinter({ binary });
this.editorExtensions = [];
}
@@ -41,9 +41,9 @@ export default class HarperPlugin extends Plugin {
if (settings.useWebWorker != oldSettings.useWebWorker) {
if (settings.useWebWorker) {
- this.harper = new WorkerLinter();
+ this.harper = new WorkerLinter({ binary });
} else {
- this.harper = new LocalLinter();
+ this.harper = new LocalLinter({ binary });
}
} else {
await this.harper.clearIgnoredLints();
diff --git a/packages/package.json b/packages/package.json
index a7866461a..974f6b6ab 100644
--- a/packages/package.json
+++ b/packages/package.json
@@ -15,7 +15,7 @@
"prettier-plugin-svelte": "^3.0.3",
"@typescript-eslint/eslint-plugin": "^8.18.1",
"@typescript-eslint/parser": "^8.18.1",
- "typescript": "^5.7.3"
+ "typescript": "^5.7.2"
},
- "packageManager": "[email protected]+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+ "packageManager": "[email protected]"
}
diff --git a/packages/vscode-plugin/package.json b/packages/vscode-plugin/package.json
index 8fd9dc0e5..f25223f8c 100644
--- a/packages/vscode-plugin/package.json
+++ b/packages/vscode-plugin/package.json
@@ -368,7 +368,7 @@
"esbuild": "^0.24.2",
"eslint": "^8.57.0",
"jasmine": "^5.3.0",
- "typescript": "^5.7.3"
+ "typescript": "^5.7.2"
},
"dependencies": {
"vscode-languageclient": "^9.0.1"
diff --git a/packages/web/package.json b/packages/web/package.json
index 9c80c07c6..ea421c1ef 100644
--- a/packages/web/package.json
+++ b/packages/web/package.json
@@ -23,7 +23,7 @@
"svelte-check": "^4.1.1",
"tailwindcss": "^3.3.3",
"tslib": "^2.4.1",
- "typescript": "^5.7.3",
+ "typescript": "^5.7.2",
"vite": "^6.1.0",
"vite-plugin-pwa": "^0.21.1",
"vite-plugin-top-level-await": "^1.4.4",
diff --git a/packages/web/src/lib/DefaultNeovimConfig.svelte b/packages/web/src/lib/DefaultNeovimConfig.svelte
index 0fa798749..93dc821a7 100644
--- a/packages/web/src/lib/DefaultNeovimConfig.svelte
+++ b/packages/web/src/lib/DefaultNeovimConfig.svelte
@@ -1,8 +1,8 @@
<script>
- import { LocalLinter } from 'harper.js';
+ import { LocalLinter, binary } from 'harper.js';
import { Button } from 'flowbite-svelte';
- let linter = new LocalLinter();
+ let linter = new LocalLinter({ binary });
let head = `lspconfig.harper_ls.setup {
settings = {
diff --git a/packages/web/src/lib/Editor.svelte b/packages/web/src/lib/Editor.svelte
index 0af62b849..5ee952270 100644
--- a/packages/web/src/lib/Editor.svelte
+++ b/packages/web/src/lib/Editor.svelte
@@ -3,7 +3,7 @@
import demo from '../../../../demo.md?raw';
import Underlines from '$lib/Underlines.svelte';
import { Button } from 'flowbite-svelte';
- import { WorkerLinter, SuggestionKind } from 'harper.js';
+ import { WorkerLinter, SuggestionKind, binary } from 'harper.js';
import type { Lint } from 'harper.js';
import CheckMark from '$lib/CheckMark.svelte';
import { fly } from 'svelte/transition';
@@ -15,7 +15,7 @@
let lintCards: HTMLButtonElement[] = [];
let focused: number | undefined;
let editor: HTMLTextAreaElement | null;
- let linter = new WorkerLinter();
+ let linter = new WorkerLinter({ binary });
linter.setup();
diff --git a/packages/web/src/lib/Underlines.svelte b/packages/web/src/lib/Underlines.svelte
index 6a6f38749..8b6c3e3c6 100644
--- a/packages/web/src/lib/Underlines.svelte
+++ b/packages/web/src/lib/Underlines.svelte
@@ -5,7 +5,7 @@
// For now, it works.
import type { Lint } from 'harper.js';
- import { WorkerLinter } from 'harper.js';
+ import { WorkerLinter, binary } from 'harper.js';
import lintKindColor from '$lib/lintKindColor';
export let content: string;
@@ -13,7 +13,7 @@
let lints: [Lint, number][] = [];
let lintHighlights: HTMLSpanElement[] = [];
- let linter = new WorkerLinter();
+ let linter = new WorkerLinter({ binary });
linter.setup();
$: linter
diff --git a/packages/web/src/routes/docs/rules/+page.svelte b/packages/web/src/routes/docs/rules/+page.svelte
index c47d737ab..e30796b09 100644
--- a/packages/web/src/routes/docs/rules/+page.svelte
+++ b/packages/web/src/routes/docs/rules/+page.svelte
@@ -1,5 +1,5 @@
<script module lang="ts">
- import { LocalLinter } from 'harper.js';
+ import { LocalLinter, binary } from 'harper.js';
export const prerender = true;
export const frontmatter = {
@@ -9,7 +9,7 @@
let info: Record<string, string> = $state({});
let titles: Record<string, string> = $state({});
- let linter = new LocalLinter();
+ let linter = new LocalLinter({ binary });
linter.getLintDescriptions().then(async (v) => {
info = v;
diff --git a/packages/web/src/routes/languagedetection/+page.svelte b/packages/web/src/routes/languagedetection/+page.svelte
index 35c1a82ed..7c24bef26 100644
--- a/packages/web/src/routes/languagedetection/+page.svelte
+++ b/packages/web/src/routes/languagedetection/+page.svelte
@@ -1,5 +1,5 @@
<script lang="ts">
- import { WorkerLinter } from 'harper.js';
+ import { WorkerLinter, binary } from 'harper.js';
import { Textarea, Select } from 'flowbite-svelte';
import demoText from '../../../../../demo.md?raw';
@@ -7,7 +7,7 @@
let text = '';
let strippedText = '';
- let linter = new WorkerLinter();
+ let linter = new WorkerLinter({ binary });
linter.setup();
$: linter.isLikelyEnglish(text).then((v) => (isEnglish = v));
diff --git a/packages/yarn.lock b/packages/yarn.lock
index 34c0a5c0a..4aec9131d 100644
--- a/packages/yarn.lock
+++ b/packages/yarn.lock
@@ -1569,7 +1569,7 @@
resolved "https://registry.yarnpkg.com/@lukeed/csprng/-/csprng-1.1.0.tgz#1e3e4bd05c1cc7a0b2ddbd8a03f39f6e4b5e6cfe"
integrity sha512-Z7C/xXCiGWsg0KuKsHTKJxbWhpI3Vs5GwLfOean7MGyVFGqdRgBbAjOCh6u4bbjPc/8MJ2pZmK/0DLdCbivLDA==
-"@microsoft/api-documenter@^7.26.5":
+"@microsoft/api-documenter@^7.26.7":
version "7.26.7"
resolved "https://registry.yarnpkg.com/@microsoft/api-documenter/-/api-documenter-7.26.7.tgz#695bf9bc0816bea6278d7de9f020a34a83dbc075"
integrity sha512-VruYlHYAhQfuBNyndvyD9GBmCRWSOZ8D9+eXicygycNPMC/SPM71WWu2OwP98CTBvq/OhG/uRvUGGdL4QvgiFQ==
@@ -1591,7 +1591,7 @@
"@microsoft/tsdoc-config" "~0.17.1"
"@rushstack/node-core-library" "5.11.0"
-"@microsoft/api-extractor@^7.49.1":
+"@microsoft/api-extractor@^7.49.1", "@microsoft/api-extractor@^7.49.2":
version "7.49.2"
resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.49.2.tgz#bc08c5fef1a3064f86657fd2e2f84c0ea64462f5"
integrity sha512-DI/WnvhbkHcucxxc4ys00ejCiViFls5EKPrEfe4NV3GGpVkoM5ZXF61HZNSGA8IG0oEV4KfTqIa59Rc3wdMopw==
@@ -4974,6 +4974,10 @@ gzip-size@^6.0.0:
dependencies:
duplexer "^0.1.2"
+"harper-wasm@link:../harper-wasm/pkg":
+ version "0.0.0"
+ uid ""
+
"harper.js@link:harper.js":
version "0.19.1"
@@ -8555,7 +8559,7 @@ [email protected]:
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.7.2.tgz#3169cf8c4c8a828cde53ba9ecb3d2b1d5dd67be6"
integrity sha512-i5t66RHxDvVN40HfDd1PsEThGNnlMCMT3jMUuoh9/0TaqWevNontacunWyN02LA9/fIbEWlcHZcgTKb9QoaLfg==
-typescript@^5.7.3:
+typescript@^5.7.2:
version "5.7.3"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.7.3.tgz#919b44a7dbb8583a9b856d162be24a54bf80073e"
integrity sha512-84MVSjMEHP+FQRPy3pX9sTVV/INIex71s9TL2Gm5FG/WG1SqXeKyZ0k7/blY/4FdOzI12CBy1vGc4og/eus0fw==
@@ -8942,10 +8946,6 @@ vscode-uri@^3.0.8:
resolved "https://registry.yarnpkg.com/vscode-uri/-/vscode-uri-3.0.8.tgz#1770938d3e72588659a172d0fd4642780083ff9f"
integrity sha512-AyFQ0EVmsOZOlAnxoFOGOq1SQDWAB7C6aqMGS23svWAllfOaxbuFvcT8D1i8z3Gyn8fraVeZNNmN6e9bxxXkKw==
-"wasm@link:../harper-wasm/pkg":
- version "0.0.0"
- uid ""
-
webidl-conversions@^4.0.2:
version "4.0.2"
resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad"