🔥git commitizen 설치하기

commitizen 홈페이지

커밋 메시지 규격화를 위해 commitizen 라이브러리가 추가되었다!
header, scope, description을 제공해줘서 규격화된 커밋 메시지를 작성할 수 있다!

적용 후 PR 날린 모습~~

설치 단계는 다음과 같다.
1. git commitizen 설치
터미널에서 아래 명령어를 실행합니다.

yarn global add commitizen

참고사항 : 2번 단계에서 cz 명령어 실행 시 오류가 발생한다면 아래의 커멘드로 전역 설치 재시도 한번 해봐주세요 ~

yarn add commitizien -g

yarn은 OS를 타는게 아니라고 알고 있는데,
왜인지 나는 yarn add commitizien -g 로 설치할 때 설치된 척 하더니 실행이 안 되었다.

그래서 yarn global add commitizen로 다시 시도하니 멀쩡히 전역설치 되었음.

2. 변경사항 add 후 git cz명령어를 이용한 커밋 올리기
   참고사항 : commitizen 실행시 다음 같은 오류가 발생한다면 아래의 절차를 따라주세요.
   

yarn global add cz-emoji

cz-emoji 설치

echo '{ "path": "cz-emoji" }' > ~/.czrc

Commitizen에게 어떤 어댑터를 사용할지 알려주는 설정

그리고 config 추가해주기

// package.json에 잘 추가되었는지 확인하기 
    "cz-conventional-changelog": "^3.3.0",
    "cz-emoji": "^1.3.2-canary.2",
    
    
    // 추가하기 
      "config": {
    "commitizen": {
      "path": "cz-emoji"
    }

사용 가이드

1.변경 사항 스테이징 처리 ( git add . 또는 git add src/..변경파일)

2.git cz 명령어 실행 후 commit header 선택 또는 검색 (키보드 상 하 , enter)

어뎁터 예시

• feat: 새로운 기능 추가
• fix: 버그 수정
• docs: 문서 변경
• style: 코드 스타일 변경 (기능 변경 없음)
• refactor: 코드 리팩터링
• test: 테스트 추가/수정
• perf: 성능 개선
• build: 빌드 시스템 관련 변경
• ci: CI 설정 변경
• chore: 종속성 추가/제거 또는 기타 설정 변경
• revert: 이전 커밋 되돌리기

3. *scope 설정 : 도메인 단위로 설정 (user, dashboard, order ...etc)

4. *short description 작성 (한국어 작성 가능❗️)
   

5. longer description, Breaking Change 생략 가능(enter) - 필요한 경우 작성

---

이거 하다가 스크립트 제한 오류 만나서 터미널이랑 조금 싸웠지만 ㅋ
깔끔한 커밋 메시지를 보니까 뿌듯하다.
근데 어떤 이모지가 뭘 뜻하는지는 좀 적응되어야 직관적으로 보일 듯 !