기업 및 협업에 있어서 Git Message는 중요하다.
여러 명이 함께 하나의 프로젝트에 참여하게 될 때 Commit Message가 명확하지 않으면 History 파악이 힘들기 때문이다.
그렇기에 Commit Message의 규칙이 필요로 하다. 기능, 수정 사항 및 변경사항을 담아서 관리할 필요가 있다.
husky는 Node.js 프로젝트에서 git hooks를 쉽게 관리하기 위한 도구 이다.
git hooks와 husky는 공식 문서를 통해 확인해보자.
# npm을 사용하는 경우
npm install husky --save-dev
npx husky install
# yarn을를 사용하는 경우
yarn add husky -D
yarn husky install
# 설치 후
npx husky installcommitlint는 Commit Message에 대한 lint를 확인하여 성공과 실패를 출력한다.
# npm을 사용하는 경우
npm install @commitlint/config-conventional @commitlint/cli -D
# yarn을 사용하는 경우
yarn add @commitlint/config-conventional @commitlint/cli -D패키지 설치 후, 프로젝트 root 디렉토리에 commitlint.config.js 또는 commitlint.config.ts 를 만들고 아래와 같이 작성해준다.
module.exports = { extends: ['@commitlint/config-conventional'] };commitlint를 적용하기 위해서 다음과 같이 입력한다.
npx husky add .husky/commit-msgroot 디렉토리 밑의 .husky/commit-msg에 undefined를 지우고 아래의 명령어를 추가해준다.
# npm을 사용하는 경우
npx --no commitlint --edit $1
# yarn을 사용하는 경우
yarn commitlint --edit $1Commit Message는 허용되는 Type에 따라 나눌 수 있다.
@commitlint/config-conventional은 Anguler Convention를 기반으로 한다.
- build: 빌드 시스템 또는 외부 종속성에 영향을 미치는 변경 사항(예: gulp, broccoli, npm)
- ci: CI 구성 파일 및 스크립트의 변경 사항(예: 범위: Travis, Circle, BrowserStack, SourceLabs)
- docs: 문서만 변경
- feat: 새로운 기능
- fix: 버그 수정
- perf: 성능을 향상시키는 코드 변경
- refactor: 버그를 수정하거나 기능을 추가하지 않는 코드 변경
- style: 코드의 의미에 영향을 미치지 않는 변경 사항(공백, 정렬, 세미콜론 등)
- test: 누락된 테스트 추가 또는 기존 테스트 수정
# 실패 케이스
$ git add .
$ git commit -m "테스트입니다"
⧗ input: 테스트입니다
✖ 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
error Command failed with exit code 1.
# 성공 케이스
$ git commit -m "build: commitlint 적용"
Done in 0.21s.
[main 7cefd09] build: commitlint 적용prompt를 이용하여 조금 더 쉽게 규칙을 지키며 Commit 할 수 있다.
# npm을 사용하는 경우
npm install @commitlint/prompt-cli -D
# yarn을 사용하는 경우
yarn add @commitlint/prompt-cli -Dpackage.json에 아래 항목을 추가한다.
{
"scripts": {
"commit": "commit"
}
}
사용방법은 간단하다.
git add .
yarn commityarn commit을 하게 되면 다음과 같이 출력된다.
$ commit
Please enter a type: [required] [tab-completion] [header]
<type> holds information about the goal of a change.
<type>(<scope>): <subject>
<body>
<footer>
? type:
99 characters lefttype: Commit Message의 타입 scope: 적용 범위(선택사항) subject: Message 내용 body: 본문(선택사항) footer: 꼬리말(선택사항)
자세한 내용은 Conventional Commits 한글 공식 문서에서 확인 할 수 있다.
규칙을 수정하고 싶다면 commitlint.config.js 파일을 수정하여 적용 할 수 있다.
자세한 수정 및 설정방법은 공식 문서를 확인해보자.