How automattic/harper works
Harper is a privacy-focused English grammar checker. Users provide text through command-line, editor, browser, desktop, or WebAssembly interfaces; the runtime parses and analyzes it, then exposes lint findings and suggestions to the interface. The core includes document parsing, token-expression matching, and a large rule set, with adapters for markup and code comments. The README documents broad editor and WASM availability; arrows for unsampled integrations are omitted rather than inferred.
Main entry points: document.rs Document model · main.rs CLI commands · lint.rs CLI lint flow · lint_engine.rs Lint engine
Components 22
Core analysis
- Document model
harper-core/src/document.rs - Token expressions
harper-core/src/expr/sequence_expr.rs - Lint rules
harper-core/src/linting/mod.rs - Word metadata
harper-core/src/dict_word_metadata.rs
Text formats
- Markdown parser
harper-core/src/parsers/markdown.rs - Code comments
harper-comments/src/comment_parser.rs - Typst translator
harper-typst/src/typst_translator.rs
User interfaces
- CLI commands
harper-cli/src/main.rs - Input handling
harper-cli/src/input.rs - CLI lint flow
harper-cli/src/lint.rs - Lint engine
harper-cli/src/lint_engine.rs - Lint reporting
harper-cli/src/lint_reporter.rs - WASM interface
harper-wasm/src/lib.rs - JavaScript API
packages/harper.js/src/main.ts
Editor integrations
- Language server
harper-ls/src/main.rs - VS Code extension
packages/vscode-plugin/src/extension.ts - Obsidian plugin
packages/obsidian-plugin/src/index.ts - Chrome extension
packages/chrome-plugin/src/ProtocolClient.ts - Lint popup UI
packages/lint-framework/src/lint/PopupHandler.ts
Desktop app
- Desktop runtime
harper-desktop/src-tauri/src/main.rs - Native highlighter
harper-desktop/src-tauri/src/highlighter/window_manager.rs
Other components
- Writer or developer
Connections 25
- Writer or developer → CLI commands: submits text
README.md - CLI commands → Input handling: selects input
harper-cli/src/main.rs - CLI commands → CLI lint flow: dispatches lint
harper-cli/src/main.rs - CLI lint flow → Input handling: uses input
harper-cli/src/lint.rs - CLI lint flow → Lint engine: runs engine
harper-cli/src/lint.rs - CLI commands → Lint reporting: prints results
harper-cli/src/main.rs - Lint engine → Document model: builds document
- Lint engine → Lint rules: runs rules
harper-cli/src/lint_engine.rs - Document model → Markdown parser: uses parser
harper-core/src/document.rs - Document model → Token expressions: provides tokens
harper-core/src/document.rs - Token expressions → Lint rules: matches patterns
harper-core/src/expr/mod.rs - Document model → Word metadata: uses metadata
harper-core/src/document.rs - Writer or developer → Language server: edits text
README.md - Language server → Language server: starts backend
harper-ls/src/main.rs - Writer or developer → VS Code extension: edits text
- Writer or developer → Obsidian plugin: edits text
- Writer or developer → Chrome extension: edits text
- Chrome extension → Lint popup UI: shows suggestions
- Writer or developer → Desktop runtime: writes text
- Desktop runtime → Native highlighter: starts highlighter
harper-desktop/src-tauri/src/main.rs - Native highlighter → Desktop runtime: requests lint actions
harper-desktop/src-tauri/src/highlighter/window_manager.rs - Writer or developer → WASM interface: checks text
README.md - JavaScript API → WASM interface: wraps runtime
- Typst translator → Document model: adapts text
- Code comments → Document model: adapts text