Лінтер Vale

Дізнайтеся, як налаштувати та використовувати лінтер Vale linter.

  Менше хвилини читання  

У цьому розділі наведено покрокові вказівки щодо встановлення та використання лінтера Vale.

У цих інструкціях я ділюсь досвідом встановлення та використання лінтера Vale linter. Щоб дізнатись більше про Vale, див. документацію Vale.

Розробники використовують лінтери для автоматичної перевірки якості коду. Щоб дізнатися більше про лінтери, див. статтю Що таке лінтер, і чому ваша команда повинна ним користуватися?

Техрайтери використовують лінтер Vale linter, щоб перевіряти, чи відповідає текст у їх файлах Markdown (HTML, AsciiDoc тощо) вимогам стайлгайдів Microsoft, Google тощо. Файл конфігурації Vale містить шлях до папки стайлгайдів. Кожен стайлгайд має свої правила у вигляді регулярних виразів. Коли ви запускаєте Vale, він шукає слова та вирази у вашому тексті та показує помилки та невідповідність підключеним стайлгайдам. Крім того, ви можете створити список прийнятих слів та список слів, які слід відхилити. Vale виводить попередження, якщо ви використовуєте слова зі списку відхилених.

Як встановити Vale на Windows

Використовуйте цю інструкцію, щоб встановити лінтер Vale на Windows.

Налаштувати Vale

Використовуйте цю інструкцію для налаштування Vale. Ви дізнаєтесь, як додати файли, необхідні Vale для перевірки файлів Markdown.

Стайлгайди, лінтери, Vale: навіщо це техрайтерам?

У цій статті я розповім про стайлгайди, якими користуються техрайтери, і чому це важливо. Ви дізнаєтеся про лінтер, яким користуються техрайтери — про це мало інформації в інтернеті. Я розповім, як налаштувати лінтер Vale для перевірки текстів на відповідність вимогам стайлгайдів Microsoft і Google, а також як створити власний стайлгайд для Vale.


Останні зміни 09.03.2023: first commit (98b8333)