Skip to content

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

feat(chrome-ext): the ability to load/unload Weirpacks (#2752)

Elijah Potter60164917f0e6
diff --git a/packages/chrome-plugin/src/ProtocolClient.ts b/packages/chrome-plugin/src/ProtocolClient.ts
index 6a07259e3..cce960ae2 100644
--- a/packages/chrome-plugin/src/ProtocolClient.ts
+++ b/packages/chrome-plugin/src/ProtocolClient.ts
@@ -1,7 +1,7 @@
import type { Dialect, LintConfig, LintOptions } from 'harper.js';
import type { UnpackedLintGroups } from 'lint-framework';
import { LRUCache } from 'lru-cache';
-import type { ActivationKey, Hotkey } from './protocol';
+import type { ActivationKey, Hotkey, WeirpackMeta } from './protocol';
export default class ProtocolClient {
private static readonly lintCache = new LRUCache<string, Promise<UnpackedLintGroups>>({
@@ -162,4 +162,18 @@ export default class ProtocolClient {
): Promise<boolean> {
return (await chrome.runtime.sendMessage({ kind: 'postFormData', url, formData })).success;
}
+
+ public static async getWeirpacks(): Promise<WeirpackMeta[]> {
+ return (await chrome.runtime.sendMessage({ kind: 'getWeirpacks' })).weirpacks;
+ }
+
+ public static async addWeirpack(filename: string, bytes: Uint8Array): Promise<void> {
+ this.lintCache.clear();
+ await chrome.runtime.sendMessage({ kind: 'addWeirpack', filename, bytes: Array.from(bytes) });
+ }
+
+ public static async removeWeirpack(id: string): Promise<void> {
+ this.lintCache.clear();
+ await chrome.runtime.sendMessage({ kind: 'removeWeirpack', id });
+ }
}
diff --git a/packages/chrome-plugin/src/background/index.ts b/packages/chrome-plugin/src/background/index.ts
index 3ed505ffc..a93c02012 100644
--- a/packages/chrome-plugin/src/background/index.ts
+++ b/packages/chrome-plugin/src/background/index.ts
@@ -1,9 +1,16 @@
-import { BinaryModule, type Dialect, type LintConfig, LocalLinter } from 'harper.js';
+import {
+ BinaryModule,
+ type Dialect,
+ type LintConfig,
+ LocalLinter,
+ unpackWeirpackBytes,
+} from 'harper.js';
import { type UnpackedLintGroups, unpackLint } from 'lint-framework';
import type { PopupState } from '../PopupState';
import {
ActivationKey,
type AddToUserDictionaryRequest,
+ type AddWeirpackRequest,
createUnitResponse,
type GetActivationKeyResponse,
type GetConfigRequest,
@@ -22,6 +29,7 @@ import {
type GetReviewedRequest,
type GetReviewedResponse,
type GetUserDictionaryResponse,
+ type GetWeirpacksResponse,
type Hotkey,
type IgnoreLintRequest,
type LintRequest,
@@ -29,6 +37,7 @@ import {
type OpenReportErrorRequest,
type PostFormDataRequest,
type PostFormDataResponse,
+ type RemoveWeirpackRequest,
type Request,
type Response,
type SetActivationKeyRequest,
@@ -40,6 +49,7 @@ import {
type SetReviewedRequest,
type SetUserDictionaryRequest,
type UnitResponse,
+ type WeirpackMeta,
} from '../protocol';
import { detectBrowserDialect } from './detectDialect';
@@ -59,6 +69,7 @@ chrome.runtime.onMessage.addListener((request, _sender, sendResponse) => {
});
let linter: LocalLinter;
+const WEIRPACKS_KEY = 'weirpacks';
getDialect()
.then(setDialect)
@@ -179,6 +190,12 @@ function handleRequest(message: Request): Promise<Response> {
return handleGetReviewed(message);
case 'setReviewed':
return handleSetReviewed(message);
+ case 'getWeirpacks':
+ return handleGetWeirpacks();
+ case 'addWeirpack':
+ return handleAddWeirpack(message);
+ case 'removeWeirpack':
+ return handleRemoveWeirpack(message);
}
}
@@ -374,6 +391,63 @@ async function handleSetReviewed(req: SetReviewedRequest): Promise<UnitResponse>
return createUnitResponse();
}
+async function handleGetWeirpacks(): Promise<GetWeirpacksResponse> {
+ const stored = await getStoredWeirpacks();
+ const weirpacks: WeirpackMeta[] = stored.map((item) => ({
+ id: item.id,
+ name: item.name,
+ filename: item.filename,
+ version: item.version,
+ installedAt: item.installedAt,
+ }));
+
+ return { kind: 'getWeirpacks', weirpacks };
+}
+
+async function handleAddWeirpack(req: AddWeirpackRequest): Promise<UnitResponse> {
+ const bytes = Uint8Array.from(req.bytes);
+ const failures = await linter.loadWeirpackFromBytes(bytes);
+ if (failures !== undefined) {
+ throw new Error(
+ `This Weirpack has failing tests (${Object.keys(failures).length} rule(s) failed) and was not loaded.`,
+ );
+ }
+
+ const manifest = unpackWeirpackBytes(bytes).manifest;
+ const candidateName = manifest.name;
+ const candidateVersion = manifest.version;
+ const name =
+ typeof candidateName === 'string' && candidateName.trim().length > 0
+ ? candidateName.trim()
+ : req.filename;
+ const version =
+ typeof candidateVersion === 'string' && candidateVersion.trim().length > 0
+ ? candidateVersion.trim()
+ : null;
+
+ const current = await getStoredWeirpacks();
+ current.push({
+ id: createWeirpackId(),
+ name,
+ filename: req.filename,
+ version,
+ installedAt: new Date().toISOString(),
+ bytesBase64: bytesToBase64(bytes),
+ });
+ await setStoredWeirpacks(current);
+
+ return createUnitResponse();
+}
+
+async function handleRemoveWeirpack(req: RemoveWeirpackRequest): Promise<UnitResponse> {
+ const current = await getStoredWeirpacks();
+ const next = current.filter((item) => item.id !== req.id);
+ await setStoredWeirpacks(next);
+
+ initializeLinter(await linter.getDialect());
+ return createUnitResponse();
+}
+
/** Set the lint configuration inside the global `linter` and in permanent storage. */
async function setLintConfig(lintConfig: LintConfig): Promise<void> {
await linter.setLintConfig(lintConfig);
@@ -448,6 +522,7 @@ function initializeLinter(dialect: Dialect) {
getIgnoredLints().then((i) => linter.importIgnoredLints(i));
getUserDictionary().then((u) => linter.importWords(u));
getLintConfig().then((c) => linter.setLintConfig(c));
+ loadStoredWeirpacksIntoLinter();
linter.setup();
}
@@ -550,3 +625,52 @@ async function getReviewed(): Promise<boolean> {
async function setReviewed(reviewed: boolean): Promise<void> {
await chrome.storage.local.set({ reviewed });
}
+
+type StoredWeirpack = WeirpackMeta & {
+ bytesBase64: string;
+};
+
+function createWeirpackId(): string {
+ return crypto.randomUUID?.() ?? `${Date.now()}-${Math.random()}`;
+}
+
+function bytesToBase64(bytes: Uint8Array): string {
+ let binary = '';
+ for (const byte of bytes) {
+ binary += String.fromCharCode(byte);
+ }
+ return btoa(binary);
+}
+
+function base64ToBytes(encoded: string): Uint8Array {
+ const binary = atob(encoded);
+ const bytes = new Uint8Array(binary.length);
+ for (let i = 0; i < binary.length; i++) {
+ bytes[i] = binary.charCodeAt(i);
+ }
+ return bytes;
+}
+
+async function setStoredWeirpacks(weirpacks: StoredWeirpack[]): Promise<void> {
+ await chrome.storage.local.set({ [WEIRPACKS_KEY]: weirpacks });
+}
+
+async function getStoredWeirpacks(): Promise<StoredWeirpack[]> {
+ const response = await chrome.storage.local.get({ [WEIRPACKS_KEY]: [] as StoredWeirpack[] });
+ const value = response[WEIRPACKS_KEY];
+ return Array.isArray(value) ? value : [];
+}
+
+async function loadStoredWeirpacksIntoLinter(): Promise<void> {
+ const weirpacks = await getStoredWeirpacks();
+ for (const weirpack of weirpacks) {
+ try {
+ const failures = await linter.loadWeirpackFromBytes(base64ToBytes(weirpack.bytesBase64));
+ if (failures !== undefined) {
+ console.error(`Stored Weirpack ${weirpack.name} failed tests`, failures);
+ }
+ } catch (error) {
+ console.error(`Failed to load stored Weirpack ${weirpack.name}`, error);
+ }
+ }
+}
diff --git a/packages/chrome-plugin/src/options/Options.svelte b/packages/chrome-plugin/src/options/Options.svelte
index eef4ddb08..33fca7ca9 100644
--- a/packages/chrome-plugin/src/options/Options.svelte
+++ b/packages/chrome-plugin/src/options/Options.svelte
@@ -3,7 +3,7 @@ import { Button, Card, Input, Select, Textarea } from 'components';
import { Dialect, type LintConfig } from 'harper.js';
import logo from '/logo.png';
import ProtocolClient from '../ProtocolClient';
-import type { Hotkey, Modifier } from '../protocol';
+import type { Hotkey, Modifier, WeirpackMeta } from '../protocol';
import { ActivationKey } from '../protocol';
let lintConfig: LintConfig = $state({});
@@ -17,6 +17,9 @@ let userDict = $state('');
let modifyHotkeyButton: Button;
let hotkey: Hotkey = $state({ modifiers: ['Ctrl'], key: 'e' });
let anyRulesEnabled = $derived(Object.values(lintConfig ?? {}).some((value) => value !== false));
+let weirpacks: WeirpackMeta[] = $state([]);
+let weirpackBusy = $state(false);
+let weirpackError = $state('');
$effect(() => {
ProtocolClient.setLintConfig($state.snapshot(lintConfig));
@@ -71,6 +74,10 @@ ProtocolClient.getUserDictionary().then((d) => {
userDict = dictToString(d.toSorted());
});
+ProtocolClient.getWeirpacks().then((stored) => {
+ weirpacks = stored.toSorted((a, b) => b.installedAt.localeCompare(a.installedAt));
+});
+
function configValueToString(value: boolean | undefined): string {
switch (value) {
case true:
@@ -199,6 +206,49 @@ function startHotkeyCapture(_modifyHotkeyButton: Button) {
window.addEventListener('keydown', handleKeydown);
}
+async function refreshWeirpacks() {
+ const stored = await ProtocolClient.getWeirpacks();
+ weirpacks = stored.toSorted((a, b) => b.installedAt.localeCompare(a.installedAt));
+}
+
+async function handleWeirpackUpload(event: Event) {
+ const input = event.currentTarget as HTMLInputElement | null;
+ const files = input?.files;
+ if (!files || files.length === 0) {
+ return;
+ }
+
+ weirpackError = '';
+ weirpackBusy = true;
+ try {
+ for (const file of files) {
+ const bytes = new Uint8Array(await file.arrayBuffer());
+ await ProtocolClient.addWeirpack(file.name, bytes);
+ }
+ await refreshWeirpacks();
+ } catch (error) {
+ const message = error instanceof Error ? error.message : 'Failed to upload Weirpack.';
+ weirpackError = message;
+ } finally {
+ weirpackBusy = false;
+ input.value = '';
+ }
+}
+
+async function removeWeirpack(id: string) {
+ weirpackBusy = true;
+ weirpackError = '';
+ try {
+ await ProtocolClient.removeWeirpack(id);
+ await refreshWeirpacks();
+ } catch (error) {
+ const message = error instanceof Error ? error.message : 'Failed to remove Weirpack.';
+ weirpackError = message;
+ } finally {
+ weirpackBusy = false;
+ }
+}
+
// Import removed
</script>
@@ -302,6 +352,53 @@ function startHotkeyCapture(_modifyHotkeyButton: Button) {
</Card>
+ <Card class="space-y-4">
+ <h2 class="pb-1 text-xs uppercase tracking-wider">Weirpacks</h2>
+
+ <div class="space-y-2 flex flex-row w-full justify-between">
+ <p class="text-xs text-gray-600 dark:text-gray-400">
+ Upload one or more <code>.weirpack</code> files to add custom rule packs.
+ </p>
+ <input
+ type="file"
+ accept=".weirpack,application/zip"
+ multiple
+ disabled={weirpackBusy}
+ onchange={handleWeirpackUpload}
+ class="block w-1/4 text-sm file:rounded-md file:border-0 file:bg-primary file:text-white disabled:opacity-50"
+ />
+ </div>
+
+ {#if weirpackError}
+ <p class="text-xs text-red-700 dark:text-red-400">{weirpackError}</p>
+ {/if}
+
+ {#if weirpacks.length === 0}
+ <p class="text-sm text-gray-600 dark:text-gray-400">No Weirpacks installed.</p>
+ {:else}
+ <div class="space-y-3">
+ {#each weirpacks as weirpack}
+ <div class="flex items-center justify-between gap-3 rounded-md border border-primary-100 p-3">
+ <div class="min-w-0">
+ <p class="truncate text-sm">
+ {weirpack.name}{weirpack.version ? ` v${weirpack.version}` : ''}
+ </p>
+ <p class="truncate text-xs text-gray-600 dark:text-gray-400">{weirpack.filename}</p>
+ </div>
+ <Button
+ size="sm"
+ color="light"
+ disabled={weirpackBusy}
+ on:click={() => removeWeirpack(weirpack.id)}
+ >
+ Remove
+ </Button>
+ </div>
+ {/each}
+ </div>
+ {/if}
+ </Card>
+
<!-- ── RULES ─────────────────────────────── -->
<Card class="space-y-4">
<div class="flex items-center justify-between gap-4">
diff --git a/packages/chrome-plugin/src/protocol.ts b/packages/chrome-plugin/src/protocol.ts
index b176de18a..a736ac45a 100644
--- a/packages/chrome-plugin/src/protocol.ts
+++ b/packages/chrome-plugin/src/protocol.ts
@@ -26,7 +26,10 @@ export type Request =
| GetReviewedRequest
| SetReviewedRequest
| OpenReportErrorRequest
- | PostFormDataRequest;
+ | PostFormDataRequest
+ | GetWeirpacksRequest
+ | AddWeirpackRequest
+ | RemoveWeirpackRequest;
export type Response =
| LintResponse
@@ -42,7 +45,8 @@ export type Response =
| GetActivationKeyResponse
| GetInstalledOnResponse
| GetReviewedResponse
- | PostFormDataResponse;
+ | PostFormDataResponse
+ | GetWeirpacksResponse;
export type LintRequest = {
kind: 'lint';
@@ -252,3 +256,31 @@ export type PostFormDataRequest = {
url: string;
formData: Record<string, string>;
};
+
+export type WeirpackMeta = {
+ id: string;
+ name: string;
+ filename: string;
+ version: string | null;
+ installedAt: string;
+};
+
+export type GetWeirpacksRequest = {
+ kind: 'getWeirpacks';
+};
+
+export type GetWeirpacksResponse = {
+ kind: 'getWeirpacks';
+ weirpacks: WeirpackMeta[];
+};
+
+export type AddWeirpackRequest = {
+ kind: 'addWeirpack';
+ filename: string;
+ bytes: number[];
+};
+
+export type RemoveWeirpackRequest = {
+ kind: 'removeWeirpack';
+ id: string;
+};