husky & commitlint와 함께 Git 후크를 사용하여 Conventional Commit 메시지를 적용하는 방법

이 가이드에서는 Git에서 Conventional Commit 메시지 사용을 강제하는 방법을 보여드리겠습니다. Conventional Commit이 무엇인지 모른다면 . 바로 시작합시다.

계속해서 터미널에서 리포지토리를 엽니다. husky, commitlint cli 및 config-conventional을 개발 종속성으로 설치해 보겠습니다.

npm install --save-dev husky @commitlint/cli @commitlint/config-conventional

다음으로 Husky를 사용하여 Git 후크를 활성화하고 다음 명령을 입력하여 commit-msg를 추가합니다.

npx husky install
npx husky add .husky/commit-msg 'npx commitlint --edit $1'

커밋린트를 구성하기 위해 리포지토리의 루트에 다음 파일을 만듭니다.
.commitlintrc.json

{
  "extends": ["@commitlint/config-conventional"]
}

commitlint.config.js

module.exports = {
  extends: ['@commitlint/config-conventional'],
};

그리고 끝났습니다! 기존의 커밋 메시지를 시행하는 빠르고 쉬운 방법입니다. 비 전통적인 메시지로 Git에 커밋을 시도하여 시도하십시오.

git commit -a -m "Set up Conventional Commits using Husky and commitlint"

아래 오류가 발생해야 합니다.

⧗   input: Set up Conventional Commits using Husky and commitlint
✖   subject may not be empty [subject-empty]
✖   type may not be empty [type-empty]

✖   found 2 problems, 0 warnings
ⓘ   Get help: https://github.com/conventional-changelog/commitlint/#what-is-commitlint

husky - commit-msg hook exited with code 1 (error)

이제 이를 기존 커밋으로 변경해 보겠습니다.

git commit -m 'feat: enforce conventional commits using husky and commitlint'