Git Hook과 Husky의 이해

작성일 : 2024.10.21

husky란?

• git hook 사용을 쉽게 할 수 있도록 도와주는 라이브러리
• 사용자가 ./git/hooks 디렉토리에 스크립트를 넣을 경우 git에 올라가지 않는다.
• 하지만.husky 폴더 내에 스크립트를 저장하면 git hook을 다른 개발자와 공유할 수 있다.
• 단, ./git 이 존재하는 디렉토리에 ./husky 파일이 있어야 정상적으로 작동이 가능하다.

git hook 어떤 Git 이벤트가 생겼을 때 자동으로 특정 스크립트를 실행하는 기능. 클라이언트 훅 : 커밋, Merge 가 발생하거나 push 가 발생하기 전 클라이언트에서 실행하는 훅 서버 훅 : Git repository 로 push 가 발생했을 때 서버에서 실행하는 훅

lint-staged란?

• staged 상태의 파일들에 대해서 lint와 우리가 설정해둔 명령어를 실행해주는 라이브러리
• 여러 가지 hook 중 lint-staged와 관계되는 것은 커밋 워크플로우 훅

커밋 워크플로 훅 : git commit 명령으로 커밋을 할 때 실행하는 훅
pre-commit : 커밋 직전에 실행되는 hook

Client Hook

• Commit Workflow Hook : git commit 명령어를 통해 commit을 진행할 때 실행됨.
  • pre-commit : commit 메세지를 작성하기 전 실행됨.
  • prepare-commit-msg : commit 메세지를 생성한 후, 편집기를 실행하기 전 실행
  • commit-msg : commit 메세지를 완성한 후, commit을 최종 실행하기 전에 실행.
  • post-commit : commit 을 완료한 후 실행.
• Email Workflow Hook : git am 명령어를 통해 patch 파일을 git에 반영할 경우 실행됨.
  • applypatch-msg :  git am 명령어 실행 시 가장 먼저 실행됨,
  • pre-applypatch : patch 파일을 적용한 후 실행됨, patch 반영 또한 중단시킬 수 있음.
  • post-applypatch : patch 파일이 commit으로 반영되기 직전에 수행되며, patch 반영은 중단시킬 수 없음.
• Other Hook : 기타
  • pre-rebase : git rebase 작업 전에 실행
  • post-rewrite :  git commit -amend, git rebase 처럼 commit을 변경하는 명령을 실행한 후 실행.
  • post-merge : merge 작업이 종료된 후 실행.
  • pre-push :  git push 명령 실행 시 작동하며, remote 정보를 업데이트 한 후 데이터를 전송하기 전 실행, push 중단 가능.

git patch란?

• git commit을 하나의 파일로 만들 경우 patch 파일이 생성된다. 이는 다른 개발자에게 전달이 가능하다.
• git format-patch 명령어를 사용할 시, 적용된 각각의 commit에 대응되는 patch 파일이 생성된다.
• 이렇게 만들어진 파일을 전달받아 다시 commit으로 적용하려면, git am [patch-file] 명령어를 사용하여 commit에 반영시킨다.

git rebase란?

• 두개의 branch에서, 한 branch의 base를 다른 branch의 최신 커밋으로 적용하는 작업이다.
• 다른 개발자가 올린 commit의 수정사항을 내가 작업한 branch에 즉각 적용할 수 있다.
• 또한 rebase는 merge와 달리 commit 이력이 남지 않아 보다 깔끔한 commit history를 가져갈 수 있음.
• 단, rebase의 경우 merge와 달리 각 commit에 대한 confilct 처리를 일일히 해줘야 하지만, 오히려 이것이 장점으로 부각될 수 있음.

Shell Script란?

• Shell에서 사용 가능한 명령어들의 조합을 모아서 만든 배치 (Batch : 데이터를 일괄적으로 모아서 처리하는 작업) 파일이다.
• 즉, OS의 Shell을 사용하여 각 줄의 명령어를 순차적으로 실행시켜주는 인터프리터 방식의 프로그램이다.
• 스크립트의 첫 줄에 적힌 #!/bin/bash 에서 #! 은 Shebang이라고 칭하며, 해당 Shell Script 파일을 해석해줄 인터프리터의 절대 경로를 지정한 것이다.
• 따라서 #!/bin/bash 의 의미는 해당 파일을 여러 종류의 shell 중 bash 를 통해 실행시키겠다는 의미이다. sh 를 적용하고 싶다면 #!/bin/sh 를 작성하면 된다.

git hook 적용

• git hook의 경우 .git/hooks 디렉토리 안에 저장된다.
• hook은 실행 가능한 Shell Script이며, 설정하고자 하는 훅을 확장자 없이 파일 명으로만 지정하면 적용이 가능하다.

example - .git/hooks/pre-commit

#!/bin/sh

echo 'Hello JK!'

exit 0 # exit이 0이 아닐 경우 commit이 취소된다고 함.

example - .git/hooks/pre-push : 직접적으로 master branch에 push 를 진행하는 것을 막음

#!/bin/sh

PROHIBITED_REF="refs/heads/master"
​
if read local_ref local_sha remote_ref remote_sha
then
    if [ "$remote_ref" = "$PROHIBITED_REF" ]
    then
        echo "prevent to push master"
        exit 1
    fi
fi

exit 0

그렇다면 왜 Husky 를 사용해야 할까?

• ./git 디렉토리는 기본적으로 git ignore 대상이다, 따라서 hook을 공유하기 위해서는 별도의 작업이 필요하다.
• git hooks를 설정하는 스크립트 자체를 별도의 디렉터리에 저장하거나, git template을 사용하여 공유가 가능하다.

husky를 사용하지 않을 경우

1. git hook 스크립트를 별도의 디렉터리에 저장하고, 이를 추후 적용하도록 한다.

• 프로젝트 내에 git_hooks 폴더를 만들고, 해당 폴더 내에 사전에 작성한 hook script 파일을 넣어둔다.
• 이후 하단의 스크립트를 공유하거나, 다른 사용자가 수동으로 스크립트 파일을 .git/hooks 폴더에 넣으면 된다.
• 하단의 스크립트는 git_hooks 내의 모든 파일을 .git/hooks 디렉토리로 복사 (cp) 하는 명령어를 담고 있다.

#!/bin/bash
cp git_hooks/* .git/hooks

2. git template 를 활용하여 git clone 시 --template 옵션을 통해 .git 디렉토리를 사전에 지정한 양식대로 초기화할 수 있다.

• 프로젝트 내 git_template 폴더를 만들고, 실제 .git 폴더 구조처럼 hooks 폴더를 생성한 후 내부에 스크립트 파일을 추가한다.

/main/git_templates
    └─ /hooks
        └─ pre-push
        └─ pre-commit
        └─ etc...

• 이후 프로젝트를 clone 할 때 --template 옵션에 사전에 생성한 template 디렉토리를 경로로 지정한다.
• 하단의 명령어는 프로젝트를 clone 하면서, template 옵션에 적힌 디렉토리를 기반으로 .git 디렉토리를 초기화한다.

 git clone --template=/main/git_templates https://github.com/RookieAND/test-git-hooks.git

이런 과정은 다른 사용자들이 직접 수동으로 적용해야 하기 때문에 문제가 발생할 요지가 높다

husky 설치

npm 을 사용한다면, 하단의 명령어 한 줄로 기초 세팅이 완료된다.

npx husky-init && npm install

yarn 의 경우, 두 번에 걸쳐 세팅을 완료한다.

yarn add husky --dev
yarn husky install

설정이 완료되면 프로젝트에 .husky 디렉토리가 생성되고, 이 안에서 hook 스크립트를 추가하면 된다.

/.husky
    └─ .gitignore
    └─ husky.sh
    └─ 내가 추가할 script...

ESLint + lint-staged + husky 조합

• lint-staged : staged 상태에 놓인 파일을 검사하여 lint를 통과하지 못한 파일은 commit failed 처리 시키는 라이브러리.
• lint-staged를 적용하기 위해서는 lint-staged 라이브러리를 개별 의존성으로 설치해야 한다.
• .lintstagedrc 파일을 생성하고 다음과 같이 코드를 적는다. (glob pattern)

// js, jsx, ts, tsx 파일에 대한 eslint 검사 실행.
{
  "./src/**/*.[jt]s?(x)": "eslint --cache --fix"
}

• 이후 ./husky 내에 pre-commit 훅 스크립트를 추가하고, 하단과 같이 내용을 작성한다.

/.husky/pre-commit
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged