Пишите как профессионал с помощью vale и neovim

Vale — это синтаксически грамотный редактор прозы, созданный для всех пишущих людей. К настоящему времени vale выпустил более 100 релизов — это проект пятилетней давности, который используется пишущими людьми в таких компаниях, как Google, Microsoft, IBM, RedHat и многих других. Я недавно начал использовать vale в своем ежедневном рабочем процессе, и он оказывает значительное влияние на то, какие слова я выбираю для передачи идей. Я в основном использую neovim для написания текстов, поэтому мы рассмотрим, как настроить vale и использовать его с neovim.

Так же как при написании программного обеспечения мы используем инструменты статического анализа для поиска общих проблем, vale призван помочь писателям определить, какие слова/прозы выбрать при написании технической документации.

Установка vale

Загрузите последнюю версию vale со страницы релизов на github.

Стили написания и конфигурация vale

Vale требует наличия конфигурационного файла .vale.ini, расположенного либо в вашей директории $HOME, либо в родственной директории проекта. Ниже приведен пример конфигурации, которую я использую лично

# This goes in a file named either `.vale.ini` or `_vale.ini`.
StylesPath = styles
MinAlertLevel = suggestion

# External packages
Packages = Google, Readability, alex, proselint, IBM
# Only Markdown and .txt files; change to whatever you're using.
[*.{md,txt}]
# List of styles to load.
BasedOnStyles = alex, proselint

Войти в полноэкранный режим Выйти из полноэкранного режима

Как только вы создадите этот файл, запустите vale sync для загрузки/обновления всех внешних пакетов, которые вы указали в конфигурации.

Стиль vale — это хранилище «правил», которые определяют, какие слова должны сообщаться vale. Правила определяются в файле yml.

Если вы предпочитаете самостоятельно настраивать конфигурацию, я рекомендую использовать генератор конфигурации.

Проект vale разработал 7 пакетов стилей. Некоторые из популярных стилей основаны на правилах написания от таких организаций, как Google & Microsoft, некоторые из них перечислены ниже:

  1. Microsoft Writing Style Guide
  2. Руководство по стилю документации для разработчиков Google
  3. Руководство по стилю написания документации для разработчиков от IBM

Вы можете найти больше стилей vale на github в теме vale-style.

Если вы работаете с командой писателей в организации, я бы предложил использовать стили от Google и Microsoft, которые более строгие, но хорошо подходят для команд. Если у вас личный блог или вы пишете в одиночку, используйте такие стили, как alex или proselint, чьи правила более мягкие. Я рекомендую попробовать все правила, переключив свойство BasedOnStyles в конфигурации vale.

Настройка Neovim

Плагин null-ls.nvim neovim позволяет использовать vale в качестве линтера прозы.

Установите null-ls.nvim с помощью Plug.

Plug 'jose-elias-alvarez/null-ls.nvim'

Войдите в полноэкранный режим Выйти из полноэкранного режима

Требуется плагин lua,

require("null-ls").setup({
    sources = {
        require("null-ls").builtins.diagnostics.vale,
    },
})

Войти в полноэкранный режим Выйти из полноэкранного режима

Если вы используете родной конфиг vim, используйте lua HERE doc.

lua << EOF
require("null-ls").setup({
    sources = {
        require("null-ls").builtins.diagnostics.vale,
    },
})
EOF

Вход в полноэкранный режим Выход из полноэкранного режима

Убедитесь, что у вас есть .vale.ini или _vale.ini где-нибудь в $HOME или в текущей рабочей директории.

Вот как выглядят предложения в редакторе

Как вы можете видеть, некоторые предложения отображаются NeoVim некорректно. Чтобы исправить это, вы можете использовать плагин trouble.nvim, чтобы получить красивый VSCode интерфейс для диагностики.

Вот и все, приятного написания!

Оцените статью
Procodings.ru
Добавить комментарий