원티드 프리 온보딩을 하면서 배운 내용을 정리하고자 한다.
그 중 하나인 git husky 설정 관련 내용이다.

개요

ESLint, Prettier 등을 설정하더라도 팀원이 지키지 않으면 의미가 없어 강제성을 부여해야 한다.

• git hook: git에서 특정 이벤트 발생하기 전,후로 특정 hook 동작을 실행할 수 있게 하는것 (ex. commit, push)
• git hook은 설정이 까다롭고 일반적으로 공유하기 위해선 타인이 직접 세팅을 해주어야 한다.

husky

• git hook 설정을 도와주는 npm package
• 번거로운 git hook 설정이 편함 + npm install 과정에서 사전에 세팅해둔 git hook을 다 적용시킬 수 있어서 모든 팀원이 git hook 실행이 되도록 하기가 편함

설정 방법

npm install husky --save-de
: 허스키를 설치한다.

// package.json

{
  "scripts": {
    "postinstall": "husky install",
    "format": "prettier --cache --write .",
    "lint": "eslint --cache .",
  },
}

: 이후에 clone 받아서 사용하는 사람들은 npm install후에 자동으로 husky install 이 될 수 있도록 postinstall 설정 후 pre-commit과 pre-push에 사용될 스크립트 설정

npx husky add .husky/pre-commit "npm run format"
npx husky add .husky/pre-push "npm run lint"
: 허스키에 훅 등록

• .huskyrc 파일을 만들어 하는 방법도 있다고 한다.