18.8K ·GitHub
Что это такое?
commitlint проверяет, соответствуют ли ваши сообщения коммитов формату conventional commits, прогоняя их через настраиваемый набор правил.
commitlint проверяет, соответствуют ли ваши сообщения коммитов формату conventional commits, прогоняя их через настраиваемый набор правил.Это утилита командной строки или библиотека, которую я вызываю из кода?В первую очередь это CLI — @commitlint/cli, который запускается для сообщений коммитов. Есть также программный JavaScript API с методами lint, load, read и format, чтобы встроить его в другие инструменты.
В первую очередь это CLI — @commitlint/cli, который запускается для сообщений коммитов. Есть также программный JavaScript API с методами lint, load, read и format, чтобы встроить его в другие инструменты.Как добавить его в свой проект?Установите @commitlint/cli как dev-зависимость, добавьте файл commitlint.config.js или .commitlintrc со своими правилами, а затем проверяйте коммиты при каждом коммите через husky или на этапе сборки в CI.
Установите @commitlint/cli как dev-зависимость, добавьте файл commitlint.config.js или .commitlintrc со своими правилами, а затем проверяйте коммиты при каждом коммите через husky или на этапе сборки в CI.Что должно быть на моей машине, чтобы он работал?Node.js LTS >= 22.12.0 и git >= 2.13.2 — то есть требуется довольно свежая версия Node.
Node.js LTS >= 22.12.0 и git >= 2.13.2 — то есть требуется довольно свежая версия Node.Могу ли я просто остаться на старой версии, когда всё уже настроено?Надёжно — нет: у проекта нет спонсоров, и нельзя обещать своевременные патчи для старых версий, так что для исправления уязвимости, возможно, придётся отправить PR самостоятельно.
Надёжно — нет: у проекта нет спонсоров, и нельзя обещать своевременные патчи для старых версий, так что для исправления уязвимости, возможно, придётся отправить PR самостоятельно.Это нишевый эксперимент или проверенный временем инструмент?Проверенный временем: в README сказано, что commitlint стабилен и используется в различных проектах как инструмент разработки, а на GitHub у него около 18,7 тыс. звёзд.
Проверенный временем: в README сказано, что commitlint стабилен и используется в различных проектах как инструмент разработки, а на GitHub у него около 18,7 тыс. звёзд.Какие типы коммитов распознаёт стандартный конфиг?commitlint-config-conventional, основанный на конвенции Angular, включает build, chore, ci, docs, feat, fix, perf, refactor, revert, style и test — и их можно изменить в своей конфигурации.
commitlint-config-conventional, основанный на конвенции Angular, включает build, chore, ci, docs, feat, fix, perf, refactor, revert, style и test — и их можно изменить в своей конфигурации.А зачем мне вообще сообщения коммитов в формате conventional commits?В README перечислены три плюса: быть хорошим commitizen, делиться конфигурацией через npm и использовать conventional-changelog, который генерирует changelog из истории conventional-коммитов.
В README перечислены три плюса: быть хорошим commitizen, делиться конфигурацией через npm и использовать conventional-changelog, который генерирует changelog из истории conventional-коммитов.Есть ли готовые наборы правил, чтобы не писать свой конфиг?Да — среди общих конфигов есть @commitlint/config-angular, config-conventional, а также пресеты для проверки scope в Lerna, Nx, workspaces и Patternplate; комьюнити-конфиги следуют шаблону имён commitlint-config-.
Да — среди общих конфигов есть @commitlint/config-angular, config-conventional, а также пресеты для проверки scope в Lerna, Nx, workspaces и Patternplate; комьюнити-конфиги следуют шаблону имён commitlint-config-.Он хорошо работает вместе с commitizen?Да, есть адаптер для commitizen и пакет интерактивных подсказок @commitlint/prompt-cli — сам репозиторий commitlint использует его как собственный скрипт для коммитов.
Да, есть адаптер для commitizen и пакет интерактивных подсказок @commitlint/prompt-cli — сам репозиторий commitlint использует его как собственный скрипт для коммитов.What are similar projects?husky, react-doctor, stylelint, knip, super-linter, rust-clippy, changesets, openqodex
husky, react-doctor, stylelint, knip, super-linter, rust-clippy, changesets, openqodexWhich topics is it in?commit, lint, linter, version-control, code-quality, best-practices, monorepo, ci, git, devops, npm, automation
commit, lint, linter, version-control, code-quality, best-practices, monorepo, ci, git, devops, npm, automation