husky

git hooks

git 에는 hooks 라는 개념이 존재한다.

git hooks는 git에 관련된 이벤트가 발생 하거나 하려 할 때, 사용자가 필요한 조작을 스크립트로 작성하여 추가 할 수 있다.

ex) pre-commit - 커밋 전에 발생.

git hooks 문제

팀에서 git hooks 에 사용하는 스크립트를 동기화 하기 위해서

• 직접 스크립트 공유

  → git 이외에 스크립트를 받아 와서 .git/hooks에 넣어 줘야 됨.

• git template 공유

  → template를 세팅 하는 스크립트 실행 하거나 수동으로 넣어 주어야 함.

⇒ 번거러움 + 실수로 이 과정을 하지 않을 경우 hooks를 적용 할 수 없음.

husky 동작

husky를 설치 시 .git/hooks 에 husky.sh 가 설치 된 것을 확인 할 수 있음.

깃 이벤트가 발생할 때, 이 스크립트를 실행하며, husky.sh 는 package.json or .huskyrc에 정의 된 내용으로 실행한다.

적용하기

저희 프로젝트에서는 husky + lint-saged 조합으로 커밋 전에 prettier, eslint 검사를 하게 하여

코딩 컨벤션을 맞추기 위해 사용을 하였다.

"husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,jsx,tsx,ts}": [
      "prettier --write",
      "eslint --fix"
    ]
  },