git commit -m 을 작성할때마다 이슈 라벨, 이슈 번호를 적는게 귀찮아서 만든 npm 패키지 입니다

npm install byul

사용법은 여기서 보십쇼 : https://github.com/uujajeok/byul

만든지 이틀만에 1487회 다운로드 찍었습니다 ( 사이드프로젝트 최고기록 )

작동 원리

Git에서 변경 사항을 커밋할 때, byul은 다음 단계를 통해 커밋 메시지를 자동으로 포맷합니다:

1. 브랜치 이름 조회: byul이 현재 브랜치 이름을 가져옵니다.

2. 커밋 메시지 포맷팅: 커밋 메시지는 브랜치 유형(예: feature:)으로 접두어가 추가되고, 이슈 번호가 있을 경우 접미어로 추가됩니다.

3. 기존 훅과의 통합: 기존에 commit-msg 훅이 있는 경우, byul은 그 기능을 덧붙여 원활하게 통합됩니다.

예시

feature/login-123 브랜치에서 다음과 같이 커밋하는 경우:

git commit -m "로그인 로직 추가"

byul은 메시지를 자동으로 다음과 같이 포맷합니다:

feature: 로그인 로직 추가 #123

커스터마이징도 가능합니다

byul.config.json 파일을 수정하여 커밋 메시지 형식을 커스터마이징할 수 있습니다. 예를 들어, 다음과 같은 설정을 사용할 수 있습니다:

{

"byulFormat": "(#{issueNumber}) {type}: {commitMessage}"

}

feature/login-123 브랜치에서 커밋 메시지를 사용했을 때:

git commit -m "로그인 로직 추가" < 해당 커밋 메시지는 다음과 같이 포맷됩니다:

(#123) feature: 로그인 로직 추가

이런식으로 동작합니다 간단한데 편해요

한번 써보시고 문제있으면 깃허브 이슈 작성 부탁드립니다.

감사합니다