Джерело
Node.js Recipes | Навіщо потрібен пакет sentences-per-line?Сьогодні хочу порекомендувати...
2 400 Охват/переглядів
2025-04-16 15:32
Повідомлення №810
Навіщо потрібен пакет sentences-per-line?Сьогодні хочу порекомендувати вам пакет, але спочатку поясню, навіщо він потрібен. Почнемо з документації.Стандартним форматом документації в розробці є Markdown. Причому ми все частіше пишемо її не лише для інженерів, а й для LLM. Приклади – .cursor/rules, copilot-instructions.md. Важливо підтримувати документацію в актуальному стані. Її оновлення завжди було частиною Definition of Done, але зараз це стало простіше – багато завдань можна делегувати AI-агентам. Нам залишається лише зробити ревʼю.Під час ревʼю виникає проблема: великі абзаци складно перевіряти. Звичайні Markdown-лінтери не вирішують цю задачу. І тут на допомогу приходить пакет sentences-per-line: - Кожне речення – на окремому рядку. Якщо потрібно, можна скористатися auto-fix. - Зміни стають читабельними: diff показує, що саме змінилося на рівні речення. - При цьому Markdown автоматично обʼєднує рядки в один абзац, тож візуально нічого не змінюється.Пакету вже понад 7 років. Дивно, чому цей пакет досі не додали як частину markdownlint. Переглянути приклади конфігурації пакета можна у автора Josh Goldberg, наприклад, тут.Якщо ви хочете, щоб ваша документація була зручною для ревʼю та адаптованою до сучасного дев-процесу, sentences-per-line – обовʼязковий інструмент.