git 커밋 접두사 입력을 지원하는 Vim 플러그인 : vim-git-commit-prefix를 만들었습니다.

소개

Vim 플러그인의 공부를 세세하게 계속하고 있어, 이제 간단한 플러그인을 만들어 보고 싶다고 생각해 만든 플러그인을 소개합니다.

vim-git-commit-prefix란?

gotchane/vim-git-commit-prefix 은 git에서 커밋 메시지를 편집 할 때 접두사 후보를 표시하는 플러그인입니다.

git 의 디폴트 에디터를 vim 으로 한 상태로 git commit 를 하면(자), 편집 화면의 최초에 접두사의 후보를 표시해 줍니다.

2020/02/16 추가:

이하 PR 를 보내 주셨습니다! 보다 편리하게 되었다고 생각합니다. 감사합니다! !

Vim에서 git을 조작하는 플러그인, vim-fugitive 또는 gina.vim 에서도 작동하도록

fix: plugin is called when messages are already typed by kuuote · Pull Request #2 · gotchane/vim-git-commit-prefix · GitHub

git commit --amend 이나 git rebase 안의 reword 등에서는 플러그인이 발화하지 않도록

feat: works with git plugin's commit window by kuuote · Pull Request #1 · gotchane/vim-git-commit-prefix · GitHub

사용법

플러그인 관리자에서 플러그인을 설치합니다.

call dein#add('gotchane/vim-git-commit-prefix')

그리고 git의 기본 편집기를 vim으로 설정하면 괜찮습니다.

$ git config --global core.editor vim

git commit 를하면 편집기 시작과 동시에 커밋 접두사 완성이 표시된다고 생각합니다. 상하에서 후보를 선택하세요.

2020/02/16 추가:

Vim에서 git을 조작하는 플러그인으로 이용되는 분은, 각각의 플러그인으로 git commit 상당한 조작을 하면 이용할 수 있습니다.

vim-fugitive 의 경우

:Gcommit

gina.vim 의 경우

:Gina commit

접두사 정보

angular.js/DEVELOPERS.md 을 답습하고 다음을 선택할 수 있습니다.

feat: A new feature

fix: A bug fix

docs: Documentation only changes

style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

refactor: A code change that neither fixes a bug nor adds a feature

perf: A code change that improves performance

test: Adding missing or correcting existing tests

chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

만든 배경

사내에서 커밋 접두사를 붙이는 것이 유행하고 있거나, 커밋 접두사의 유용성에 관한 기사를 읽거나 하고 있어, 커밋 접두사 붙이는 운용해 보고 싶다고 생각했습니다. 그러나 막상 하려고 하면 기분으로 붙이거나 붙이거나 하고, 계속하는 것은 어렵다고 느꼈습니다.

그래서 커밋 메시지를 편집할 때 강제로 접두사를 보완해주는 것이 없는지를 찾고 있었습니다. cz-cli 라는 접두사 완성을 지원하는 도구도 있는 것 같습니다만, 나는 커밋 메세지 편집을 vim 로 하고 있었다고 하는 일도 있어, vim 플러그인의 공부의 제목이 되어도 좋다고 생각해 , vim 플러그인을 만들어보기로 결정했습니다.

실제로 스스로 사용하기 시작하고 나서는, 반드시 접두사를 붙이는 의식이 붙었으므로 편리하게 사용하고 있습니다.

결론

처음 만든 플러그인이므로 거친 제작이라고 생각합니다만, 좋으면 사용해 보세요. Issue, PR 기다리고 있습니다!

참고

【오늘부터 할 수 있다】 커밋 메시지에 「접두사」를 붙이는 것만으로, 개발 효율이 오른 이야기 - Qiita