Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(harper.js): add lazy binary loading
Asuka109c99168ddf8a8
diff --git a/packages/harper.js/package.json b/packages/harper.js/package.jsonindex 38e9d23e9..c39cada88 100644--- a/packages/harper.js/package.json+++ b/packages/harper.js/package.json@@ -32,7 +32,10 @@"vite-plugin-dts": "^4.5.0","vite-plugin-virtual": "^0.3.0","vitest": "^3.0.5",- "harper-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",diff --git a/packages/harper.js/src/LocalLinter.ts b/packages/harper.js/src/LocalLinter.tsindex 4f4ec1c1a..406ec1be7 100644--- a/packages/harper.js/src/LocalLinter.ts+++ b/packages/harper.js/src/LocalLinter.ts@@ -1,5 +1,6 @@import type { Lint, Span, Suggestion, Linter as WasmLinter } from 'harper-wasm';import { Language } from 'harper-wasm';+import LazyPromise from 'p-lazy';import Linter, { LinterInit } from './Linter';import { LintConfig, LintOptions } from './main';import { BinaryModule } from './binary';@@ -11,7 +12,10 @@ export default class LocalLinter implements Linter {constructor(init: LinterInit) {this.binary = init.binary;- this.inner = this.binary.setup().then(() => this.binary.createLinter());+ this.inner = LazyPromise.from(async () => {+ await this.binary.setup();+ return this.binary.createLinter();+ });}async setup(): Promise<void> {diff --git a/packages/harper.js/src/WorkerLinter/worker.ts b/packages/harper.js/src/WorkerLinter/worker.tsindex d7b0fd53b..4a18dec01 100644--- a/packages/harper.js/src/WorkerLinter/worker.ts+++ b/packages/harper.js/src/WorkerLinter/worker.ts@@ -1,7 +1,6 @@/// <reference lib="webworker" />import './shims';-import { isSerializedRequest, SerializedRequest } from '../binary';-import { BinaryModule } from '../binary';+import { isSerializedRequest, SerializedRequest, BinaryModule } from '../binary';import LocalLinter from '../LocalLinter';// Notify the main thread that we are readydiff --git a/packages/harper.js/src/binary.ts b/packages/harper.js/src/binary.tsindex c3cb5daaf..4a2142fda 100644--- a/packages/harper.js/src/binary.ts+++ b/packages/harper.js/src/binary.ts@@ -1,28 +1,30 @@import { default as binaryUrl } from 'harper-wasm/harper_wasm_bg.wasm?no-inline';import { default as binaryInlinedUrl } from 'harper-wasm/harper_wasm_bg.wasm?inline';import type { InitInput, Span, Suggestion, Linter as WasmLinter } from 'harper-wasm';+import pMemoize from 'p-memoize';+import LazyPromise from 'p-lazy';import { assert } from './utils';import { LintConfig } from './main';-const _loadedBinaryMap = new Map<string, typeof import('harper-wasm')>();--export async function loadBinary(binary: string): Promise<typeof import('harper-wasm')> {- if (_loadedBinaryMap.has(binary)) {- return _loadedBinaryMap.get(binary)!;+export const loadBinary = pMemoize(async (binary: string) => {+ const exports = await import('harper-wasm');++ let input: InitInput;+ if (typeof process !== 'undefined' && binary.startsWith('file://')) {+ const fs = await import(/* webpackIgnore: true */ /* @vite-ignore */ 'fs');+ input = new Promise((resolve, reject) => {+ fs.readFile(new URL(binary).pathname, (err, data) => {+ if (err) reject(err);+ resolve(data);+ });+ });} else {- const exports = await import('harper-wasm');- let input: InitInput;- if (typeof window === 'undefined' && binary.startsWith('file://')) {- const fs = await import('node:fs/promises');- input = fs.readFile(new URL(binary).pathname);- } else {- input = binary;- }- await exports.default({ module_or_path: input });- _loadedBinaryMap.set(binary, exports);- return exports;+ input = binary;}-}+ await exports.default({ module_or_path: input });++ return exports;+});export type SerializableTypes =| 'string'@@ -65,12 +67,13 @@ export function isSerializedRequest(v: unknown): v is SerializedRequest {export class BinaryModule {public url: string | URL;- private get inner() {- return loadBinary(typeof this.url === 'string' ? this.url : this.url.href);- }+ private inner: Promise<typeof import('harper-wasm')>;constructor(url: string | URL) {this.url = url;+ this.inner = LazyPromise.from(() =>+ loadBinary(typeof this.url === 'string' ? this.url : this.url.href)+ );}async applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string> {diff --git a/packages/harper.js/vite.config.ts b/packages/harper.js/vite.config.tsindex 5a970a016..f26c9370e 100644--- a/packages/harper.js/vite.config.ts+++ b/packages/harper.js/vite.config.ts@@ -28,7 +28,7 @@ export default defineConfig({minify: false,assetsInlineLimit: 0,rollupOptions: {- external: [/^node:/],+ external: [/^node:/, 'fs'],output: {minifyInternalExports: false,inlineDynamicImports: true@@ -68,7 +68,10 @@ export default defineConfig({enabled: true,headless: true,screenshotFailures: false,- instances: [{ browser: 'chromium' }, { browser: 'firefox' }]+ instances: [+ { browser: 'chromium' },+ // { browser: 'firefox' },+ ]}},assetsInclude: ['**/*.wasm']diff --git a/packages/web/src/routes/docs/rules/+page.svelte b/packages/web/src/routes/docs/rules/+page.svelteindex 3bc0a8f3e..99646af73 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, type LintConfig } from 'harper.js';+ import { LocalLinter, type LintConfig, binary } from 'harper.js';import {Table,TableBody,@@ -9,7 +9,6 @@TableHeadCell} from 'flowbite-svelte';- export const prerender = true;export const frontmatter = {title: 'Rules'};diff --git a/packages/web/src/routes/docs/rules/+page.ts b/packages/web/src/routes/docs/rules/+page.tsnew file mode 100644index 000000000..189f71e2e--- /dev/null+++ b/packages/web/src/routes/docs/rules/+page.ts@@ -0,0 +1 @@+export const prerender = true;diff --git a/packages/web/src/routes/titlecase/+page.svelte b/packages/web/src/routes/titlecase/+page.svelteindex 38f655219..ebfcf57ff 100644--- a/packages/web/src/routes/titlecase/+page.svelte+++ b/packages/web/src/routes/titlecase/+page.svelte@@ -2,10 +2,10 @@import { onMount } from 'svelte';import { Textarea } from 'flowbite-svelte';import Typed from 'typed.js';- import { WorkerLinter } from 'harper.js';+ import { WorkerLinter, binary } from 'harper.js';let textareaRef;- let linter = new WorkerLinter();+ let linter = new WorkerLinter({ binary });let text = $state('');diff --git a/packages/yarn.lock b/packages/yarn.lockindex 3258ebdb3..26f31e478 100644--- a/packages/yarn.lock+++ b/packages/yarn.lock@@ -12947,6 +12947,11 @@ mimic-fn@^2.1.0:resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-2.1.0.tgz#7ed2c2ccccaf84d3ffcb7a69b57711fc2083401b"integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==+mimic-fn@^4.0.0:+ version "4.0.0"+ resolved "https://registry.yarnpkg.com/mimic-fn/-/mimic-fn-4.0.0.tgz#60a90550d5cb0b239cca65d893b1a53b29871ecc"+ integrity sha512-vqiC06CuhBTUdZH+RYl8sFrL096vA45Ok5ISO6sE/Mr1jRbGH4Csnhi8f3wKVl7x8mO4Au7Ir9D3Oyv1VYMFJw==+mimic-response@^3.1.0:version "3.1.0"resolved "https://registry.yarnpkg.com/mimic-response/-/mimic-response-3.1.0.tgz#2d1d59af9c1b129815accc2c46a022a5ce1fa3c9"@@ -13572,6 +13577,11 @@ own-keys@^1.0.1:object-keys "^1.1.1"safe-push-apply "^1.0.0"+p-lazy@^5.0.0:+ version "5.0.0"+ resolved "https://registry.yarnpkg.com/p-lazy/-/p-lazy-5.0.0.tgz#43762897d0c208d656ab24364e91c9684939ec79"+ integrity sha512-C4xW5/wLGqswBx1xgu/t7fBaHMDKm7SXycgc0MEQvQ5KwzjT1E4MmE9cg0RXn9d0MTgUGJLUCb2EkLBevXi6eA==+p-limit@^2.0.0, p-limit@^2.2.0:version "2.3.0"resolved "https://registry.yarnpkg.com/p-limit/-/p-limit-2.3.0.tgz#3dd33c647a214fdfffd835933eb086da0dc21db1"@@ -13626,6 +13636,14 @@ p-map@^2.0.0:resolved "https://registry.yarnpkg.com/p-map/-/p-map-2.1.0.tgz#310928feef9c9ecc65b68b17693018a665cea175"integrity sha512-y3b8Kpd8OAN444hxfBbFfj1FY/RjtTd8tzYwhUqNYXx0fXx2iX4maP4Qr6qhIKbQXI02wTLAda4fYUbDagTUFw==+p-memoize@^7.1.1:+ version "7.1.1"+ resolved "https://registry.yarnpkg.com/p-memoize/-/p-memoize-7.1.1.tgz#53b1d0e6007288f7261cfa11a7603b84c9261bfa"+ integrity sha512-DZ/bONJILHkQ721hSr/E9wMz5Am/OTJ9P6LhLFo2Tu+jL8044tgc9LwHO8g4PiaYePnlVVRAJcKmgy8J9MVFrA==+ dependencies:+ mimic-fn "^4.0.0"+ type-fest "^3.0.0"+p-retry@^4.5.0:version "4.6.2"resolved "https://registry.yarnpkg.com/p-retry/-/p-retry-4.6.2.tgz#9baae7184057edd4e17231cee04264106e092a16"@@ -16856,7 +16874,7 @@ type-fest@^0.8.1:resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.8.1.tgz#09e249ebde851d3b1e48d27c105444667f17b83d"integrity sha512-4dbzIzqvjtgiM5rw1k5rEHtBANKmdudhGyBEajN01fEyhaAIhsoKNy6y7+IN93IfpFtwY9iqi7kD+xwKhQsNJA==-type-fest@^3.2.0:+type-fest@^3.0.0, type-fest@^3.2.0:version "3.13.1"resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-3.13.1.tgz#bb744c1f0678bea7543a2d1ec24e83e68e8c8706"integrity sha512-tLq3bSNx+xSpwvAJnzrK0Ep5CLNWjvFTOp71URMaAEWBfRb9nnJiBoUe0tF8bI4ZFO3omgBR6NvnbzVUT3Ly4g==@@ -16866,6 +16884,11 @@ type-fest@^4.26.1:resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-4.36.0.tgz#e656de02aa880aa01b4d3a71188bb6adb18668a2"integrity sha512-3T/PUdKTCnkUmhQU6FFJEHsLwadsRegktX3TNHk+2JJB9HlA8gp1/VXblXVDI93kSnXF2rdPx0GMbHtJIV2LPg==+type-fest@^4.37.0:+ version "4.37.0"+ resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-4.37.0.tgz#7cf008bf77b63a33f7ca014fa2a3f09fd69e8937"+ integrity sha512-S/5/0kFftkq27FPNye0XM1e2NsnoD/3FS+pBmbjmmtLT6I+i344KoOf7pvXreaFsDamWeaJX55nczA1m5PsBDg==+type-is@~1.6.18:version "1.6.18"resolved "https://registry.yarnpkg.com/type-is/-/type-is-1.6.18.tgz#4e552cd05df09467dcbc4ef739de89f2cf37c131"