Борьба с грамматическими ошибками в markdown файлах

Заметили большое количество грамматических, орфографических и пунктуационных ошибок в текстах статей нашего блога.

Поняли что с этим надо бороться и начали искать варианты.

Посты мы пишем в markdown файлах, используя VS Code, поэтому начали искать линтер с возможностью проверки грамматики, орфографии и пунктуации.

Ранее мы уже использовали расширение code-spell-checker поэтому решили попробовать его и в этот раз.

Но сразу столкнулись с парой проблем:

• отсутствие поддержки русского языка из коробки;
• отсутствие проверки функций проверки грамматики и пунктуации;

Первая проблема легко решается установкой расширения с русским словарём russian-code-spell-checker.

А вот вторая проблема не решается в рамках данного решения.

Довольно быстро нашли другое решение - LTеX.

Основные особенности LTeX:

• Поддержка Markdown, BibTEX, ConTEXt, LATEX, Org, reStructuredText, R Sweave, XHTML;
• Работает полностью локально, не делает запросов в интернет;
• Поддержка более 20 языков, в том числе русского;
• Поддержка Quick fix и подсветка ошибок;
• Поддержка пользовательских словарей;
• Нормальная документация;

Для того чтобы включить и использовать LTeX для русского языка в VS Code надо:

• Установить расширение;
• В настройках расширения, либо в файле settings.json установить следующие настройки:

  "ltex.language": "ru-RU",
  "ltex.additionalRules.motherTongue": "ru-RU"

Вот так выглядит подсветка ошибок в файле:

Подсветка ошибок в файле

Вот так ошибки выглядят при наведении на них:

Ошибки при наведении

Вот так выглядит меню Quick fix:

Меню Quick fix

Так же можно добавлять слова и правила в исключения:

Исключения

При этом генерируются .txt файлы с добавленными словами и исключениями для каждого языка.

Пример ltex.dictionary.ru-RU.txt:

бакет
захостить

На этом всё! 🎉