vale-cli/vale

Что это?

Ключевые возможности

• 01Перед проверкой разбирает Markdown, AsciiDoc, reStructuredText, HTML и другие форматы разметки.
• 02Извлекает комментарии и docstrings из исходного кода для проверки.
• 03Правила задаются в YAML и охватывают всё — от замены токенов до проверок частей речи и читабельности.
• 04В комплект входят опубликованные пакеты стилей, например Microsoft и Google; синхронизировать их можно одной командой.
• 05Правила могут включать автоматические исправления, которые применяют редакторы и агенты.
• 06Работает офлайн на macOS, Windows и Linux в виде единого бинарного файла на Go.

Сценарии использования

• Соблюдение гайда по стилю компании или проекта во всей технической документации.
• Выявление непоследовательного употребления терминов, например названий продуктов в документации.
• Запуск проверок прозы в CI для автоматической проверки pull request с документацией.
• Проверка docstrings и комментариев в коде вместе с кодом, который они описывают.

Быстрый старт

1. 1

   Установите Vale на macOS с помощью Homebrew

   brew install vale
2. 2

   Создайте файл конфигурации .vale.ini в корне проекта

3. 3

   Скачайте настроенные стили

   vale sync
4. 4

   Проверьте линтером файл, например README.md

   vale README.md

Что важно знать

• !Для некоторых платформ указан только способ установки через Go; для других способов потребуется пакетный менеджер, доступный в вашей системе.
• !Разработкой Vale занимается в основном один сопровождающий, поэтому поддержка и скорость разработки зависят от него.

Темы

Частые вопросы

Что такое vale?

Офлайн-линтер прозы для командных правил стиля: работает в редакторах, CI и коде. Vale — линтер прозы, который превращает рекомендации по письму в автоматические проверки. У него нет собственных предубеждений: команды могут выбрать опубликованный гайд по стилю, например Microsoft или Google, добавить свои термины или объединить оба варианта, а Vale применит эти правила к Markdown, AsciiDoc, reStructuredText, HTML и другим форматам документов.

vale можно использовать бесплатно? Какая у него лицензия?

vale распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

vale всё ещё поддерживается?

Активно поддерживается. Последний коммит в vale — 16 окт. 2026 г..

Для чего можно использовать vale?

Соблюдение гайда по стилю компании или проекта во всей технической документации. Выявление непоследовательного употребления терминов, например названий продуктов в документации. Запуск проверок прозы в CI для автоматической проверки pull request с документацией. Проверка docstrings и комментариев в коде вместе с кодом, который они описывают.

Как установить vale?

Установите Vale на macOS с помощью Homebrew: brew install vale Создайте файл конфигурации .vale.ini в корне проекта Скачайте настроенные стили: vale sync Проверьте линтером файл, например README.md: vale README.md

Где скачать vale?

Исходный код и инструкции по установке — на GitHub: https://github.com/vale-cli/vale