Husky로 Git hooks 관리하기

Husky는 git commit, git push의 앞이나 뒤에 동작하는 hook을 쉽게 만들어주는 툴이다. 최근 Electron Bolierplate를 사용하려고 하는데, Repository에 정말 많은 개발 툴이 사용되고 있는 걸 봤고, 그 와중에 Husky라는 것을 처음 알게 되었다.

Husky로 Git hooks 사용하기

특히 최근에는 Prettier가 온전하게 작동하지 않는 (조금 더 자세한 증상을 설명하자면, 일정 시간 동안 잘 작동 하다가, 또 안 되면 프로젝트 안에 있는 .prettierrc를 열고 저장(ctrl + s)를 해서 VSCode에 인식해줘야 다시 정상 작동하는) 현상이 개인적으로 발생했다. 이유는 모르겠지만 아무튼 그 문제로 커밋하고 코드리뷰를 할 때, 팀의 컨벤션이 안 맞는 코드가 보이게 되고, 그 스타일을 체크하고 다시 커밋을 해야 하는 경우가 생겼다. 그래서 commit 하기 전에 formatting 정도는 진행하면 좋겠다고 생각이 되어서 개발 툴로서 Husky를 사용하려고 한다.

Husky의 사용법은 그야말로 완전히 단순하다. 우선 패키지를 설치한다.

yarn add husky -D

그 다음 package.json에 Husky의 hook과 관련된 설정을 해주면 된다. .huskyrc, .huskyrc.json, .huskyrc.js, husky.config.js와 같은 별도의 설정 파일을 만들 수도 있다. 그렇지만 이번 글에서는 그렇게 많은 설정이 들어가지 않기 때문에 간단하게 package.json을 사용한다.

{
    ...
    "husky": {
        "hooks": {
            "pre-commit": "yarn format && yarn lint;"
        }
    }
}

이렇게 간단하게 git hook을 관리할 수 있다. 오픈 소스의 경우는 push하기 전에 test를 돌려보게 할 수도 있을 것 같다.

후기

좋고, 간단한 툴. 신경써야 할 코드리뷰를 줄여주는 기능을 할 것 같다.