Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(harper-editor): add storybook (#4728)
Elijah Potter3ac6b11ecbef
diff --git a/packages/harper-editor/.gitignore b/packages/harper-editor/.gitignoreindex 294b38578..f493fde56 100644--- a/packages/harper-editor/.gitignore+++ b/packages/harper-editor/.gitignore@@ -8,6 +8,7 @@ node_modules/.svelte-kit/build/dist+/storybook-static# OS.DS_Storediff --git a/packages/harper-editor/.storybook/main.ts b/packages/harper-editor/.storybook/main.tsnew file mode 100644index 000000000..39b659c62--- /dev/null+++ b/packages/harper-editor/.storybook/main.ts@@ -0,0 +1,15 @@+import type { StorybookConfig } from '@storybook/sveltekit';++const config: StorybookConfig = {+ stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|ts|svelte)'],+ addons: [+ '@vueless/storybook-dark-mode',+ '@storybook/addon-svelte-csf',+ '@chromatic-com/storybook',+ '@storybook/addon-vitest',+ '@storybook/addon-a11y',+ '@storybook/addon-docs',+ ],+ framework: '@storybook/sveltekit',+};+export default config;diff --git a/packages/harper-editor/.storybook/preview-head.html b/packages/harper-editor/.storybook/preview-head.htmlnew file mode 100644index 000000000..602482eb0--- /dev/null+++ b/packages/harper-editor/.storybook/preview-head.html@@ -0,0 +1,10 @@+<link rel="preconnect" href="https://fonts.googleapis.com" />+<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />+<link+ href="https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible:ital,wght@0,400;0,700;1,400;1,700&family=Domine:[email protected]&display=swap"+ rel="stylesheet"+/>+<link+ href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,100..800;1,100..800&display=swap"+ rel="stylesheet"+/>diff --git a/packages/harper-editor/.storybook/preview.css b/packages/harper-editor/.storybook/preview.cssnew file mode 100644index 000000000..31fd9faf3--- /dev/null+++ b/packages/harper-editor/.storybook/preview.css@@ -0,0 +1,3 @@+body {+ font-family: "Atkinson Hyperlegible", sans-serif;+}diff --git a/packages/harper-editor/.storybook/preview.ts b/packages/harper-editor/.storybook/preview.tsnew file mode 100644index 000000000..2e6236962--- /dev/null+++ b/packages/harper-editor/.storybook/preview.ts@@ -0,0 +1,30 @@+import type { Preview } from '@storybook/sveltekit';+import 'components/components.css';+import '../src/lib/styles.css';+import './preview.css';++const preview: Preview = {+ parameters: {+ controls: {+ matchers: {+ color: /(background|color)$/i,+ date: /Date$/i,+ },+ },+ darkMode: {+ darkClass: 'dark',+ lightClass: [],+ stylePreview: true,+ },+ a11y: {+ // 'todo' - show a11y violations in the test UI only+ // 'error' - fail CI on a11y violations+ // 'off' - skip a11y checks entirely+ test: 'todo',+ },++ layout: 'centered',+ },+};++export default preview;diff --git a/packages/harper-editor/package.json b/packages/harper-editor/package.jsonindex bfbe3c28c..dd4f97514 100644--- a/packages/harper-editor/package.json+++ b/packages/harper-editor/package.json@@ -12,7 +12,10 @@"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"+ "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",+ "storybook": "storybook dev -p 6006",+ "build-storybook": "storybook build",+ "test:storybook": "vitest run --project storybook"},"files": ["dist",@@ -40,6 +43,14 @@"svelte": "^5.0.0"},"devDependencies": {+ "@chromatic-com/storybook": "latest",+ "@storybook/addon-a11y": "^10.6.3",+ "@storybook/addon-docs": "^10.6.3",+ "@storybook/addon-svelte-csf": "latest",+ "@storybook/addon-vitest": "^10.6.3",+ "@storybook/sveltekit": "^10.6.3",+ "@vitest/browser-playwright": "latest",+ "@vueless/storybook-dark-mode": "^10.0.8","@sveltejs/adapter-auto": "^7.0.0","@sveltejs/kit": "^2.47.1","@sveltejs/package": "^2.5.4",@@ -49,13 +60,16 @@"components": "workspace:*","harper.js": "workspace:*","lint-framework": "workspace:*",+ "playwright": "1.60.0","publint": "^0.3.14",+ "storybook": "^10.6.3","quill": "^2.0.3","svelte": "^5.41.0","svelte-check": "^4.3.3","tailwindcss": "^4.1.14","typescript": "catalog:",- "vite": "^7.1.10"+ "vite": "^7.1.10",+ "vitest": "latest"},"keywords": ["svelte"diff --git a/packages/harper-editor/src/lib/Editor.stories.svelte b/packages/harper-editor/src/lib/Editor.stories.sveltenew file mode 100644index 000000000..437f11d17--- /dev/null+++ b/packages/harper-editor/src/lib/Editor.stories.svelte@@ -0,0 +1,15 @@+<script module lang="ts">+import { defineMeta } from '@storybook/addon-svelte-csf';+import { expect, waitFor } from 'storybook/test';+import EditorExample from './stories/EditorExample.svelte';++const { Story } = defineMeta({+ title: 'Editor/Editor',+ component: EditorExample,+});+</script>++<Story name="With suggestions" play={async ({ canvasElement }) => {+ await waitFor(() => expect(canvasElement.querySelector('.harper-editor-surface')).not.toBeNull(), { timeout: 30000 });+}} />+<Story name="Empty" args={{ content: '' }} />diff --git a/packages/harper-editor/src/lib/LintCard.stories.svelte b/packages/harper-editor/src/lib/LintCard.stories.sveltenew file mode 100644index 000000000..ec19163dd--- /dev/null+++ b/packages/harper-editor/src/lib/LintCard.stories.svelte@@ -0,0 +1,22 @@+<script module lang="ts">+import { defineMeta } from '@storybook/addon-svelte-csf';+import LintCard from './LintCard.svelte';+import { exampleLint, exampleSnippet } from './stories/fixtures.js';++const { Story } = defineMeta({+ title: 'Editor/LintCard',+ component: LintCard,+ tags: ['autodocs'],+ args: {+ lint: exampleLint,+ snippet: exampleSnippet,+ onToggleOpen: () => {},+ focusError: () => {},+ onApply: () => {},+ },+});+</script>++<Story name="Closed" />+<Story name="Open" args={{ open: true, active: true }} />+<Story name="No suggestions" args={{ open: true, lint: { ...exampleLint, suggestions: [] } }} />diff --git a/packages/harper-editor/src/lib/LintSidebar.stories.svelte b/packages/harper-editor/src/lib/LintSidebar.stories.sveltenew file mode 100644index 000000000..24ec4716b--- /dev/null+++ b/packages/harper-editor/src/lib/LintSidebar.stories.svelte@@ -0,0 +1,12 @@+<script module lang="ts">+import { defineMeta } from '@storybook/addon-svelte-csf';+import SidebarExample from './stories/SidebarExample.svelte';++const { Story } = defineMeta({+ title: 'Editor/LintSidebar',+ component: SidebarExample,+});+</script>++<Story name="With problems" />+<Story name="All clear" args={{ populated: false }} />diff --git a/packages/harper-editor/src/lib/stories/EditorExample.svelte b/packages/harper-editor/src/lib/stories/EditorExample.sveltenew file mode 100644index 000000000..6a1f5e3c6--- /dev/null+++ b/packages/harper-editor/src/lib/stories/EditorExample.svelte@@ -0,0 +1,41 @@+<script lang="ts">+import type { Linter } from 'harper.js';+import { onMount } from 'svelte';+import Editor from '../Editor.svelte';++export let content = 'Try teh Harper editor. It checks your writing as you type.';+let linter: Linter | undefined;+let error = '';++onMount(() => {+ let active = true;+ /** Load the browser WASM linter before mounting the editor. */+ async function setup() {+ try {+ const [{ LocalLinter }, { slimBinary }] = await Promise.all([+ import('harper.js'),+ import('harper.js/slimBinary'),+ ]);+ const instance = new LocalLinter({ binary: slimBinary });+ await instance.setup();+ if (active) linter = instance;+ } catch (cause) {+ if (active) error = String(cause);+ }+ }+ void setup();+ return () => {+ active = false;+ };+});+</script>++<div style="width: min(900px, 90vw); height: 500px;">+ {#if linter}+ <Editor {content} {linter} />+ {:else if error}+ <p>Could not start Harper: {error}</p>+ {:else}+ <p>Loading Harper…</p>+ {/if}+</div>diff --git a/packages/harper-editor/src/lib/stories/SidebarExample.svelte b/packages/harper-editor/src/lib/stories/SidebarExample.sveltenew file mode 100644index 000000000..7d2d62948--- /dev/null+++ b/packages/harper-editor/src/lib/stories/SidebarExample.svelte@@ -0,0 +1,23 @@+<script lang="ts">+import LintSidebar from '../LintSidebar.svelte';+import type { IgnorableLintBox } from '../types.js';+import { exampleLint } from './fixtures.js';++export let populated = true;++const lintBox: IgnorableLintBox = {+ x: 0,+ y: 0,+ width: 0,+ height: 0,+ lint: exampleLint,+ source: document.createTextNode(exampleLint.source),+ rule: 'Spelling',+ applySuggestion: () => {},+ ignoreLint: async () => {},+};+</script>++<div class="harper-editor" style="height: 450px; display: flex;">+ <LintSidebar lintBoxes={populated ? [lintBox] : []} />+</div>diff --git a/packages/harper-editor/src/lib/stories/fixtures.ts b/packages/harper-editor/src/lib/stories/fixtures.tsnew file mode 100644index 000000000..27fd148ab--- /dev/null+++ b/packages/harper-editor/src/lib/stories/fixtures.ts@@ -0,0 +1,21 @@+import { SuggestionKind } from 'harper.js';+import type { UnpackedLint } from '../types.js';++export const exampleLint: UnpackedLint = {+ span: { start: 4, end: 7 },+ message_html: 'Did you mean <code>the</code>?',+ problem_text: 'teh',+ lint_kind: 'Spelling',+ lint_kind_pretty: 'Spelling',+ suggestions: [{ kind: SuggestionKind.Replace, replacement_text: 'the' }],+ context_hash: 'example-spelling',+ source: 'Try teh editor.',+};++export const exampleSnippet = {+ prefix: 'Try ',+ problem: 'teh',+ suffix: ' editor.',+ prefixEllipsis: false,+ suffixEllipsis: false,+};diff --git a/packages/harper-editor/vite.config.ts b/packages/harper-editor/vite.config.tsindex 3c4c5b808..dea8ffd73 100644--- a/packages/harper-editor/vite.config.ts+++ b/packages/harper-editor/vite.config.ts@@ -1,10 +1,36 @@-import { resolve } from 'node:path';+/// <reference types="vitest/config" />++import { dirname, resolve } from 'node:path';+import { fileURLToPath } from 'node:url';+import { storybookTest } from '@storybook/addon-vitest/vitest-plugin';import { svelte } from '@sveltejs/vite-plugin-svelte';import tailwindcss from '@tailwindcss/vite';+import { playwright } from '@vitest/browser-playwright';import { defineConfig } from 'vite';export default defineConfig({plugins: [tailwindcss(), svelte()],+ test: {+ projects: [+ {+ extends: true,+ plugins: [+ storybookTest({+ configDir: resolve(dirname(fileURLToPath(import.meta.url)), '.storybook'),+ }),+ ],+ test: {+ name: 'storybook',+ browser: {+ enabled: true,+ headless: true,+ provider: playwright({}),+ instances: [{ browser: 'chromium' }],+ },+ },+ },+ ],+ },build: {lib: {entry: resolve(__dirname, 'src/lib/bundle.ts'),diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex 5f40db9d2..3c339af97 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -80,7 +80,7 @@ importers:version: 5.43.12svelte-check:specifier: ^4.0.0tailwindcss:specifier: ^4.2.2version: 4.2.4@@ -274,6 +274,24 @@ importers:packages/harper-editor:devDependencies:+ '@chromatic-com/storybook':+ specifier: latest+ '@storybook/addon-a11y':+ specifier: ^10.6.3+ '@storybook/addon-docs':+ specifier: ^10.6.3+ version: 10.6.3(@types/[email protected](@types/[email protected]))(@types/[email protected])([email protected](@types/[email protected])([email protected]))+ '@storybook/addon-svelte-csf':+ specifier: latest+ version: 5.1.6(@storybook/[email protected]([email protected](@types/[email protected])([email protected]))([email protected]))(@sveltejs/[email protected]([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))([email protected])([email protected](@types/[email protected])([email protected]))([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))+ '@storybook/addon-vitest':+ specifier: ^10.6.3+ version: 10.6.3(@vitest/[email protected])(@vitest/[email protected])([email protected])([email protected](@types/[email protected])([email protected]))([email protected])+ '@storybook/sveltekit':+ specifier: ^10.6.3+ version: 10.6.3(@sveltejs/[email protected]([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))([email protected](@types/[email protected])([email protected]))([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))'@sveltejs/adapter-auto':specifier: ^7.0.0version: 7.0.0(@sveltejs/[email protected](@sveltejs/[email protected]([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])))@@ -292,6 +310,12 @@ importers:'@tailwindcss/vite':specifier: ^4.1.14version: 4.2.4([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))+ '@vitest/browser-playwright':+ specifier: latest+ version: 5.0.5([email protected](@types/[email protected])([email protected]))([email protected])([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))([email protected])+ '@vueless/storybook-dark-mode':+ specifier: ^10.0.8components:specifier: workspace:*version: link:../components@@ -301,12 +325,18 @@ importers:lint-framework:specifier: workspace:*version: link:../lint-framework+ playwright:+ specifier: 1.60.0+ version: 1.60.0publint:specifier: ^0.3.14version: 0.3.15quill:specifier: ^2.0.3version: 2.0.3+ storybook:+ specifier: ^10.6.3+ version: 10.6.3(@types/[email protected])([email protected])svelte:specifier: ^5.41.0version: 5.43.12@@ -322,6 +352,9 @@ importers:vite:specifier: ^7.1.10version: 7.2.2(@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected])+ vitest:+ specifier: latest+ version: 5.0.5(@types/[email protected])(@vitest/[email protected])(@vitest/[email protected])(@vitest/[email protected])([email protected])([email protected](@types/[email protected])([email protected]))([email protected](@types/[email protected])([email protected])([email protected])([email protected])([email protected])([email protected])([email protected]))packages/harper.js:dependencies:@@ -7401,9 +7434,6 @@ packages:resolution: {integrity: sha512-+7IwY/kiGAacQfY+YBhKMvEmyAJnw5grTUgjG85Pe7vcUI/6b7pZjZG8nQ7+48YhzEAEqrEgD2dCz/JIK+AYvw==}- resolution: {integrity: sha512-qqnD1yMU6tk/jnaMosogGySTZP8YtUgAffA9nMN+E/rjxcfRQ6IEk7IiozUjgxKoFHBGjTLnrHB/YC45r/59EQ==}-resolution: {integrity: sha512-jEQoCwk8hyb2AZziIOLhDqpm5+2ww5uIE6lkO/6jcOCusfk6LhMHpXXfBLXTZ7Ydyt0j4VoUQv6uGNYbdW+kBA==}@@ -16203,7 +16233,7 @@ snapshots:'@jest/test-result': 29.7.0'@jest/transform': 29.7.0'@jest/types': 29.6.3- '@jridgewell/trace-mapping': 0.3.25+ '@jridgewell/trace-mapping': 0.3.31'@types/node': 22.13.10chalk: 4.1.2collect-v8-coverage: 1.0.2@@ -16231,7 +16261,7 @@ snapshots:'@jest/[email protected]':dependencies:- '@jridgewell/trace-mapping': 0.3.25+ '@jridgewell/trace-mapping': 0.3.31callsites: 3.1.0graceful-fs: 4.2.11@@ -16296,7 +16326,7 @@ snapshots:'@jridgewell/[email protected]':dependencies:'@jridgewell/gen-mapping': 0.3.8- '@jridgewell/trace-mapping': 0.3.25+ '@jridgewell/trace-mapping': 0.3.31'@jridgewell/[email protected]': {}@@ -16312,7 +16342,7 @@ snapshots:'@jridgewell/[email protected]':dependencies:'@jridgewell/resolve-uri': 3.1.2- '@jridgewell/sourcemap-codec': 1.5.5+ '@jridgewell/sourcemap-codec': 1.6.0'@keyv/[email protected]':dependencies:@@ -16781,7 +16811,7 @@ snapshots:extract-zip: 2.0.1progress: 2.0.3proxy-agent: 6.5.0- semver: 7.7.1+ semver: 7.8.5tar-fs: 3.0.8yargs: 17.7.2transitivePeerDependencies:@@ -16975,7 +17005,7 @@ snapshots:estree-walker: 2.0.2fdir: 6.4.3([email protected])is-reference: 1.2.1- magic-string: 0.30.17+ magic-string: 0.30.21picomatch: 4.0.2optionalDependencies:rollup: 4.35.0@@ -18506,7 +18536,7 @@ snapshots:debug: 4.4.0globby: 11.1.0is-glob: 4.0.3- semver: 7.7.1+ semver: 7.8.5tsutils: 3.21.0([email protected])optionalDependencies:typescript: 5.9.3@@ -18521,7 +18551,7 @@ snapshots:globby: 11.1.0is-glob: 4.0.3minimatch: 9.0.3- semver: 7.7.1+ semver: 7.8.5ts-api-utils: 1.4.3([email protected])optionalDependencies:typescript: 5.9.3@@ -18538,7 +18568,7 @@ snapshots:'@typescript-eslint/typescript-estree': 5.62.0([email protected])eslint: 8.57.1eslint-scope: 5.1.1- semver: 7.7.1+ semver: 7.8.5transitivePeerDependencies:- supports-color- typescript@@ -18552,7 +18582,7 @@ snapshots:'@typescript-eslint/types': 6.21.0'@typescript-eslint/typescript-estree': 6.21.0([email protected])eslint: 8.57.1- semver: 7.7.1+ semver: 7.8.5transitivePeerDependencies:- supports-color- typescript@@ -21210,7 +21240,7 @@ snapshots:dependencies:- semver: 7.7.1+ semver: 7.8.5dependencies:@@ -22087,8 +22117,6 @@ snapshots:- [email protected]: {}-@@ -22489,12 +22517,12 @@ snapshots:dependencies:- '@jridgewell/sourcemap-codec': 1.5.5+ '@jridgewell/sourcemap-codec': 1.6.0'@types/estree': 1.0.8dependencies:- '@jridgewell/sourcemap-codec': 1.5.5+ '@jridgewell/sourcemap-codec': 1.6.0dependencies:@@ -22852,7 +22880,7 @@ snapshots:dependencies:cacheable: 1.8.9- flatted: 3.3.3+ flatted: 3.4.4hookified: 1.8.1@@ -23916,7 +23944,7 @@ snapshots:'@babel/parser': 7.26.10'@istanbuljs/schema': 0.1.3istanbul-lib-coverage: 3.2.2- semver: 7.7.1+ semver: 7.8.5transitivePeerDependencies:- supports-color@@ -24257,7 +24285,7 @@ snapshots:jest-util: 29.7.0natural-compare: 1.4.0pretty-format: 29.7.0- semver: 7.7.1+ semver: 7.8.5transitivePeerDependencies:- supports-color@@ -24602,7 +24630,7 @@ snapshots:js-library-detector: 6.7.0lighthouse-logger: 2.0.1lighthouse-stack-packs: 1.12.2- lodash-es: 4.17.21+ lodash-es: 4.18.1lookup-closest-locale: 6.2.0metaviewport-parser: 0.3.0open: 8.4.2@@ -24889,7 +24917,7 @@ snapshots:dependencies:- semver: 7.7.1+ semver: 7.8.5dependencies:@@ -25602,7 +25630,7 @@ snapshots:dependencies:hosted-git-info: 4.1.0is-core-module: 2.16.1- semver: 7.7.1+ semver: 7.8.5validate-npm-package-license: 3.0.4@@ -26482,7 +26510,7 @@ snapshots:debug: 4.4.0devtools-protocol: 0.0.1413902typed-query-selector: 2.12.0- ws: 8.18.1+ ws: 8.22.0transitivePeerDependencies:- bare-buffer- bufferutil@@ -27786,6 +27814,18 @@ snapshots:svelte: 5.43.12zimmerframe: 1.1.2+ dependencies:+ '@jridgewell/trace-mapping': 0.3.25+ chokidar: 4.0.3+ fdir: 6.4.4([email protected])+ picocolors: 1.1.1+ sade: 1.8.1+ svelte: 5.43.12+ typescript: 5.6.3+ transitivePeerDependencies:+ - picomatch+dependencies:'@jridgewell/trace-mapping': 0.3.25@@ -28399,7 +28439,7 @@ snapshots:dependencies:'@jridgewell/remapping': 2.3.5acorn: 8.15.0- picomatch: 4.0.3+ picomatch: 4.0.7webpack-virtual-modules: 0.6.2@@ -28488,7 +28528,7 @@ snapshots:dependencies:- '@jridgewell/trace-mapping': 0.3.25+ '@jridgewell/trace-mapping': 0.3.31'@types/istanbul-lib-coverage': 2.0.6convert-source-map: 2.0.0@@ -28932,7 +28972,7 @@ snapshots:browserslist: 4.24.4chrome-trace-event: 1.0.4enhanced-resolve: 5.18.1- es-module-lexer: 1.6.0+ es-module-lexer: 1.7.0eslint-scope: 5.1.1events: 3.3.0glob-to-regexp: 0.4.1@@ -29255,7 +29295,7 @@ snapshots:y-protocols: 1.0.6([email protected])yjs: 13.6.24optionalDependencies:- ws: 8.18.1+ ws: 8.22.0transitivePeerDependencies:- bufferutil- supports-color