TODOコメントにGitのbranch名を入れたい

めっちゃ雑なメモ。

今いるチームではTODOは"必ずやらなければならないこと"にだけ付けるというルールがあって、だいたいshibayuさんのブログの通りに運用してる。

最近コード中のTODOコメントの書き方を工夫している - $shibayu36->blog;

自分の場合割とGitのbranch名に機能名とかをprefixとしてつけいるので、TODO(feature-phase)的なTODOを延々と量産してはやったら消すし、やってないなら残したままmergeして適切なタイミング(リリース前とか次のbranchとか)で消すようにしている。 残っているTODOを確認するのも TODO(feature をgit grepなりagなりで検索すればよい。

割と量産するので、TODO(branch-name)を毎回打つの面倒だし、コピペするのも行ごとってわけじゃなくてやはり面倒なので、勝手にbranch名取ってきて挿入してくれるneosnippetのスニペットを書いた。

snippet     todo
options     head
    # TODO(`substitute(system('git rev-parse --abbrev-ref HEAD'), '\n\+$', '', '')`) : ${0}

これでtodoを展開すると# TODO(feature-phase) : みたいなのができあがって便利。

git管理下以外では動かないけど、そもそもそういうところで使わないので気にしていない。