Тут знаходиться вміст вебдокументації з WebDoky. Фактично це статті з MDN, перекладені українською (див. ліцензію на вміст цього репозиторію)
У репозиторій вбудована перевірка тексту в репозиторії за допомогою LanguageTool CLI. Це працює при створенні PR.
Щоб додати слово незнайоме LanguageTool, але котре LanguageTool мусить використовувати для створення пропозицій виправлень - додайте його окремим рядком у файл uk_spelling_additions.txt
.
Щоб додати слово незнайоме LanguageTool, котре слід просто ігнорувати - додайте його окремим рядком у файл uk_ignore_additions.txt
(у більшості випадків слід віддавати перевагу uk_spelling_additions.txt
).
Щоб заборонити слово, котре LanguageTool обробляє як нормативне - додайте його окремим рядком у файл uk_prohibited_additions.txt
.
Внесені зміни спрацюють при наступній перевірці після оновлення PR.
Щоб вимкнути певне правило LanguageTool - додайте його окремим рядком у файл disabled_rules.txt
.
Внесені зміни спрацюють при наступній перевірці після оновлення PR.
- Знаходить нові зміни в
index.md
файлах (або новіindex.md
файли). Якщо змінено не 1 файл, а більше або нуль – зупиняється з помилкою. - З'ясовує тип змін: оновлення або новий переклад.
- Формує на основі шляху до зміненого Markdown файлу назву гілки.
- Перевіряє, чи не існує цільова гілка на віддаленому репозиторії. Якщо існує – зупиняється з помилкою. (Злиті гілки повинні бути видалені вручну на GitHub.)
- Видаляє стару локальну гілку з такою ж назвою, якщо вона існує.
- Переходить в гілку
master
. - Стягує оновлення в
master
. - Створює цільову гілку заново та переходить в неї.
- Додає директорію з перекладом (де лежить
index.md
файл) до майбутнього коміту. - Додає до майбутнього коміту файли з припасуваннями LanguageTool (
./*_additions.txt
). - Створює коміт з автоматично створеним повідомленням.
- Надсилає оновлення в гілці на GitHub.
Тобто, якщо стисло, цей сценарій створює гілку на основі шляху до файлу та надсилає її на GitHub. PR повинен бути створений вручну.
Викликається в один з наступних способів:
yarn finishupdate
yarn fu
Щоб цей сценарій працював, потрібно самотужки перейти в гілку, яку необхідно оновити.
- Знаходить нові зміни в
index.md
файлах (або новіindex.md
файли). Якщо змінено не 1 файл, а більше або нуль – зупиняється з помилкою. - З'ясовує тип змін: оновлення або новий переклад.
- Формує на основі шляху до змінено Markdown файлу назву гілки. (Ця назва повинна в подальшому збігатися з поточною гілкою, щонайменше в частині після
/
). - Переходить в гілку
master
. - Стягує оновлення в
master
. - Переходить до цільової гілки.
- Додає директорію з перекладом (де лежить
index.md
файл) до майбутнього коміту. - Додає до майбутнього коміту файли з припасуваннями LanguageTool (
./*_additions.txt
). - Створює коміт з автоматично створеним повідомленням.
- Надсилає оновлення в гілці на GitHub.
Тобто, якщо стисло, цей сценарій додає до наявного перекладу чи оновлення новий коміт із виправленнями, а також надсилає його.
Викликається в один з наступних способів (наприклад, коли потрібна гілка chore/update-deps
):
yarn finishupdate --update
yarn fu --update
yarn fux