Если вы используете Обычные коммиты (А если вы этого не сделаете, вы должны 😜) Очень полезно иметь что -то, что говорит вам, если вы совершаете правильный путь. Эта тема будет сосредоточена на JavaScript Projects Анкет
Как вы знаете, обычные коммиты составлены таким образом:
type(scope?): subject body? footer?
Легко сделать послание коммита, которое не представляет этот стандарт, так что Linting приходит в нашу помощь!
Мы собираемся использовать два пакета: коммит и хаски
коммит
Этот пакет проверяет, если сообщения о коммите находятся в форме, показанной выше, или, по крайней мере, в форме Тип: Тема Анкет Он легко настраивается через файл, поэтому его конфигурация является общей.
module.exports = {
extends: ['@commitlint/config-conventional']
}
С установленным и настроенным пакетом мы сообщаем коду, что мы хотели бы, чтобы наши коммиты были «обычными». Но нам нужно попросить Commitlint, чтобы пробить наши сообщения. Можем ли мы делать это автоматически каждый раз, когда мы делаем новый коммит?
хаски
Husky – это пакет, который взаимодействует с крючками, выставленными GIT, чтобы вызвать некоторые пользовательские действия: Линтеры, проверка ошибок, сценарии, запущенные и т. Д… В этом случае мы хотели бы запустить Commitlint Проверьте каждый раз Мы делаем коммит без необходимости запуска ворса вручную. К счастью, сообщество приходит в нашу помощь, и нам нужно запустить только две команды
yarn husky install npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1'
В конце эта настройка позаботится о том, чтобы каждый раз, когда мы совершаем, наносятся Линтер, и все чеки производятся.
И если мы совершаем, не следуя правилам, это произойдет (пример VSCODE)
⧗ input: test commit ✖ subject may not be empty [subject-empty] ✖ type may not be empty [type-empty] ✖ found 2 problems, 0 warnings
Оригинал: “https://dev.to/dnlnrs/lint-your-commits-2p54”