Comment configurer Harper, un vérificateur grammatical hors ligne sans fuite de données
TuBrief 편집팀
2026년 7월 25일
0
Computing/Software원본 영상을 바탕으로 AI의 도움을 받아 작성했습니다. 원본 영상이 기준입니다.
커뮤니티의 다른 글
댓글 (0)
Log in to leave a comment
아직 작성된 글이 없습니다
원본 영상을 바탕으로 AI의 도움을 받아 작성했습니다. 원본 영상이 기준입니다.
Log in to leave a comment
아직 작성된 글이 없습니다
Lorsque les politiques de sécurité internes bloquent les outils d'IA externes comme Grammarly, les développeurs se retrouvent dans une situation délicate. Laisser des fautes de frappe dans la documentation technique ou dans les commentaires de code nuit à la crédibilité, mais vérifier chaque texte manuellement fait perdre un temps précieux.
Harper résout ce problème de manière élégante. Développé en Rust, ce moteur de vérification grammaticale fonctionne exclusivement en local et bloque totalement toute communication avec des serveurs externes. Contrairement à LanguageTool, basé sur Java et gourmand en ressources avec ses centaines de mégaoctets de mémoire, Harper ne consomme que quelques dizaines de mégaoctets. Avec un temps de réponse inférieur à 10 ms, il ne ralentira jamais votre éditeur.
harper-ls effectue l'analyse syntaxique en utilisant uniquement les ressources CPU locales de votre machine. Il suffit d'installer le binaire via le gestionnaire de paquets de votre système d'exploitation et de l'enregistrer comme LSP standard dans votre éditeur.
Exécutez la commande suivante dans le terminal pour installer le binaire.
brew install harpercargo install harper-ls --lockedscoop install harperDans Neovim, configurez les types de fichiers cibles et les règles du linter avec 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
}
}
}
})
`
Si vous utilisez l'API LSP native de Neovim 0.11 ou supérieure, configurez vim.lsp.config['harper'] et appelez vim.lsp.enable('harper'). Pour les utilisateurs de VS Code, il suffit d'installer l'extension elijah-potter.harper puis d'indiquer le chemin "harper.path": "/usr/local/bin/harper-ls" dans .vscode/settings.json.
Harper intègre un parseur AST basé sur Tree-sitter, ce qui lui permet d'ignorer le code source réel et de cibler uniquement le texte en anglais dans les blocs de commentaires. Si vous souhaitez exclure complètement les commentaires d'une fonction spécifique, ajoutez une directive en ligne.
`javascript
// harper:ignore
function processInternalSecurityToken() {
// spellcheck:ignore
// 내부 보안 토큰 로직
}
`
Si vous utilisez uniquement le dictionnaire anglais par défaut, des termes techniques tels que gRPC, OAuth2 ou Prometheus seront tous détectés comme des erreurs. L'utilisation d'une structure de dictionnaire hiérarchique permet d'éliminer rapidement le bruit des avertissements.
Harper valide les mots à travers 4 niveaux distincts.
| Niveau de dictionnaire | Emplacement de stockage | Objectif |
|---|---|---|
| Static Dictionary | Intégré au binaire harper-ls |
Base de données de mots anglais de base non modifiable |
| User Dictionary | ~/.config/harper-ls/dictionary.txt |
Dictionnaire global pour l'environnement de développement personnel |
| Workspace Dictionary | .harper-dictionary.txt à la racine du projet |
Dictionnaire de termes spécifiques au projet (géré par Git) |
| File-Local Dictionary | Stocké dans le dossier de données de l'OS | Stockage d'identifiants spécifiques à un seul fichier |
.harper-dictionary.txt à la racine du projet.`text
Kubernetes
gRPC
OAuth2
OpenTelemetry
Prometheus
mTLS
Netty
Etcd
`
Ctrl + ., Neovim : raccourci Code Action) pour ajouter directement le mot concerné à .harper-dictionary.txt.Il suffit ensuite de committer ce fichier sur le dépôt Git pour que tous les membres de l'équipe partagent la même liste de mots.
Désactivez les règles contraignantes lors de la rédaction de commentaires.
SentenceCapitalization : Définissez sur false pour désactiver la majuscule obligatoire sur le premier lettre d'un commentaire.LongSentences : Définissez sur false pour ignorer les avertissements sur les phrases longues, fréquentes dans la documentation technique.SpellCheck et UnclosedQuotes : Conservez à true pour détecter les fautes d'orthographe et les guillemets non fermés.Les fautes de frappe manquées par le développeur dans son éditeur doivent être bloquées au moment de la Pull Request. En intégrant l'outil CLI harper-cli dans votre pipeline, vous pouvez filtrer automatiquement les erreurs grammaticales avant la fusion dans la branche principale.
Définissez une tâche dans le fichier .github/workflows/harper-lint.yml pour analyser uniquement les fichiers Markdown modifiés.
`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
`
En committant le fichier .harper-dictionary.txt à la racine du projet, le runner CI effectuera la vérification sur la base de la même liste de mots que celle utilisée dans l'éditeur. Si vous utilisez un générateur de site statique (SSG) comme MkDocs ou Docusaurus, il est plus sûr de configurer l'exécution de la commande harper-cli lint docs/ juste avant le script de build.