Written with AI assistance from the source video. The video is the authority.
Log in to leave a comment
No posts yet
Wenn externe KI-Tools wie Grammarly aufgrund von Unternehmenssicherheitsrichtlinien blockiert sind, stehen Entwickler vor einer Herausforderung. Das Veröffentlichen von technischen Dokumentationen oder Code-Kommentaren mit Tippfehlern mindert das Vertrauen, aber jedes Detail manuell per Auge zu prüfen, kostet wertvolle Zeit.
Harper löst dieses Problem auf elegante Weise. Da es sich um eine in Rust entwickelte Offline-Grammatikprüfengine handelt, wird jegliche Kommunikation mit externen Servern vollständig blockiert. Im Gegensatz zu LanguageTool, das auf Java basiert und hunderte Megabyte Arbeitsspeicher verbraucht, liegt der Speicherverbrauch von Harper lediglich im Bereich von einigen Dutzend Megabyte. Mit einer Antwortzeit von unter 10 ms wird der Editor zu keinem Zeitpunkt verlangsamt.
harper-ls führt die Syntaxanalyse ausschließlich unter Nutzung lokaler CPU-Ressourcen innerhalb des Endgeräts durch. Sie müssen lediglich das Binary über den Paketmanager Ihres Betriebssystems installieren und es als Standard-LSP in Ihrem Editor registrieren.
Führen Sie den Befehl im Terminal aus, um das Binary zu installieren.
brew install harpercargo install harper-ls --lockedscoop install harperIn Neovim konfigurieren Sie die Zieldateitypen und Linter-Regeln über nvim-lspconfig.
`lua
local lspconfig = require('lspconfig')
lspconfig.harper_ls.setup({
filetypes = { 'markdown', 'gitcommit', 'rust', 'go', 'typescript', 'python' },
settings = {
["harper-ls"] = {
userDictPath = "~/config/harper/user_dict.txt",
workspaceDictPath = ".harper-dictionary.txt",
linters = {
SpellCheck = true,
SpelledNumbers = false,
AnA = true,
SentenceCapitalization = false,
UnclosedQuotes = true,
WrongApostrophe = false,
LongSentences = true,
RepeatedWords = true,
Spaces = true,
CorrectNumberSuffix = true
}
}
}
})
`
Wenn Sie die native LSP-API ab Neovim 0.11 verwenden, konfigurieren Sie vim.lsp.config['harper'] und rufen vim.lsp.enable('harper') auf. VS Code-Benutzer installieren einfach die Erweiterung elijah-potter.harper und geben anschließend den Pfad "harper.path": "/usr/local/bin/harper-ls" in der Datei .vscode/settings.json an.
Harper verfügt über einen integrierten Tree-sitter AST-Parser, sodass eigentlicher Quellcode übersprungen und gezielt nur englischer Text innerhalb von Kommentarblöcken geprüft wird. Wenn Sie die Kommentare einer bestimmten Funktion vollständig von der Prüfung ausschließen möchten, fügen Sie eine Inline-Direktive ein.
`javascript
// harper:ignore
function processInternalSecurityToken() {
// spellcheck:ignore
// 내부 보안 토큰 로직
}
`
Wenn Sie nur das englische Standardwörterbuch ausführen, werden technische Begriffe wie gRPC, OAuth2 oder Prometheus ausnahmslos als Fehler eingestuft. Durch die Nutzung einer hierarchischen Wörterbuchstruktur lassen sich störende Warnungen schnell beseitigen.
Harper überprüft Wörter über vier Ebenen.
| Wörterbuchebene | Speicherort | Zweck |
|---|---|---|
| Static Dictionary | In harper-ls-Binary integriert |
Nicht veränderbare Datenbank für englische Standardwörter |
| User Dictionary | ~/.config/harper-ls/dictionary.txt |
Globales Wörterbuch für die persönliche Entwicklungsumgebung |
| Workspace Dictionary | .harper-dictionary.txt im Projekt-Root |
Projektspezifisches Begriffswörterbuch (über Git verwaltet) |
| File-Local Dictionary | Im OS-Datenpfad gespeichert | Bezeichnerspeicher speziell für eine einzelne Datei |
.harper-dictionary.txt im Root-Verzeichnis des Projekts.`text
Kubernetes
gRPC
OAuth2
OpenTelemetry
Prometheus
mTLS
Netty
Etcd
`
Strg + ., Neovim: Code Action Keybinding), um das entsprechende Wort direkt zu .harper-dictionary.txt hinzuzufügen.Sobald diese Datei im Git-Repository committet wird, teilen alle Teammitglieder dieselbe Wortliste.
Schalten Sie störende Regeln beim Verfassen von Kommentaren aus.
SentenceCapitalization: Auf false setzen, um die Regel für erzwungene Großschreibung des ersten Buchstabens in Kommentaren zu deaktivieren.LongSentences: Auf false setzen, um Warnungen vor zu langen Sätzen zu deaktivieren, die für technische Dokumentationen typisch sind.SpellCheck und UnclosedQuotes: Belassen Sie die Überprüfung auf Rechtschreibfehler und nicht geschlossene Anführungszeichen auf true.Tippfehler, die Entwickler im Editor übersehen haben, sollten in der PR-Phase abgefangen werden. Durch die Anbindung des CLI-Tools harper-cli an die Pipeline werden Grammatikfehler vor dem Merge in den Main-Branch automatisch herausgefiltert.
Definieren Sie in der Datei .github/workflows/harper-lint.yml einen Job, der gezielt nur die geänderten Markdown-Dateien prüft.
`yaml
name: Technical Documentation Linting
on:
pull_request:
paths:
- 'docs/'
- '.md'
jobs:
harper-grammar-check:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install Rust Toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cache Harper CLI Binary
uses: actions/cache@v3
with:
path: ~/.cargo/bin/harper-cli
key: ${{ runner.os }}-harper-cli-${{ hashFiles('**/Cargo.lock') }}
- name: Install Harper CLI
run: |
if ! command -v harper-cli &> /dev/null; then
cargo install harper-cli --locked
fi
- name: Get Changed Markdown Files
id: changed-files
run: |
git fetch origin ${{ github.base_ref }}
FILES=$(git diff --name-only --diff-filter=AM origin/${{ github.base_ref }} HEAD | grep '\.md$' || true)
echo "files=$FILES" >> $GITHUB_OUTPUT
- name: Run Harper Lint Check
if: steps.changed-files.outputs.files != ''
run: |
ERRORS=0
for file in ${{ steps.changed-files.outputs.files }}; do
echo "Linting $file with Harper..."
harper-cli lint "$file" || ERRORS=$((ERRORS+1))
done
if [ $ERRORS -gt 0 ]; then
echo "Harper validation failed with $ERRORS error(s)."
exit 1
fi
`
Wenn Sie auch die Datei .harper-dictionary.txt im Projekt-Root committen, führt der CI-Runner die Prüfung auf Basis derselben Wortliste wie der Editor durch. Bei der Verwendung statischer Website-Generatoren (SSG) wie MkDocs oder Docusaurus ist es sicherer, das Skript so zu konfigurieren, dass der Befehl harper-cli lint docs/ unmittelbar vor der Ausführung des Build-Skripts ausgeführt wird.