speller.md

Инструкция по проверке орфографии

У Доки есть встроенная проверка орфографии на основе yaspeller.

Как работает

Проверка запускается автоматически при создании пулреквеста, однако вы можете запускать её и локально.

Для этого вам понадобится команда npx yaspeller --only-errors --file-extensions ".md,.html" *. Чтобы её запустить, у вас должен быть установлен Node.js, желательно последняя LTS-версия.

Вы можете отредактировать это выражение, чтобы протестировать только те файлы, которые вы меняли.

Словарь исключений

Иногда в статьях мы используем слова, которых yaspeller не знает — сленг, термины, имена собственные и т. п.

👆 Прежде чем добавить исключение в словарь, проверьте, что это слово действительно так пишется — например, на портале «Грамота». Или, если это переводной термин, и его нет в словаре терминов по фронтенду, по выборке гугла — распространён ли выбранный вами вариант.

Чтобы проверка прошла успешно, слова-исключения нужно добавить в специальный файл .yaspeller.json, который лежит в корне проекта.

Мы рекомендуем именно этот способ работы с исключениями.

Однако yaspeller позволяет экранировать слова и прямо внутри текста статьи при помощи специальных тегов.

Строка

<span class="quote__text-letter">Р</span>азумные люди приспосабливаются к окружающему <!-- yaspeller ignore -->

Отдельное слово

<!-- yaspeller ignore:start -->слово-исключение<!-- yaspeller ignore:end -->

Используйте этот способ в случае, когда вам нужно показать неправильный пример или слово, разбитое на части, как в примере выше. В остальных случаях лучше добавить слово в словарь исключений.

Как добавлять слова в словарь исключений

В файле .yaspeller.json есть блок dictionary:

"dictionary": [
  "ааа",
  "автодополнение",
]

Именно в него добавляются исключения: в кавычках, через запятую и перенос строки. Обратите внимание, что отступы тоже важны.

Бывает, что в исключения нужно добавить слово в нескольких формах. Для этого используется специальная запись: вариативное окончание берётся в скобки, и через прямой разделитель указываются варианты:

"dictionary": [
  "контрибьютор(а|ов)",
]

Нулевое окончание указывается при помощи одиночного разделителя:

"dictionary": [
  "ховер(у|)",
]

В этом примере в исключения попало и слово «ховер» и слово «ховеру».

Мы рекомендуем слова разных частей речи добавлять по отдельности:

"dictionary": [
  "контрибьютить",
  "контрибьютор(а|ов)",
]

Так удобнее записывать вариативные окончания.

⛔️ Не добавляйте все вариативные окончания, которые придут вам в голову, сразу — только те, которые есть в вашей статье. Не будем раздувать словарь исключений без необходимости.

Добавьте исключение в словарь и отправьте вместе с вашим пулреквестом. Редактор придёт в пулреквест, чтобы проверить и одобрить изменения.