Husky로 Java 자동 포맷팅 설정하기 (google-java-format)

🐾 macOS + Husky로 Java 자동 포맷팅 설정하기 (google-java-format)

커밋할 때마다 코드 스타일 맞추는 게 은근히 번거롭더라구요 ㅠㅠ
그래서 Husky와 google-java-format을 연동해서 커밋 전에 자동으로 포맷팅되게 세팅해봤습니다 😀

ℹ️ 사전 요구 사항

google-java-format은 Java 기반 도구라 JDK 없으면 실행 자체가 안 됩니다.
시작 전에 JDK가 설치되어 있는지 먼저 확인해 주세요!

---

🛠 프로젝트 초기화

프로젝트 루트에서 아래 명령을 실행합니다.

npm init -y

실행하면 package.json이 생성됩니다.

Husky는 npm 패키지로 관리되기 때문에 package.json이 없으면 설치가 안 됩니다.

---

🐶 Husky 설치

1️⃣ Git Hook을 쉽게 관리해 주는 Husky를 설치합니다.

npm install --save-dev husky

2️⃣ 설치가 끝났다면 Husky를 초기화합니다.

npx husky init

3️⃣ 실행하면 .husky 폴더와 기본 Hook 파일이 자동으로 생성됩니다.

.husky/
 └── pre-commit

4️⃣ package.json에도 아래 스크립트가 자동으로 추가됩니다.

"scripts": {
  "prepare": "husky"
}

prepare 스크립트 덕분에 팀원이 npm install만 해도 Husky가 자동으로 활성화됩니다.
팀 프로젝트에서 쓰면 따로 세팅 안 해도 돼서 진짜 편해요 👍

ℹ️ Hook이란?

Hook은 프로그램이 어떤 작업을 진행하는 특정 순간에 끼어들어 추가 작업을 실행하는 장치입니다.
Git에서는 commit이나 push 같은 이벤트가 발생할 때 "잠깐! 이 작업 하기 전에 이것도 같이 실행하자" 라고 작업을 연결할 수 있습니다.

---

✅ Husky 설치 확인

아래 명령으로 설치가 제대로 됐는지 확인할 수 있습니다.

npm list husky

📥 출력 예시

husky@9.x.x

버전이 표시되면 정상적으로 설치된 겁니다

---

⏩ google-java-format 사용 준비

google-java-format은 Google Java Style Guide 기준으로 Java 코드를 자동 정리해 주는 포맷터입니다.

원래는 JAR 파일로 실행하는 CLI 도구인데,
Husky 같은 Node 기반 도구와 연동하기 편하도록 npm 패키지도 따로 제공하고 있어요.

이 글에서는 npm 패키지 방식으로 진행합니다.

goole-java-format을 설치합니다

npm install --save-dev google-java-format

ℹ️ 코드 스타일을 직접 설정하고 싶다면?

google-java-format은 설정 파일 없이 Google Java Style을 그대로 적용합니다.
들여쓰기나 줄 길이 같은 세부 스타일은 직접 수정할 수 없습니다.

스타일을 커스터마이징하고 싶다면 clang-format을 사용하는 방법도 있습니다. .clang-format 설정 파일로 다양한 옵션을 직접 조정할 수 있어요.

🔗 clang-format 사용법 보기

---

🪄 Husky Pre-Commit Hook 설정

이제 커밋 전에 Java 파일을 자동으로 포맷팅하는 Hook을 만들어 보겠습니다 ✨

1️⃣ .husky 폴더 생성

mkdir -p .husky

Husky 초기화 때 이미 생성됐을 수도 있습니다.
-p 옵션을 쓰면 폴더가 이미 있어도 오류 없이 넘어가니까 그냥 실행해도 됩니다.

2️⃣ pre-commit 파일 생성

touch .husky/pre-commit

파일을 열고 아래 내용을 추가합니다.

#!/bin/bash
echo "🧹 Running google-java-format..."

git diff --cached --name-only --diff-filter=ACM | grep '\.java$' | while IFS= read -r file; do
  echo "Formatting $file"
  ./node_modules/.bin/google-java-format --replace "$file"
  git add "$file"
done

저장 후 실행 권한을 부여합니다.

chmod +x .husky/pre-commit

🎯 위 과정 한번에 실행하기

매번 하나씩 치기 귀찮다면 아래 명령으로 한 번에 끝낼 수 있습니다.

mkdir -p .husky

cat > .husky/pre-commit <<'EOF'
#!/bin/bash
echo "🧹 Running google-java-format..."

git diff --cached --name-only --diff-filter=ACM | grep '\.java$' | while IFS= read -r file; do
  echo "Formatting $file"
  ./node_modules/.bin/google-java-format --replace "$file"
  git add "$file"
done
EOF

chmod +x .husky/pre-commit

---

🚀 동작 테스트

이제 실제로 커밋해서 잘 동작하는지 확인해 보겠습니다.

git add .
git commit -m "test(husky): verify java formatting hook"

📥 정상 동작 예시

🧹 Running google-java-format...
Formatting src/main/java/Test.java

Java 파일이 자동으로 포맷팅되는 것을 확인할 수 있습니다 🎉

---

🧾 .gitignore

node_modules/

---

📂 프로젝트 구조 예시

java-project/
├── .husky/
│   └── pre-commit
├── src/
│   └── main/java/
├── .gitignore
├── package.json
└── README.md

---

🎉 마무리

처음 세팅할 때는 조금 번거롭게 느껴질 수 있습니다.
하지만 한 번만 해두면 커밋할 때마다 코드 스타일이 자동으로 정리되니까 그 이후로는 신경 안 써도 됩니다.
코드 리뷰할 때 스타일 얘기 안 나오는 것만으로도 충분히 값어치 있어요 😄