読者です 読者をやめる 読者になる 読者になる

その手の平は尻もつかめるさ

ギジュツ的な事をメーンで書く予定です

「Kyoto.なんか」でgithub-commit-comment.vimの話をしました

Kyoto.なんか」というイベントで,最近書いたgithub-commit-comment.vimというVimプラグインの話をしてきました.お招きいただきありがとうございます.

github-commit-comment.vim

https://github.com/moznion/github-commit-comment.vim


Vim上からGitHubのコミットコメントの投稿と参照が出来るというプラグインです.
GitHubのコミットコメントには,

  • 行単位のコメント
  • ファイル単位のコメント
  • コミット単位のコメント

と,3種類のコミットコメントが存在しており,これらすべてに対するコメントが可能となっています.
詳しくは上記URLのREADMEを読むと良いと思います.Gifアニメを大量に貼っているので,なんとなく雰囲気がつかめるでしょう.
なお,READMEには書いていないのですが,このプラグインはcommit commentの内容をすべてquickfixに流し込んでいるので,
:cwindowコマンドを発行してやると,そのファイルに対するコメント一覧を見ることができます.地味に便利だ.


開発のモチベーションとしては,コードレビューをする時 (というかコードを読む時) に任意のエディタでやりたいという欲求があって,僕の場合はVimでそれをやっているんですけれども,
Vimでコード読みながら「コミットコメントを付けたいなーー」って時にGitHubが開いているブラウザとそのエディタとの間を行ったり来たりするのは大変に面倒なわけで,
そこら辺を上手く解決したい!!!!! という事でグワーッと書いたという感じです.


ひとまず便利は便利なのですが,色々と問題点というかわからない部分があって,それは例えば

  • コメントは,HEADのリビジョンではなく,そのファイルが最後に変更されたリビジョンに反映されるのはOK?
  • そもそもgitのoriginに決め打ちなのはどうなのか
  • 行単位のコメントをした時に,そこが変更点ではない *1 場合に微妙 (とはいえexpandすれば見れる)
  • 実際Pull-Requestとかでも使いたいよねー

などなど色々あり,ここら辺は使っていって追々機能を追加したり修正したりしていく感じかなあと思っています.


類似のプラグインvim-github-commentというものがあるのですが,
こちらは1行しかコメントを追加できなかったり,Vimからcommit commentを参照出来なかったりしてちょっと不便,
というか思想が違うのかな,と思ってフルスクラッチで書いた次第です.


フィードバック等頂けると嬉しいです.

*1:つまりGitHubのdiffとして現れない