Automattic/harper
Harper
Harper is a local English linter and grammar checker designed as an IDE writing assistant. It operates as a language server that provides real-time spelling and grammar analysis for markdown and code comments, processing all linguistic data on the local device to ensure privacy and eliminate cloud dependencies.
The tool is specialized for technical documentation, featuring the ability to identify and ignore text within code fences and inline blocks to prevent false positives. It allows for personalized configuration through custom dictionaries and the use of suppression comments to exclude specific text regions from analysis.
The system provides actionable diagnostic mapping that enables quick-fix error resolution and grammar fix applications directly within a text editor.
Features
- Writing Assistance Tools - Provides real-time linguistic suggestions and quick-fix actions directly within a text editor via a language server.
- Grammar Checkers - Provides a local language server for real-time spelling and grammar linting within editors.
- Text Correction - Enables the correction of identified linguistic errors directly within the text editor using actionable suggestions.
- Local Grammar Checkers - Analyzes text for spelling and grammar errors on a local device to ensure data privacy and eliminate cloud dependencies.
- LSP Integration - Communicates with a language server protocol to identify grammar and spelling errors and return diagnostic data.
- Spelling and Error Correction - Provides mechanisms to correct spelling or grammar mistakes and add unknown words to custom dictionaries.
- Prose Linters - Validates writing quality in technical documents and markdown while specifically ignoring code fences.
- Local Grammar Analyzers - Analyzes text for grammatical errors using a local engine to ensure data privacy during the linting process.
- Custom Dictionaries - Maintains a local store of user-approved words to override default spelling and grammar rules.
- Local-First Privacy Tools - Processes linguistic analysis on the user device to ensure data privacy and eliminate dependencies on cloud services.
- Content Linting Pipelines - Checks grammar and spelling within markdown files and code comments to improve the quality of technical documentation.
- Documentation Prose Filtering - Automatically skips analysis of text within code fences and inline blocks to prevent false positives in technical documentation.
- Prose Block Detection - Identifies and excludes text within markdown code fences and inline blocks to prevent false positive linting.
- Linguistic Analysis Exclusions - Disables grammar checking for selected sections of text through the use of specific comments within the document.
- Diagnostic Offset Mappings - Maps language server errors to specific text offsets to provide direct inline fixes and suggestions.
- Analysis Suppression Mechanisms - Allows users to skip specific blocks of text using ignore keywords to prevent unwanted error flags in the editor.
- Real-time Text Linting - Provides grammar and spelling checks within supported editors via a language server to ensure high writing quality.
- Prose Polishing Tools - Cleans up prose in technical files while ignoring code blocks and specific sections to prevent false positives.
- Analysis Suppression Markers - Parses the document for specific ignore markers to skip analysis of designated text regions.
