본문 바로가기
IT

Git Hook 활용, ESLint, Prettier 연동으로 코드 스타일 자동 검사

by 테크천재 2026. 3. 29.

개발하다 보면 나도 모르게 엉망진창 코드를 짜게 될 때가 있죠. 😂 오늘은 Git Hook을 이용해서 커밋 전에 자동으로 코드 스타일을 검사하고 정리하는 방법을 알아볼 거예요. ESLint와 Prettier를 연동해서 깔끔한 코드를 유지하는 법, 지금부터 함께 살펴볼까요?

1. 깔끔한 코드 유지의 중요성: 지속 가능한 개발을 위한 첫걸음

소프트웨어 개발에서 깔끔한 코드를 유지하는 것은 매우 중요합니다. 이는 프로젝트의 유지 보수성, 확장성, 그리고 협업 효율성을 높이는 데 기여합니다. Git Hook을 활용하여 커밋 전에 코드 스타일을 자동으로 검사하는 방법은 이러한 목표를 달성하는 효과적인 전략입니다.

본 글에서는 Git Hook을 활용하여 코드 스타일을 자동 검사하는 방법을 소개합니다. 구체적으로 ESLint와 Prettier를 연동하여 커밋 전에 코드를 검사하고 수정하는 과정을 설명합니다. 이를 통해 개발자는 일관성 있는 코드 스타일을 유지하고, 잠재적인 오류를 사전에 방지할 수 있습니다.

결론적으로, Git Hook을 활용한 코드 스타일 자동 검사는 지속 가능한 개발을 위한 필수적인 요소입니다. 본 글을 통해 독자는 실제 프로젝트에 적용 가능한 지식과 기술을 습득할 수 있습니다. 이는 곧 생산성 향상과 코드 품질 개선으로 이어질 것입니다.

→ 1.1 코드 품질의 중요성

코드 품질은 단순히 미적인 요소를 넘어, 프로젝트의 성공 여부를 좌우하는 핵심 요소입니다. 가독성이 높고 유지 보수가 용이한 코드는 개발 시간 단축에 기여합니다. 또한, 오류 발생 가능성을 줄여 안정적인 소프트웨어 운영을 가능하게 합니다. 예를 들어, 명확하게 작성된 코드는 새로운 팀원이 프로젝트에 빠르게 적응하는 데 도움이 됩니다.

나아가 코드 품질은 협업 효율성을 높이는 데 중요한 역할을 합니다. 일관된 코드 스타일은 팀원 간의 코드 리뷰 과정을 원활하게 합니다. 따라서 코드 충돌을 줄이고 통합 과정을 단순화하여 전체 개발 주기를 단축할 수 있습니다.

2026년 현재, 많은 기업에서 코드 품질 관리를 위해 다양한 도구와 방법을 도입하고 있습니다. Git Hook과 같은 자동화 도구를 활용하여 코드 스타일을 유지하는 것은 효과적인 전략 중 하나입니다. 이러한 노력은 장기적으로 프로젝트의 가치를 높이고, 개발 팀의 경쟁력을 강화하는 데 기여합니다.

2. Git Hook 작동 원리: 코드 품질 자동화의 핵심

Git Hook은 Git 버전 관리 시스템에서 특정 이벤트가 발생할 때 자동으로 실행되는 스크립트입니다. 이러한 이벤트는 커밋 전, 커밋 후, 푸시 전 등이 있습니다. Git Hook을 활용하면 코드 스타일 검사, 테스트 실행, 커밋 메시지 검증 등의 작업을 자동화할 수 있습니다. 이를 통해 개발자는 코드 품질을 일관성 있게 유지하고, 오류를 사전에 방지할 수 있습니다.

Git Hook은 로컬 저장소와 원격 저장소 모두에서 설정 가능합니다. 로컬 Hook은 개발자 개인의 환경에서만 실행되므로, 개인적인 코드 스타일 규칙을 적용하는 데 유용합니다. 반면, 원격 Hook은 서버에서 실행되므로, 팀 전체의 코드 품질 기준을 강제하는 데 효과적입니다. 따라서, 팀의 개발 프로세스에 맞춰 적절한 Hook을 선택하고 설정하는 것이 중요합니다.

→ 2.1 Git Hook의 종류와 활용

Git Hook은 다양한 종류가 있으며, 각각 특정 시점에 실행됩니다. 예를 들어, pre-commit Hook은 커밋이 생성되기 전에 실행되어 코드 스타일을 검사하고, 오류가 있는 경우 커밋을 중단시킬 수 있습니다. pre-push Hook은 푸시가 실행되기 전에 실행되어 원격 저장소에 잘못된 코드가 업로드되는 것을 방지합니다. 또한, post-merge Hook은 병합 작업이 완료된 후에 실행되어 필요한 추가 작업을 수행할 수 있습니다.

Git Hook 스크립트는 쉘 스크립트, Python, JavaScript 등 다양한 프로그래밍 언어로 작성할 수 있습니다. 스크립트는 특정 조건에 따라 동작하도록 구성할 수 있으며, 외부 도구 (ESLint, Prettier 등)와 연동하여 코드 품질 검사를 자동화할 수 있습니다. 예를 들어, pre-commit Hook에서 ESLint를 실행하여 코드 스타일 오류를 검사하고, 오류가 발견되면 커밋을 중단시키는 스크립트를 작성할 수 있습니다. 이를 통해 개발자는 코드 품질을 더욱 효과적으로 관리할 수 있습니다.

Git Hook을 효과적으로 활용하기 위해서는 팀원 간의 합의와 공유가 중요합니다. 팀의 코드 스타일 규칙과 검사 도구를 명확하게 정의하고, 이를 Git Hook에 적용하여 모든 팀원이 동일한 기준을 따르도록 해야 합니다. 또한, Git Hook 스크립트를 버전 관리 시스템에 포함시켜 공유하고, 필요에 따라 수정하고 개선해나가야 합니다. 이러한 과정을 통해 Git Hook은 코드 품질 자동화의 핵심 요소로 자리 잡을 수 있습니다.

📌 핵심 요약

  • ✓ ✓ Git Hook은 특정 이벤트 자동 실행 스크립트
  • ✓ ✓ 로컬/원격 Hook 설정으로 품질 기준 적용
  • ✓ ✓ pre-commit, pre-push 등 다양한 Hook 활용
  • ✓ ✓ 팀 합의 및 공유로 코드 품질 자동화 핵심

3. ESLint & Prettier 연동: 스타일 규칙 자동 적용 설정 방법

코드 스타일을 일관성 있게 유지하기 위해 ESLint와 Prettier를 연동하는 것은 매우 효과적입니다. ESLint는 코드의 문법적인 오류나 안티 패턴을 검사하고, Prettier는 코드 스타일을 자동으로 정리해줍니다. 두 도구를 함께 사용하면 개발자는 코드 품질 향상에 더욱 집중할 수 있습니다.

→ 3.1 ESLint 설정

먼저, ESLint를 프로젝트에 설치해야 합니다. 다음 명령어를 사용하여 ESLint를 설치합니다.


npm install --save-dev eslint

설치 후, ESLint 설정 파일을 생성합니다. .eslintrc.js 파일을 생성하고, 다음과 같이 설정합니다.


module.exports = {
  env: {
    browser: true,
    es2021: true,
    node: true,
  },
  extends: [
    'eslint:recommended',
    'plugin:react/recommended',
  ],
  parserOptions: {
    ecmaFeatures: {
      jsx: true,
    },
    ecmaVersion: 12,
    sourceType: 'module',
  },
  plugins: [
    'react',
  ],
  rules: {
    'no-unused-vars': 'warn',
  },
};

위 설정은 기본적인 JavaScript 및 React 프로젝트에 적합합니다. 필요에 따라 규칙을 추가하거나 수정할 수 있습니다. 예를 들어, 특정 코드 스타일 규칙을 강제하고 싶다면 rules 항목에 해당 규칙을 추가합니다.

→ 3.2 Prettier 설정

다음으로 Prettier를 설치합니다. 다음 명령어를 사용합니다.


npm install --save-dev prettier

Prettier 설정 파일을 생성합니다. 프로젝트 루트 디렉토리에 .prettierrc.js 파일을 만들고, 원하는 스타일 규칙을 정의합니다.


module.exports = {
  semi: true,
  trailingComma: 'all',
  singleQuote: true,
  printWidth: 120,
  tabWidth: 2,
};

위 설정은 세미콜론 사용, trailing comma 사용, 작은 따옴표 사용, 줄 바꿈 폭 120, 탭 너비 2를 지정합니다. Prettier 옵션은 프로젝트의 스타일 가이드라인에 맞춰 조정할 수 있습니다.

→ 3.3 ESLint와 Prettier 연동

ESLint와 Prettier를 함께 사용하기 위해 몇 가지 추가 설정을 해야 합니다. 먼저, ESLint가 Prettier의 규칙을 따르도록 설정합니다. 이를 위해 필요한 패키지를 설치합니다.


npm install --save-dev eslint-config-prettier eslint-plugin-prettier

.eslintrc.js 파일에 다음 설정을 추가합니다. extends 배열에 'plugin:prettier/recommended'를 추가하여 Prettier 규칙을 ESLint에 적용합니다.


module.exports = {
  // ...
  extends: [
    'eslint:recommended',
    'plugin:react/recommended',
    'plugin:prettier/recommended',
  ],
  // ...
};

마지막으로, 커밋 전에 ESLint와 Prettier를 실행하는 Git Hook을 설정합니다. 이를 통해 코드 스타일을 자동으로 검사하고 수정할 수 있습니다.

📊 ESLint & Prettier 설정

단계 작업 명령어/설정 참고
1. 설치 ESLint 설치 npm install --save-dev eslint 개발 의존성
2. 설정 파일 생성 .eslintrc.js 생성 module.exports = { ... } 코드 스타일 규칙 정의
3. Prettier 설치 Prettier 설치 npm install --save-dev prettier 코드 포맷터
4. VS Code 설정 (선택) 자동 포맷 설정 settings.json 수정 editor.formatOnSave: true
5. 설정 파일 연동 ESLint & Prettier 연동 .eslintrc.js 수정 eslint-config-prettier 적용

4. commit-msg Hook 설정: 커밋 메시지 규칙 자동 검사 구현

commit-msg Hook은 커밋 메시지가 특정 규칙을 준수하는지 자동으로 검사하는 데 사용됩니다. 이는 프로젝트의 커밋 로그를 일관성 있게 유지하고, 협업 효율성을 높이는 데 기여합니다. 본 섹션에서는 commit-msg Hook을 설정하여 커밋 메시지 규칙을 자동으로 검사하는 방법을 설명합니다.

→ 4.1 commit-msg Hook 스크립트 작성

먼저, 커밋 메시지 규칙을 검사하는 스크립트를 작성해야 합니다. 이 스크립트는 커밋 메시지를 읽어 특정 패턴이나 규칙을 준수하는지 확인합니다. 예를 들어, 커밋 메시지가 특정 접두사로 시작하는지, 특정 길이를 초과하지 않는지 등을 검사할 수 있습니다.

#!/bin/sh
COMMIT_MSG_FILE=$1
COMMIT_MSG=$(cat $COMMIT_MSG_FILE)
# 커밋 메시지 규칙 검사 로직
if ! echo "$COMMIT_MSG" | grep -q "^[A-Z]+-[0-9]+: "; then
  echo "잘못된 커밋 메시지 형식입니다. 예: PROJECT-123: 설명" >&2
  exit 1
fi

위 스크립트는 커밋 메시지가 "PROJECT-123: 설명"과 같은 형식으로 시작하는지 검사합니다. grep 명령어를 사용하여 특정 패턴을 찾고, 패턴이 일치하지 않으면 오류 메시지를 출력하고 커밋을 중단합니다.

→ 4.2 Hook 파일 설정

작성한 스크립트를 Git Hook으로 등록해야 합니다. 이를 위해 프로젝트의 .git/hooks 디렉토리에 commit-msg 파일을 생성하고, 스크립트를 파일에 복사합니다. 파일에 실행 권한을 부여하는 것도 중요합니다.

chmod +x .git/hooks/commit-msg

이제 Git은 커밋이 생성될 때마다 commit-msg Hook을 실행하여 커밋 메시지를 자동으로 검사합니다. 자동 검사를 통해 개발자는 커밋 메시지 형식을 일관되게 유지할 수 있습니다.

→ 4.3 자동 검사 규칙 예시

다양한 커밋 메시지 규칙을 스크립트에 적용할 수 있습니다.

  • 커밋 메시지 제목의 최대 길이 제한
  • 특정 키워드 포함 여부 검사
  • 이슈 트래커 ID 포함 여부 검사

예를 들어, 커밋 메시지 제목이 50자를 초과하는 경우 오류를 발생시키는 규칙을 추가할 수 있습니다. 이를 통해 커밋 로그를 간결하게 유지할 수 있습니다.

5. pre-commit Hook 설정: 코드 변경 전 자동 검사 완벽 구축

pre-commit Hook은 커밋을 실행하기 전에 자동으로 스크립트를 실행하여 코드 스타일과 품질을 검사하는 데 사용됩니다. 이를 통해 개발자는 코드를 커밋하기 전에 잠재적인 문제를 식별하고 수정할 수 있습니다. 결과적으로 코드베이스의 일관성을 유지하고 버그 발생 가능성을 줄일 수 있습니다.

→ 5.1 Husky와 lint-staged를 사용한 자동 검사 환경 구축

Husky와 lint-staged는 pre-commit Hook 설정을 간편하게 만들어주는 도구입니다. Husky는 Git Hook을 쉽게 설정하고 관리할 수 있도록 도와줍니다. lint-staged는 Staged된 파일(커밋에 포함될 변경 사항이 있는 파일)에 대해서만 ESLint와 Prettier를 실행하여 검사 시간을 단축시켜 줍니다.

먼저, 다음 명령어를 사용하여 Husky와 lint-staged를 프로젝트에 설치합니다.


npm install husky lint-staged --save-dev

다음으로, Husky를 활성화하고 pre-commit Hook을 설정합니다. 아래 명령어들을 순서대로 실행합니다.


npx husky install
npm set-script prepare "husky install"
npm run prepare

package.json 파일에 다음 설정을 추가하여 lint-staged를 구성합니다. 이는 staged된 JavaScript 및 TypeScript 파일에 대해 ESLint와 Prettier를 실행하도록 지정합니다.


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

마지막으로, 다음 명령어를 실행하여 pre-commit Hook을 생성하고 lint-staged를 실행하도록 설정합니다.


npx husky add .husky/pre-commit "npx lint-staged"

이제 코드를 커밋하기 전에 ESLint와 Prettier가 자동으로 실행되어 코드 스타일을 검사하고 수정합니다. 만약 ESLint 또는 Prettier에서 오류가 발생하면 커밋이 중단됩니다. 이를 통해 개발자는 코드 품질을 유지하면서 개발 과정을 진행할 수 있습니다.

→ 5.2 예시: 실제 프로젝트에 적용

실제 프로젝트에서 pre-commit Hook을 설정하면 팀원들이 일관된 코딩 스타일을 유지하도록 강제할 수 있습니다. 예를 들어, 한 개발자가 코딩 스타일 규칙을 위반하는 코드를 커밋하려고 하면, pre-commit Hook이 이를 감지하고 커밋을 막습니다. 따라서 모든 코드가 코드 스타일 규칙을 준수하도록 보장할 수 있습니다.

만약 pre-commit Hook이 실패하더라도, 강제로 커밋해야 하는 상황이 발생할 수 있습니다. 이 경우, git commit --no-verify 명령어를 사용하여 Hook을 우회할 수 있습니다. 하지만 이는 예외적인 상황에서만 사용해야 하며, 코드 품질을 유지하기 위해서는 가능한 한 Hook을 통과하는 것이 좋습니다.

6. Git Hook 사용 시 주의사항: 문제 해결 및 효율적인 활용 팁

Git Hook을 사용할 때 예상치 못한 문제에 직면할 수 있으며, 효율적인 활용을 위한 몇 가지 팁이 존재합니다. 본 섹션에서는 Git Hook 사용 시 발생할 수 있는 일반적인 문제점을 진단하고, 해결 방법을 제시합니다. 또한, Git Hook을 보다 효율적으로 활용할 수 있는 실질적인 조언을 제공합니다.

→ 6.1 문제 해결

Git Hook 스크립트가 제대로 실행되지 않는 경우, 먼저 스크립트의 실행 권한을 확인해야 합니다. chmod +x .git/hooks/your_hook_name 명령어를 사용하여 실행 권한을 부여할 수 있습니다. 스크립트 내부에 오류가 있을 가능성도 존재하므로, 스크립트 실행 로그를 확인하여 오류의 원인을 파악하는 것이 중요합니다. 오류 메시지를 통해 문제 해결의 실마리를 찾을 수 있습니다.

또한, Git Hook 스크립트가 너무 많은 시간을 소요하는 경우, 커밋이나 푸시 작업이 지연될 수 있습니다. 이러한 경우에는 스크립트의 실행 시간을 최적화하거나, 불필요한 검사를 제거하는 것을 고려해야 합니다. 예를 들어, 변경된 파일에 대해서만 코드 스타일 검사를 수행하도록 스크립트를 수정할 수 있습니다.

→ 6.2 효율적인 활용 팁

Git Hook 스크립트를 효율적으로 관리하기 위해, 훅 스크립트를 Git 저장소에 함께 저장하는 방법을 고려할 수 있습니다. 이를 통해 팀원 모두가 동일한 훅 스크립트를 사용하도록 보장할 수 있습니다. 이를 위해, 훅 스크립트를 별도의 디렉토리에 저장하고, .git/hooks 디렉토리에 심볼릭 링크를 생성하는 방법을 사용할 수 있습니다.

더불어, pre-commit 훅을 사용하여 코드 스타일 검사를 자동화하는 것은 매우 효과적입니다. 이를 통해 개발자는 코드를 커밋하기 전에 잠재적인 문제를 식별하고 수정할 수 있습니다. 예를 들어, ESLint와 Prettier를 pre-commit 훅과 연동하여 코드 스타일을 자동으로 검사하고 수정할 수 있습니다. 다음은 pre-commit 훅 스크립트의 예시입니다.


#!/bin/sh
# pre-commit hook to run ESLint and Prettier
echo "Running ESLint and Prettier..."
npx eslint . --fix
npx prettier --write .
git add .
echo "ESLint and Prettier complete."

마지막으로, Git Hook 스크립트를 작성할 때는 예외 처리를 고려하는 것이 중요합니다. 스크립트가 실패하더라도 커밋 작업이 중단되지 않도록, 오류 발생 시 적절한 메시지를 출력하고 커밋을 계속 진행하도록 설정할 수 있습니다. 이를 통해 개발자는 코드 품질을 유지하면서도 개발 프로세스를 방해받지 않을 수 있습니다.

📌 핵심 요약

  • ✓ ✓ 훅 스크립트 실행 권한 확인 및 로그 분석 필요
  • ✓ ✓ 스크립트 실행 시간 최적화로 지연 방지
  • ✓ ✓ 훅 스크립트 저장소 공유로 팀 표준화
  • ✓ ✓ pre-commit 훅으로 코드 스타일 자동 검사

7. 커밋 전 자동 검사, 지금 바로 시작하세요!

이제 Git Hook을 활용하여 커밋 전에 코드 스타일을 자동으로 검사하는 방법을 알아볼 시간입니다. 앞서 다룬 ESLint, Prettier, commit-msg, pre-commit Hook 설정을 통해 이미 기반은 마련되었습니다. 이 섹션에서는 실제로 이러한 설정들을 통합하고, 커밋 전에 코드를 자동으로 검사하도록 구성하는 방법을 안내합니다.

→ 7.1 통합 설정

먼저, 프로젝트 루트 디렉토리에 .husky 폴더가 있는지 확인합니다. 만약 없다면 npm install husky --save-dev 또는 yarn add husky --dev 명령어를 사용하여 Husky를 설치합니다. Husky는 Git Hook을 쉽게 관리할 수 있도록 도와주는 도구입니다.

Husky를 설치한 후, package.json 파일에 다음 스크립트를 추가합니다. 이 스크립트는 Husky를 활성화하고, 필요한 Git Hook을 설정하는 역할을 수행합니다.


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

npm install 또는 yarn install 명령어를 실행하여 Husky를 설치하고, npm run prepare 명령어를 실행하여 Husky를 초기화합니다. 이를 통해 .husky 폴더가 생성되고, Git Hook을 설정할 준비가 완료됩니다.

→ 7.2 pre-commit Hook 설정

.husky 폴더에 pre-commit 파일을 생성하고, 실행 권한을 부여합니다. 이 파일에 다음과 같은 내용을 추가하여 커밋 전에 ESLint와 Prettier를 실행하도록 설정합니다.


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

npm run lint
npm run format
git add .

위 스크립트는 커밋 전에 npm run lint와 npm run format 명령어를 실행합니다. npm run lint 명령어는 ESLint를 실행하여 코드 스타일을 검사하고, npm run format 명령어는 Prettier를 실행하여 코드 스타일을 자동으로 수정합니다. 마지막으로 git add . 명령어를 사용하여 수정된 내용을 스테이징합니다.

→ 7.3 실제 커밋 테스트

이제 실제로 코드를 변경하고 커밋을 시도해 봅니다. 만약 ESLint 또는 Prettier에 의해 코드 스타일 문제가 발견되면, 커밋이 중단되고 오류 메시지가 표시됩니다. 오류 메시지를 확인하고 코드를 수정하여 다시 커밋을 시도합니다. 코드 스타일 문제가 없으면 커밋이 성공적으로 완료됩니다.

예를 들어, JavaScript 파일에 불필요한 공백이 있거나, 세미콜론이 누락된 경우 ESLint가 이를 감지하고 오류 메시지를 표시합니다. Prettier는 자동으로 이러한 문제를 수정하고, 수정된 내용을 커밋에 포함시킵니다.

→ 7.4 추가적인 설정

필요에 따라 lint-staged를 사용하여 스테이징된 파일에 대해서만 ESLint와 Prettier를 실행할 수 있습니다. 이는 커밋 시간을 단축하고, 불필요한 검사를 줄이는 데 도움이 됩니다. lint-staged를 사용하려면 먼저 npm install lint-staged --save-dev 또는 yarn add lint-staged --dev 명령어를 사용하여 설치해야 합니다.

package.json 파일에 다음과 같은 설정을 추가합니다.


"lint-staged": {
  "*.{js,jsx,ts,tsx}": [
    "eslint",
    "prettier --write"
  ]
}

.husky/pre-commit 파일을 다음과 같이 수정합니다.


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

npx lint-staged

이제 커밋을 시도하면 스테이징된 JavaScript, JSX, TypeScript, TSX 파일에 대해서만 ESLint와 Prettier가 실행됩니다.

지금 바로 Git Hook으로 코드 품질 향상!

이제 Git Hook을 통해 커밋 전 코드 스타일 자동 검사를 설정하여 깔끔하고 일관성 있는 코드를 유지할 수 있습니다. ESLint와 Prettier 연동으로 협업 효율성을 높이고 지속 가능한 개발 환경을 만들어 보세요. 오늘부터 코드 품질 관리를 자동화하여 더욱 효율적인 개발자가 되어보세요!

📌 안내사항

  • 본 콘텐츠는 정보 제공 목적으로 작성되었습니다.
  • 법률, 의료, 금융 등 전문적 조언을 대체하지 않습니다.
  • 중요한 결정은 반드시 해당 분야의 전문가와 상담하시기 바랍니다.