Husky 개요

설치 방법

• 클론 -> 터미널 -> 프로젝트 디렉터리에서 npm install
• (현재 develop 브랜치가 반영이 안된 채로 다른 브랜치로 분기해 작업 중인 경우)
  • git switch develop git pull origin develop git swtich {원래 브랜치} git rebase develop 이후 npm install
• npm install이후 node_modules 폴더 생성 확인 => 설치 끝

설정 방법과 테스트

프로젝트 루트 디렉터리에서 아래의 명령어 입력

- npm init
    - npm init 후 node_modules 생기므로 .gitignore 추가(뭘 추가 할지는 구글링)
- npm install husky --save-dev
- npx husky install
- npx husky add .husky/commit-msg 'sh commit-msg'
- code .husky/commit-msg

• 아래와 같이 파일이 생기고, VSCODE가 열림 ⇒ 아래 코드 입력 후 저장

#!/bin/sh
commit_message=$(head -n 1 "$1")

if ! echo "$commit_message" | grep -Eq '^(Feat|Fix|Docs|Style|Refactor|Test|Chore|Design|Comment|Rename|Remove|!BREAKING CHANGE|!HOTFIX) : .+$'; then
    echo "Error: Commit message does not follow the convention!"
    exit 1
fi

• 루트 디렉터리 package.json 열고

  "scripts": {
  
  } // 이 안에
 
    "prepare": "husky" //이걸 추가

• 사용된 정규표현식

커밋 컨벤션(”Type : “)을 지키지 않고 작성시 Error 발생