はじめに
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でも動作するように
-
git commit --amendやgit rebase中のreword等ではプラグインが発火しないように
使い方
プラグインマネージャーでプラグインをインストールします。
call dein#add('gotchane/vim-git-commit-prefix')
そして、git のデフォルトエディタを vim にすればOKです。
$ 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 お待ちしてます！