AI로 개발 생산성 극대화 #3: commitlint로 Git 커밋 메시지 규칙 검증하기

commitlint는 Git 커밋 메시지가 특정 규칙을 따르도록 검증해주는 도구입니다. 주로 팀 프로젝트에서 일관된 커밋 메시지 형식을 유지하기 위해 사용됩니다. commitlint를 사용하기 위해서는 몇 가지 단계를 거쳐야 합니다. 아래에 그 과정을 설명드릴게요.

1. 프로젝트에 commitlint 설치하기

먼저, 프로젝트에 commitlint를 설치해야 합니다. npm 또는 yarn을 사용하여 설치할 수 있습니다.

# npm을 사용하는 경우
npm install --save-dev @commitlint/{config-conventional,cli}

# yarn을 사용하는 경우
yarn add --dev @commitlint/{config-conventional,cli}

2. commitlint 설정 파일 추가하기

프로젝트 루트 디렉토리에 commitlint.config.js 파일을 생성하고, 다음과 같이 설정합니다.

// commitlint.config.js
module.exports = {
  extends: ['@commitlint/config-conventional']
};

3. Husky 설치 및 설정하기

commitlint를 자동으로 실행하기 위해 Husky를 사용할 수 있습니다. Husky는 Git 훅을 쉽게 설정할 수 있게 도와주는 도구입니다.

# Husky 설치
npm install --save-dev husky

# Husky 초기화
npx husky init

Husky를 설치한 후, commit-msg 훅을 추가하여 commitlint를 실행하도록 설정합니다.

# commit-msg 훅 추가
echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg

4. 커밋 메시지 작성 규칙

commitlint는 기본적으로 Conventional Commits 규칙을 따릅니다. 이 규칙에 따라 커밋 메시지를 작성해야 합니다.

예를 들어:

feat: 새로운 기능 추가
fix: 버그 수정
docs: 문서 수정
style: 코드 포맷팅, 세미콜론 누락 등
refactor: 코드 리팩토링
test: 테스트 추가
chore: 빌드 업무 수정, 패키지 매니저 설정 등

5. 커밋 메시지 예시

git commit -m "feat: 사용자 로그인 기능 추가"
git commit -m "fix: 로그인 오류 수정"

이제 commitlint와 Husky가 설정되었으므로, 커밋 메시지가 규칙을 따르지 않으면 자동으로 검증되고 오류가 발생합니다.

이렇게 하면 프로젝트에서 일관된 커밋 메시지 형식을 유지할 수 있습니다. 추가적인 설정이나 규칙이 필요하다면 commitlint.config.js 파일을 수정하여 커스터마이징할 수 있습니다.

5. opencommit 설정

opencommit를 사용하고 있다면, 프로젝트 루트에 .env 파일을 만들고 여기에 다음과 같이 OpenCommit 구성 변수를 추가합니다:

OCO_PROMPT_MODULE=@commitlint

#AI로개발생산성극대화

• AI로 개발 생산성 극대화 #1: 다양한 AI 코딩 도우미 소개
• AI로 개발 생산성 극대화 #2: Git 커밋 메시지 AI 자동 생성
• AI로 개발 생산성 극대화 #3: commitlint로 Git 커밋 메시지 규칙 검증하기

_{Posted using Obsidian Steemit plugin}