Skip to content

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

feat: separate web editor into own package (#3191)

Elijah Potter2648efbde5a0
diff --git a/Dockerfile b/Dockerfile
index 21a4f22bb..8b2148b89 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -43,6 +43,9 @@ RUN pnpm build && ./docs.sh
WORKDIR /usr/build/packages/lint-framework
RUN pnpm build
+WORKDIR /usr/build/packages/harper-editor
+RUN pnpm build
+
WORKDIR /usr/build/packages/web
RUN pnpm install --engine-strict=false --shamefully-hoist
RUN pnpm build
diff --git a/justfile b/justfile
index ec741d164..cb6a61557 100644
--- a/justfile
+++ b/justfile
@@ -13,12 +13,14 @@ soft-clean:
# another directory, there is a chance they should not be removed.
rm -rf packages/chrome-plugin/{build,package}
rm -rf packages/components/{.svelte-kit,dist}
+ rm -rf packages/harper-editor/{.svelte-kit,dist}
rm -rf packages/harper.js/{dist,markdown,temp}
rm -rf packages/lint-framework/{dist}
rm -rf packages/obsidian-plugin/{harper-obsidian-plugin.zip,main.js}
rm -rf packages/vscode-plugin/{.vscode-test,bin,build}
rm -rf packages/web/{.svelte-kit,.sveltepress,build}
rm -rf packages/wordpress-plugin/{build,harper.zip}
+ rm -rf harper-wasm/pkg
# Hard clean all build artifacts and dependencies
hard-clean: soft-clean
@@ -45,6 +47,15 @@ build-components:
pnpm install --engine-strict=false
pnpm build
+# Build the shared Harper editor library
+build-harper-editor: build-lint-framework build-components
+ #!/usr/bin/env bash
+ set -eo pipefail
+
+ cd "{{justfile_directory()}}/packages/harper-editor"
+ pnpm install --engine-strict=false
+ pnpm build
+
# Build the WebAssembly module
build-wasm:
#!/usr/bin/env bash
@@ -129,7 +140,7 @@ build-wp: build-harperjs
pnpm plugin-zip
# Compile the website's dependencies and start a development server. Note that if you make changes to `harper-wasm`, you will have to re-run this command.
-dev-web: build-harperjs build-lint-framework build-components
+dev-web: build-harperjs build-lint-framework build-components build-harper-editor
#!/usr/bin/env bash
set -eo pipefail
@@ -138,7 +149,7 @@ dev-web: build-harperjs build-lint-framework build-components
pnpm dev
# Build the Harper website.
-build-web: build-harperjs build-lint-framework build-components
+build-web: build-harperjs build-lint-framework build-components build-harper-editor
#!/usr/bin/env bash
set -eo pipefail
@@ -358,7 +369,7 @@ check-rust: audit-dictionary
# Perform format and type checking.
check: check-rust check-js build-web
-check-js: build-harperjs build-lint-framework build-components
+check-js: build-harperjs build-lint-framework build-components build-harper-editor
#!/usr/bin/env bash
set -eo pipefail
diff --git a/packages/harper-editor/.gitignore b/packages/harper-editor/.gitignore
new file mode 100644
index 000000000..294b38578
--- /dev/null
+++ b/packages/harper-editor/.gitignore
@@ -0,0 +1,24 @@
+node_modules
+
+# Output
+.output
+.vercel
+.netlify
+.wrangler
+/.svelte-kit
+/build
+/dist
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Env
+.env
+.env.*
+!.env.example
+!.env.test
+
+# Vite
+vite.config.js.timestamp-*
+vite.config.ts.timestamp-*
diff --git a/packages/harper-editor/package.json b/packages/harper-editor/package.json
new file mode 100644
index 000000000..7446c3e0b
--- /dev/null
+++ b/packages/harper-editor/package.json
@@ -0,0 +1,63 @@
+{
+ "name": "harper-editor",
+ "version": "0.0.1",
+ "license": "Apache-2.0",
+ "description": "Reusable Svelte editor components powered by Harper.",
+ "scripts": {
+ "dev": "vite dev",
+ "build": "pnpm run prepack",
+ "build:bundle": "svelte-kit sync && vite build",
+ "build:types": "svelte-package -i src/lib -o .svelte-package-tmp --types && node ./scripts/copy-package-types.mjs",
+ "preview": "vite preview",
+ "prepare": "svelte-kit sync || echo ''",
+ "prepack": "pnpm run build:bundle && pnpm run build:types && publint",
+ "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+ "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch"
+ },
+ "files": [
+ "dist",
+ "!dist/**/*.test.*",
+ "!dist/**/*.spec.*"
+ ],
+ "style": "./dist/harper-editor.css",
+ "sideEffects": [
+ "**/*.css"
+ ],
+ "types": "./dist/index.d.ts",
+ "type": "module",
+ "exports": {
+ ".": {
+ "types": "./dist/index.d.ts",
+ "svelte": "./dist/index.js",
+ "import": "./dist/index.js",
+ "default": "./dist/index.js"
+ },
+ "./harper-editor.css": "./dist/harper-editor.css",
+ "./style.css": "./dist/harper-editor.css"
+ },
+ "peerDependencies": {
+ "harper.js": "^2.0.0",
+ "svelte": "^5.0.0"
+ },
+ "devDependencies": {
+ "@sveltejs/adapter-auto": "^7.0.0",
+ "@sveltejs/kit": "^2.47.1",
+ "@sveltejs/package": "^2.5.4",
+ "@sveltejs/vite-plugin-svelte": "^6.2.1",
+ "@tailwindcss/cli": "^4.1.16",
+ "@tailwindcss/vite": "^4.1.14",
+ "components": "workspace:*",
+ "harper.js": "workspace:*",
+ "lint-framework": "workspace:*",
+ "publint": "^0.3.14",
+ "quill": "^2.0.3",
+ "svelte": "^5.41.0",
+ "svelte-check": "^4.3.3",
+ "tailwindcss": "^4.1.14",
+ "typescript": "catalog:",
+ "vite": "^7.1.10"
+ },
+ "keywords": [
+ "svelte"
+ ]
+}
diff --git a/packages/harper-editor/scripts/copy-package-types.mjs b/packages/harper-editor/scripts/copy-package-types.mjs
new file mode 100644
index 000000000..8e11bba19
--- /dev/null
+++ b/packages/harper-editor/scripts/copy-package-types.mjs
@@ -0,0 +1,36 @@
+import { cp, mkdir, readdir, rm } from 'node:fs/promises';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const packageDir = path.resolve(__dirname, '..');
+const tempDir = path.join(packageDir, '.svelte-package-tmp');
+const distDir = path.join(packageDir, 'dist');
+
+async function copyDeclarations(sourceDir, targetDir) {
+ const entries = await readdir(sourceDir, { withFileTypes: true });
+
+ for (const entry of entries) {
+ const sourcePath = path.join(sourceDir, entry.name);
+ const targetPath = path.join(targetDir, entry.name);
+
+ if (entry.isDirectory()) {
+ await copyDeclarations(sourcePath, targetPath);
+ continue;
+ }
+
+ if (!entry.name.endsWith('.d.ts') && !entry.name.endsWith('.d.ts.map')) {
+ continue;
+ }
+
+ if (entry.name === 'bundle.d.ts' || entry.name === 'bundle.d.ts.map') {
+ continue;
+ }
+
+ await mkdir(path.dirname(targetPath), { recursive: true });
+ await cp(sourcePath, targetPath);
+ }
+}
+
+await copyDeclarations(tempDir, distDir);
+await rm(tempDir, { recursive: true, force: true });
diff --git a/packages/harper-editor/src/app.d.ts b/packages/harper-editor/src/app.d.ts
new file mode 100644
index 000000000..628556684
--- /dev/null
+++ b/packages/harper-editor/src/app.d.ts
@@ -0,0 +1,5 @@
+declare global {
+ namespace App {}
+}
+
+export {};
diff --git a/packages/harper-editor/src/app.html b/packages/harper-editor/src/app.html
new file mode 100644
index 000000000..f273cc58f
--- /dev/null
+++ b/packages/harper-editor/src/app.html
@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
+ %sveltekit.head%
+ </head>
+ <body data-sveltekit-preload-data="hover">
+ <div style="display: contents">%sveltekit.body%</div>
+ </body>
+</html>
diff --git a/packages/web/src/lib/components/Editor.svelte b/packages/harper-editor/src/lib/Editor.svelte
similarity index 81%
rename from packages/web/src/lib/components/Editor.svelte
rename to packages/harper-editor/src/lib/Editor.svelte
index 98a5fe63d..139237491 100644
--- a/packages/web/src/lib/components/Editor.svelte
+++ b/packages/harper-editor/src/lib/Editor.svelte
@@ -1,20 +1,20 @@
<script lang="ts">
import { Card } from 'components';
-import { type WorkerLinter } from 'harper.js';
+import type Linter from 'harper.js';
import {
type IgnorableLintBox,
LintFramework,
type UnpackedLintGroups,
unpackLint,
} from 'lint-framework';
-import LintSidebar from '$lib/components/LintSidebar.svelte';
-import demo from '../../../../../demo.md?raw';
+import LintSidebar from './LintSidebar.svelte';
-export let content = demo.trim();
+export let content = '';
+export let linter: Linter;
export let onReady: () => void = () => null;
let editor: HTMLDivElement | null;
-let linter: WorkerLinter;
+let linterVersion = 0;
let quill: any;
let lintBoxes: IgnorableLintBox[] = [];
@@ -24,8 +24,6 @@ $: if (linter != null && quill != null) {
let lfw = new LintFramework(
async (text) => {
- if (!linter) return {};
-
const raw = await linter.organizedLints(text);
// The framework expects grouped lints keyed by source
const entries = await Promise.all(
@@ -43,7 +41,6 @@ let lfw = new LintFramework(
},
{
ignoreLint: async (hash: string) => {
- if (!linter) return;
try {
await linter.ignoreLintHash(BigInt(hash));
console.log(`Ignored ${hash}`);
@@ -56,15 +53,29 @@ let lfw = new LintFramework(
},
);
-(async () => {
- let { WorkerLinter } = await import('harper.js');
- let { slimBinary } = await import('harper.js/slimBinary');
- let newLinter = new WorkerLinter({ binary: slimBinary });
+$: {
+ const version = ++linterVersion;
+ const activeLinter = linter;
+
+ lintBoxes = [];
+
+ void (async () => {
+ try {
+ await activeLinter.setup();
+ await activeLinter.lint(content);
+ } catch (error) {
+ console.error('Failed to initialize linter', error);
+ }
+
+ if (version !== linterVersion) {
+ return;
+ }
- newLinter.setup();
- await newLinter.lint(content);
- linter = newLinter;
-})();
+ if (editor != null) {
+ lfw.update();
+ }
+ })();
+}
async function updateLintFrameworkElements() {
if (editor == null) {
@@ -122,9 +133,9 @@ function jumpTo(lintBox: IgnorableLintBox) {
<div class="flex flex-row h-full w-full [&_*]:outline-none">
<Card class="flex-1 h-full p-5 z-10 max-w-full text-lg mr-5 bg-white dark:bg-black overflow-auto">
- <div bind:this={editor} spellcheck="false">
- {@html content.replace(/\n\n/g, '<br>')}
- </div>
+ <div bind:this={editor} spellcheck="false">
+ {@html content.replace(/\n\n/g, '<br>')}
+ </div>
</Card>
<LintSidebar
diff --git a/packages/harper-editor/src/lib/LazyEditor.svelte b/packages/harper-editor/src/lib/LazyEditor.svelte
new file mode 100644
index 000000000..37137b097
--- /dev/null
+++ b/packages/harper-editor/src/lib/LazyEditor.svelte
@@ -0,0 +1,27 @@
+<script lang="ts">
+import { Spinner } from 'components';
+import type Linter from 'harper.js';
+
+export let content = '';
+export let linter: Linter;
+
+let editor = import('./Editor.svelte');
+let loading = true;
+
+function onReady() {
+ loading = false;
+}
+</script>
+
+{#await editor then { default: Editor}}
+ <div class={`flex-row h-full w-full ${loading ? 'hidden' : 'flex'}`}>
+ <Editor content={content} {linter} {onReady} />
+ </div>
+{/await}
+
+{#if loading}
+ <div class="flex h-full max-w-full flex-col items-center justify-center gap-2">
+ <Spinner color="green" />
+ <p class="text-sm">Loading Harper's grammar engine...</p>
+ </div>
+{/if}
diff --git a/packages/harper-editor/src/lib/LintCard.svelte b/packages/harper-editor/src/lib/LintCard.svelte
new file mode 100644
index 000000000..67b189388
--- /dev/null
+++ b/packages/harper-editor/src/lib/LintCard.svelte
@@ -0,0 +1,86 @@
+<script lang="ts">
+import { Button } from 'components';
+import { lintKindColor, lintKindTextColor } from 'lint-framework';
+import { slide } from 'svelte/transition';
+import type { UnpackedLint, UnpackedSuggestion } from './types';
+
+export let lint: UnpackedLint;
+export let open = false;
+export let onToggleOpen: () => void;
+export let focusError: () => void;
+export let onApply: (s: UnpackedSuggestion) => void;
+export let snippet: {
+ prefix: string;
+ problem: string;
+ suffix: string;
+ prefixEllipsis: boolean;
+ suffixEllipsis: boolean;
+};
+
+function suggestionText(s: UnpackedSuggestion): string {
+ return s.replacement_text !== '' ? s.replacement_text : String(s.kind);
+}
+</script>
+
+<div
+ class="rounded-lg border border-gray-300 dark:border-gray-700 shadow-sm bg-white dark:bg-[#0d1117]"
+ role="button"
+ tabindex="0"
+ aria-label="Focus lint error"
+ on:click={() => focusError?.()}
+ on:keydown={(e) => (e.key === 'Enter' || e.key === ' ') && (e.preventDefault(), focusError?.())}
+>
+ <div
+ role="button"
+ tabindex="0"
+ class="flex items-center justify-between p-3 cursor-pointer select-none"
+ aria-expanded={open}
+ on:click={() => onToggleOpen?.()}
+ on:keydown={(e) => (e.key === 'Enter' || e.key === ' ') && (e.preventDefault(), onToggleOpen?.())}
+ >
+ <div
+ class="text-sm font-semibold pb-1"
+ style={`border-bottom: 2px solid ${lintKindColor(lint.lint_kind)}`}
+ >
+ {lint.lint_kind_pretty}
+ </div>
+ <svg
+ class={`ml-3 h-4 w-4 transform transition-transform duration-200 ${open ? 'rotate-180' : ''}`}
+ viewBox="0 0 20 20"
+ fill="currentColor"
+ aria-hidden="true"
+ >
+ <path fill-rule="evenodd" d="M5.23 7.21a.75.75 0 011.06.02L10 11.127l3.71-3.896a.75.75 0 111.08 1.04l-4.243 4.46a.75.75 0 01-1.08 0L5.25 8.27a.75.75 0 01-.02-1.06z" clip-rule="evenodd" />
+ </svg>
+ </div>
+ {#if open}
+ <div class="px-3 pb-3" in:slide={{ duration: 150 }} out:slide={{ duration: 150 }}>
+ <div class="text-sm text-gray-700 dark:text-gray-300 mb-2 break-words">
+ {@html lint.message_html}
+ </div>
+ <div class="text-xs font-mono mb-2 p-2 rounded border border-gray-200 dark:border-gray-800 bg-gray-50 dark:bg-[#0b0f14] text-gray-800 dark:text-gray-200 leading-snug">
+ <span class="text-gray-500">{snippet.prefixEllipsis ? '…' : ''}{snippet.prefix}</span>
+ <span class="px-0.5 rounded bg-yellow-200 text-black dark:bg-yellow-800 dark:text-yellow-100">{snippet.problem}</span>
+ <span class="text-gray-500">{snippet.suffix}{snippet.suffixEllipsis ? '…' : ''}</span>
+ </div>
+ {#if lint.suggestions && lint.suggestions.length > 0}
+ <div class="flex flex-wrap gap-2 justify-end">
+ {#each lint.suggestions as s}
+ <Button
+ size="xs"
+ color={lintKindColor(lint.lint_kind)}
+ textColor={lintKindTextColor(lint.lint_kind)}
+ class="!px-2 !py-1 text-xs font-semibold"
+ title={`Replace with "${suggestionText(s)}"`}
+ on:click={() => onApply?.(s)}
+ >
+ {suggestionText(s)}
+ </Button>
+ {/each}
+ </div>
+ {:else}
+ <div class="text-xs text-gray-400">No suggestions available.</div>
+ {/if}
+ </div>
+ {/if}
+</div>
diff --git a/packages/web/src/lib/components/LintSidebar.svelte b/packages/harper-editor/src/lib/LintSidebar.svelte
similarity index 95%
rename from packages/web/src/lib/components/LintSidebar.svelte
rename to packages/harper-editor/src/lib/LintSidebar.svelte
index 2574731e5..eb2d1c679 100644
--- a/packages/web/src/lib/components/LintSidebar.svelte
+++ b/packages/harper-editor/src/lib/LintSidebar.svelte
@@ -1,7 +1,7 @@
<script lang="ts">
import { Button, Card } from 'components';
-import { type IgnorableLintBox, type LintBox, type UnpackedLint } from 'lint-framework';
-import LintCard from '$lib/components/LintCard.svelte';
+import LintCard from './LintCard.svelte';
+import type { IgnorableLintBox, LintBox } from './types';
export let lintBoxes: IgnorableLintBox[] = [];
export let focusLint: (lintBox: IgnorableLintBox) => void = () => {};
diff --git a/packages/harper-editor/src/lib/bundle.ts b/packages/harper-editor/src/lib/bundle.ts
new file mode 100644
index 000000000..1ac6b829c
--- /dev/null
+++ b/packages/harper-editor/src/lib/bundle.ts
@@ -0,0 +1,4 @@
+import 'components/components.css';
+import './styles.css';
+
+export * from './index';
diff --git a/packages/harper-editor/src/lib/index.ts b/packages/harper-editor/src/lib/index.ts
new file mode 100644
index 000000000..1599dd4df
--- /dev/null
+++ b/packages/harper-editor/src/lib/index.ts
@@ -0,0 +1,15 @@
+export { default as Editor } from './Editor.svelte';
+export { default as LazyEditor } from './LazyEditor.svelte';
+export { default as LintCard } from './LintCard.svelte';
+export { default as LintSidebar } from './LintSidebar.svelte';
+export type {
+ Box,
+ EditorLinter,
+ IgnorableLintBox,
+ LintBox,
+ LintKind,
+ SourceTextNode,
+ UnpackedLint,
+ UnpackedSpan,
+ UnpackedSuggestion,
+} from './types';
diff --git a/packages/harper-editor/src/lib/styles.css b/packages/harper-editor/src/lib/styles.css
new file mode 100644
index 000000000..81d706f6b
--- /dev/null
+++ b/packages/harper-editor/src/lib/styles.css
@@ -0,0 +1,5 @@
+@import "tailwindcss";
+
+@custom-variant dark (&:where(.dark, .dark *));
+
+@source "./**/*.{svelte,ts}";
diff --git a/packages/harper-editor/src/lib/types.ts b/packages/harper-editor/src/lib/types.ts
new file mode 100644
index 000000000..9784bda0c
--- /dev/null
+++ b/packages/harper-editor/src/lib/types.ts
@@ -0,0 +1,69 @@
+import type { Linter, SuggestionKind } from 'harper.js';
+
+export type EditorLinter = Linter;
+
+export type LintKind =
+ | 'Agreement'
+ | 'BoundaryError'
+ | 'Capitalization'
+ | 'Eggcorn'
+ | 'Enhancement'
+ | 'Formatting'
+ | 'Grammar'
+ | 'Malapropism'
+ | 'Miscellaneous'
+ | 'Nonstandard'
+ | 'Punctuation'
+ | 'Readability'
+ | 'Redundancy'
+ | 'Regionalism'
+ | 'Repetition'
+ | 'Spelling'
+ | 'Style'
+ | 'Typo'
+ | 'Usage'
+ | 'WordChoice';
+
+export type UnpackedSpan = {
+ start: number;
+ end: number;
+};
+
+export type UnpackedSuggestion = {
+ kind: SuggestionKind;
+ replacement_text: string;
+};
+
+export type UnpackedLint = {
+ span: UnpackedSpan;
+ message_html: string;
+ problem_text: string;
+ lint_kind: LintKind;
+ lint_kind_pretty: string;
+ suggestions: UnpackedSuggestion[];
+ context_hash: string;
+ source: string;
+};
+
+export type SourceTextNode = {
+ textContent: string | null;
+};
+
+export type Box = {
+ x: number;
+ y: number;
+ width: number;
+ height: number;
+};
+
+export type LintBox = Box & {
+ lint: UnpackedLint;
+ source: SourceTextNode;
+ range?: Range;
+ applySuggestion: (sug: UnpackedSuggestion) => void;
+};
+
+export type IgnorableLintBox = LintBox & {
+ rule: string;
+ ignoreLint?: () => Promise<void>;
+};
diff --git a/packages/harper-editor/svelte.config.js b/packages/harper-editor/svelte.config.js
new file mode 100644
index 000000000..c8b303bb6
--- /dev/null
+++ b/packages/harper-editor/svelte.config.js
@@ -0,0 +1,12 @@
+import adapter from '@sveltejs/adapter-auto';
+import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
+
+/** @type {import('@sveltejs/kit').Config} */
+const config = {
+ preprocess: vitePreprocess(),
+ kit: {
+ adapter: adapter(),
+ },
+};
+
+export default config;
diff --git a/packages/harper-editor/tsconfig.json b/packages/harper-editor/tsconfig.json
new file mode 100644
index 000000000..371777edd
--- /dev/null
+++ b/packages/harper-editor/tsconfig.json
@@ -0,0 +1,16 @@
+{
+ "extends": "./.svelte-kit/tsconfig.json",
+ "compilerOptions": {
+ "allowImportingTsExtensions": true,
+ "allowJs": true,
+ "checkJs": true,
+ "esModuleInterop": true,
+ "forceConsistentCasingInFileNames": true,
+ "resolveJsonModule": true,
+ "skipLibCheck": true,
+ "sourceMap": true,
+ "strict": true,
+ "module": "NodeNext",
+ "moduleResolution": "NodeNext"
+ }
+}
diff --git a/packages/harper-editor/vite.config.ts b/packages/harper-editor/vite.config.ts
new file mode 100644
index 000000000..3c4c5b808
--- /dev/null
+++ b/packages/harper-editor/vite.config.ts
@@ -0,0 +1,27 @@
+import { resolve } from 'node:path';
+import { svelte } from '@sveltejs/vite-plugin-svelte';
+import tailwindcss from '@tailwindcss/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+ plugins: [tailwindcss(), svelte()],
+ build: {
+ lib: {
+ entry: resolve(__dirname, 'src/lib/bundle.ts'),
+ formats: ['es'],
+ fileName: () => 'index',
+ cssFileName: 'harper-editor',
+ },
+ rollupOptions: {
+ external: ['svelte', /^svelte\//, /^harper\.js(\/.*)?$/],
+ output: {
+ assetFileNames: (assetInfo) =>
+ assetInfo.name === 'harper-editor.css'
+ ? 'harper-editor.css'
+ : 'assets/[name]-[hash][extname]',
+ chunkFileNames: 'chunks/[name]-[hash].js',
+ entryFileNames: () => 'index.js',
+ },
+ },
+ },
+});
diff --git a/packages/web/package.json b/packages/web/package.json
index d3ea94d6f..4375d7e7f 100644
--- a/packages/web/package.json
+++ b/packages/web/package.json
@@ -38,12 +38,12 @@
"components": "workspace:*",
"drizzle-orm": "^0.44.6",
"drizzle-zod": "^0.8.3",
+ "harper-editor": "workspace:*",
"harper.js": "workspace:*",
"lint-framework": "workspace:*",
"lodash-es": "^4.17.21",
"mysql2": "^3.15.2",
"posthog-js": "^1.245.1",
- "quill": "^2.0.3",
"reveal.js": "^5.1.0",
"svelte-ace": "^1.0.21",
"svelte-intersection-observer": "^1.0.0",
diff --git a/packages/web/src/app.css b/packages/web/src/app.css
index b2923cc39..97e7f86ac 100644
--- a/packages/web/src/app.css
+++ b/packages/web/src/app.css
@@ -1,5 +1,6 @@
@import "tailwindcss";
@import "components/components.css";
+@import "harper-editor/style.css";
@custom-variant dark (&:where(.dark, .dark *));
diff --git a/packages/web/src/lib/components/LazyEditor.svelte b/packages/web/src/lib/components/LazyEditor.svelte
deleted file mode 100644
index 02ad241f9..000000000
--- a/packages/web/src/lib/components/LazyEditor.svelte
+++ /dev/null
@@ -1,24 +0,0 @@
-<script lang="ts">
-import { Spinner } from 'components';
-export let content: string | undefined = undefined;
-
-let editor = import('./Editor.svelte');
-let loading = true;
-
-function onReady() {
- loading = false;
-}
-</script>
-
-{#await editor then { default: Editor}}
- <div class={`flex-row h-full w-full ${loading ? "hidden" : "flex"}`}>
- <Editor content={content} {onReady}/>
- </div>
-{/await}
-
-{#if loading}
- <div class="flex h-full max-w-full flex-col items-center justify-center gap-2">
- <Spinner color="green" />
- <p class="text-sm">Loading Harper's grammar engine...</p>
- </div>
-{/if}
diff --git a/packages/web/src/lib/components/LintCard.svelte b/packages/web/src/lib/components/LintCard.svelte
deleted file mode 100644
index 1285d4d2a..000000000
--- a/packages/web/src/lib/components/LintCard.svelte
+++ /dev/null
@@ -1,90 +0,0 @@
-<script lang="ts">
-import { Button } from 'components';
-import {
- lintKindColor,
- lintKindTextColor,
- type UnpackedLint,
- type UnpackedSuggestion,
-} from 'lint-framework';
-import { slide } from 'svelte/transition';
-
-export let lint: UnpackedLint;
-export let open = false;
-export let onToggleOpen: () => void;
-export let focusError: () => void;
-export let onApply: (s: UnpackedSuggestion) => void;
-export let snippet: {
- prefix: string;
- problem: string;
- suffix: string;
- prefixEllipsis: boolean;
- suffixEllipsis: boolean;
-};
-
-function suggestionText(s: UnpackedSuggestion): string {
- return s.replacement_text !== '' ? s.replacement_text : String(s.kind);
-}
-</script>
-
-<div
- class="rounded-lg border border-gray-300 dark:border-gray-700 shadow-sm bg-white dark:bg-[#0d1117]"
- role="button"
- tabindex="0"
- aria-label="Focus lint error"
- on:click={() => focusError?.()}
- on:keydown={(e) => (e.key === 'Enter' || e.key === ' ') && (e.preventDefault(), focusError?.())}
->
- <div
- role="button"
- tabindex="0"
- class="flex items-center justify-between p-3 cursor-pointer select-none"
- aria-expanded={open}
- on:click={() => onToggleOpen?.()}
- on:keydown={(e) => (e.key === 'Enter' || e.key === ' ') && (e.preventDefault(), onToggleOpen?.())}
- >
- <div
- class="text-sm font-semibold pb-1"
- style={`border-bottom: 2px solid ${lintKindColor(lint.lint_kind)}`}
- >
- {lint.lint_kind_pretty}
- </div>
- <svg
- class={`ml-3 h-4 w-4 transform transition-transform duration-200 ${open ? 'rotate-180' : ''}`}
- viewBox="0 0 20 20"
- fill="currentColor"
- aria-hidden="true"
- >
- <path fill-rule="evenodd" d="M5.23 7.21a.75.75 0 011.06.02L10 11.127l3.71-3.896a.75.75 0 111.08 1.04l-4.243 4.46a.75.75 0 01-1.08 0L5.25 8.27a.75.75 0 01-.02-1.06z" clip-rule="evenodd" />
- </svg>
- </div>
- {#if open}
- <div class="px-3 pb-3" in:slide={{ duration: 150 }} out:slide={{ duration: 150 }}>
- <div class="text-sm text-gray-700 dark:text-gray-300 mb-2 break-words">
- {@html lint.message_html}
- </div>
- <div class="text-xs font-mono mb-2 p-2 rounded border border-gray-200 dark:border-gray-800 bg-gray-50 dark:bg-[#0b0f14] text-gray-800 dark:text-gray-200 leading-snug">
- <span class="text-gray-500">{snippet.prefixEllipsis ? '…' : ''}{snippet.prefix}</span>
- <span class="px-0.5 rounded bg-yellow-200 text-black dark:bg-yellow-800 dark:text-yellow-100">{snippet.problem}</span>
- <span class="text-gray-500">{snippet.suffix}{snippet.suffixEllipsis ? '…' : ''}</span>
- </div>
- {#if lint.suggestions && lint.suggestions.length > 0}
- <div class="flex flex-wrap gap-2 justify-end">
- {#each lint.suggestions as s}
- <Button
- size="xs"
- color={lintKindColor(lint.lint_kind)}
- textColor={lintKindTextColor(lint.lint_kind)}
- class="!px-2 !py-1 text-xs font-semibold"
- title={`Replace with \"${suggestionText(s)}\"`}
- on:click={() => onApply?.(s)}
- >
- {suggestionText(s)}
- </Button>
- {/each}
- </div>
- {:else}
- <div class="text-xs text-gray-400">No suggestions available.</div>
- {/if}
- </div>
- {/if}
-</div>
diff --git a/packages/web/src/lib/createEditorLinter.ts b/packages/web/src/lib/createEditorLinter.ts
new file mode 100644
index 000000000..e1b55a620
--- /dev/null
+++ b/packages/web/src/lib/createEditorLinter.ts
@@ -0,0 +1,12 @@
+import type { Linter } from 'harper.js';
+
+export async function createEditorLinter(): Promise<Linter> {
+ const [{ WorkerLinter }, { slimBinary }] = await Promise.all([
+ import('harper.js'),
+ import('harper.js/slimBinary'),
+ ]);
+
+ const linter = new WorkerLinter({ binary: slimBinary });
+ await linter.setup();
+ return linter;
+}
diff --git a/packages/web/src/routes/+page.svelte b/packages/web/src/routes/+page.svelte
index 35752b336..adc323812 100644
--- a/packages/web/src/routes/+page.svelte
+++ b/packages/web/src/routes/+page.svelte
@@ -7,7 +7,7 @@ export const frontmatter = {
<script lang="ts">
import ChromeLogo from '$lib/components/ChromeLogo.svelte';
import CodeLogo from '$lib/components/CodeLogo.svelte';
-import LazyEditor from '$lib/components/LazyEditor.svelte';
+import { LazyEditor } from 'harper-editor';
import FirefoxLogo from '$lib/components/FirefoxLogo.svelte';
import GitHubLogo from '$lib/components/GitHubLogo.svelte';
import ObsidianLogo from '$lib/components/ObsidianLogo.svelte';
@@ -24,6 +24,10 @@ import ZedLogo from '$lib/components/ZedLogo.svelte';
import EdgeLogo from '$lib/components/EdgeLogo.svelte';
import { Card, Collapsible, Link } from 'components';
import { browser } from '$app/environment';
+import demoText from '../../../../demo.md?raw';
+import type { Linter } from 'harper.js';
+import { onMount } from 'svelte';
+import { createEditorLinter } from '$lib/createEditorLinter';
/**
* @param {string} keyword
@@ -94,6 +98,15 @@ const testimonials = [
source: "https://chromewebstore.google.com/detail/private-grammar-checker-h/lodbfhdipoipcjmlebjbgmmgekckhpfb/reviews"
},
];
+
+const editorContent = demoText.trim();
+let linter: Linter | null = null;
+
+onMount(() => {
+ (async () => {
+ linter = await createEditorLinter();
+ })();
+});
</script>
<main class="mx-auto flex w-full max-w-5xl flex-col gap-12 py-12">
@@ -154,8 +167,8 @@ const testimonials = [
</div>
<div class="h-[800px] w-full">
- {#if browser}
- <LazyEditor />
+ {#if browser && linter}
+ <LazyEditor content={editorContent} {linter} />
{/if}
</div>
</div>
diff --git a/packages/web/src/routes/docs/about/+page.md b/packages/web/src/routes/docs/about/+page.md
index 9cd72dbe7..b150a55ac 100644
--- a/packages/web/src/routes/docs/about/+page.md
+++ b/packages/web/src/routes/docs/about/+page.md
@@ -6,11 +6,29 @@ Harper is a grammar checker designed to run anywhere there is text (so really, a
Most Harper users are catching their mistakes in [Neovim](./integrations/neovim), [Obsidian](./integrations/obsidian), or [Visual Studio Code](./integrations/visual-studio-code).
<script>
- import Editor from "$lib/components/Editor.svelte"
+ import { Editor } from "harper-editor"
+ import { onMount } from "svelte"
+
+ let linter = null
+
+ onMount(async () => {
+ const [{ WorkerLinter }, { slimBinary }] = await Promise.all([
+ import("harper.js"),
+ import("harper.js/slimBinary"),
+ ])
+
+ linter = new WorkerLinter({ binary: slimBinary })
+ await linter.setup()
+ })
</script>
<div class="h-96">
- <Editor content={`You can try out a editor that uses\nHarper under the hood here.\n\nIt is rnning in your browser right now. \n\nNo server required!`}/>
+ {#if linter}
+ <Editor
+ content={`You can try out a editor that uses\nHarper under the hood here.\n\nIt is rnning in your browser right now. \n\nNo server required!`}
+ {linter}
+ />
+ {/if}
</div>
## How Does It Work?
diff --git a/packages/web/src/routes/editor/+page.svelte b/packages/web/src/routes/editor/+page.svelte
index 8c5ccfdf9..1df6039dc 100644
--- a/packages/web/src/routes/editor/+page.svelte
+++ b/packages/web/src/routes/editor/+page.svelte
@@ -1,13 +1,25 @@
-<script>
+<script lang="ts">
/// This page exists to be embedded via an `iframe`.
+import type { Linter } from 'harper.js';
+import { Editor } from 'harper-editor';
+import { onMount } from 'svelte';
import { page } from '$app/stores';
-import Editor from '$lib/components/Editor.svelte';
import Isolate from '$lib/components/Isolate.svelte';
+import { createEditorLinter } from '$lib/createEditorLinter';
let content = $page.url.searchParams.get('initialText') ?? '';
+let linter: Linter | null = null;
+
+onMount(() => {
+ (async () => {
+ linter = await createEditorLinter();
+ })();
+});
</script>
<Isolate>
- <Editor {content}></Editor>
+ {#if linter}
+ <Editor {content} {linter}></Editor>
+ {/if}
</Isolate>
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 7e1f7a9ac..196bbf4dd 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -175,6 +175,57 @@ importers:
specifier: ^7.1.10
+ packages/harper-editor:
+ devDependencies:
+ '@sveltejs/adapter-auto':
+ specifier: ^7.0.0
+ '@sveltejs/kit':
+ specifier: ^2.47.1
+ '@sveltejs/package':
+ specifier: ^2.5.4
+ '@sveltejs/vite-plugin-svelte':
+ specifier: ^6.2.1
+ '@tailwindcss/cli':
+ specifier: ^4.1.16
+ version: 4.1.17
+ '@tailwindcss/vite':
+ specifier: ^4.1.14
+ components:
+ specifier: workspace:*
+ version: link:../components
+ harper.js:
+ specifier: workspace:*
+ version: link:../harper.js
+ lint-framework:
+ specifier: workspace:*
+ version: link:../lint-framework
+ publint:
+ specifier: ^0.3.14
+ version: 0.3.15
+ quill:
+ specifier: ^2.0.3
+ version: 2.0.3
+ svelte:
+ specifier: ^5.41.0
+ version: 5.43.12
+ svelte-check:
+ specifier: ^4.3.3
+ tailwindcss:
+ specifier: ^4.1.14
+ version: 4.1.17
+ typescript:
+ specifier: 'catalog:'
+ version: 5.9.3
+ vite:
+ specifier: ^7.1.10
+
packages/harper.js:
dependencies:
fflate:
@@ -412,6 +463,9 @@ importers:
drizzle-zod:
specifier: ^0.8.3
+ harper-editor:
+ specifier: workspace:*
+ version: link:../harper-editor
harper.js:
specifier: workspace:*
version: link:../harper.js
@@ -427,9 +481,6 @@ importers:
posthog-js:
specifier: ^1.245.1
version: 1.245.1
- quill:
- specifier: ^2.0.3
- version: 2.0.3
reveal.js:
specifier: ^5.1.0
version: 5.1.0