Как настроить автономный грамматический справочник Harper без утечки данных наружу
TuBrief 편집팀
2026년 7월 25일
0
Computing/Software원본 영상을 바탕으로 AI의 도움을 받아 작성했습니다. 원본 영상이 기준입니다.
커뮤니티의 다른 글
댓글 (0)
Log in to leave a comment
아직 작성된 글이 없습니다
원본 영상을 바탕으로 AI의 도움을 받아 작성했습니다. 원본 영상이 기준입니다.
Log in to leave a comment
아직 작성된 글이 없습니다
Когда из-за политики безопасности компании сторонние ИИ-инструменты вроде Grammarly заблокированы, разработчики оказываются в затруднительном положении. Если выпустить техническую документацию или комментарии к коду с опечатками, это снизит уровень доверия к проекту, но проверять всё вручную — слишком большая трата времени.
Harper отлично решает эту проблему. Это автономный движок проверки грамматики, написанный на Rust, который полностью блокирует сетевое взаимодействие с внешними серверами. В отличие от LanguageTool, который работает на Java и потребляет сотни мегабайт оперативной памяти, Harper расходует всего порядка десяти мегабайт. А благодаря скорости отклика менее 10 мс он совершенно не замедляет работу редактора.
harper-ls выполняет синтаксический анализ локально, используя только ресурсы процессора вашего устройства. Достаточно установить бинарный файл через пакетный менеджер вашей операционной системы и зарегистрировать его в редакторе как стандартный LSP.
Выполните команду в терминале для установки бинарного файла.
brew install harpercargo install harper-ls --lockedscoop install harperВ Neovim настройки типов файлов и правил линтера задаются через 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
}
}
}
})
`
При использовании нативного LSP API в Neovim 0.11 или выше настройте vim.lsp.config['harper'] и вызовите vim.lsp.enable('harper'). Пользователям VS Code достаточно установить расширение elijah-potter.harper и указать путь "harper.path": "/usr/local/bin/harper-ls" в файле .vscode/settings.json.
В Harper встроен парсер Tree-sitter AST, поэтому он пропускает сам исходный код и проверяет только англоязычный текст внутри блоков комментариев. Если вы хотите полностью исключить комментарии к конкретной функции из проверки, добавьте инлайн-директиву.
`javascript
// harper:ignore
function processInternalSecurityToken() {
// spellcheck:ignore
// 내부 보안 토큰 로직
}
`
Если использовать только базовый словарь английских слов, такие технические термины, как gRPC, OAuth2 или Prometheus, будут помечаться как ошибки. Использование иерархической структуры словарей позволяет быстро избавиться от лишних предупреждений.
Harper проверяет слова по 4 уровням.
| Уровень словаря | Место хранения | Назначение |
|---|---|---|
| Static Dictionary | Встроен в бинарник harper-ls |
Неизменяемая базовая база английских слов |
| User Dictionary | ~/.config/harper-ls/dictionary.txt |
Глобальный словарь для личного окружения разработки |
| Workspace Dictionary | .harper-dictionary.txt в корне проекта |
Словарь терминов конкретного проекта (под Git) |
| File-Local Dictionary | Сохраняется в директории данных ОС | Хранение идентификаторов для одного конкретного файла |
.harper-dictionary.txt в корневой директории проекта.`text
Kubernetes
gRPC
OAuth2
OpenTelemetry
Prometheus
mTLS
Netty
Etcd
`
Ctrl + . в VS Code или соответствующий хоткей Code Action в Neovim) и добавьте это слово напрямую в .harper-dictionary.txt.Достаточно закоммитить этот файл в Git-репозиторий, и вся команда будет использовать единый список слов.
Отключите неудобные правила для написания комментариев.
SentenceCapitalization: установите значение false, чтобы отключить требование писать первую букву комментария с заглавной.LongSentences: установите значение false, чтобы отключить предупреждения о длинных предложениях, характерных для технической документации.SpellCheck и UnclosedQuotes: оставьте true для проверки орфографических ошибок и незакрытых кавычек.Опечатки, пропущенные разработчиком в редакторе, должны блокироваться на этапе Pull Request. Подключение CLI-инструмента harper-cli к пайплайну позволяет автоматически отсеивать грамматические ошибки до слияния с основной веткой.
В файле .github/workflows/harper-lint.yml определите задачу, которая будет проверять только измененные Markdown-файлы.
`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
`
Если закоммитить файл .harper-dictionary.txt в корень проекта, CI-раннер также будет выполнять проверку на основе того же списка слов, что и в редакторе. Если вы используете генераторы статических сайтов (SSG), такие как MkDocs или Docusaurus, надежнее настроить выполнение команды harper-cli lint docs/ непосредственно перед запуском скрипта сборки.