Conventional Commits をする CLI git-cc を Rust で作った
2022-05-09 公開
最近 Rust を勉強しているに書いたように、プライベートの時間を使って Rust の勉強をしています。 今回、Conventional Commits を作成する CLI を Rust で作成しました。
Conventional Commits
Conventional Commits はコミットメッセージの仕様です。
「人間と機械が読みやすい」ことをコンセプトにした仕様で、SemVer と連携しつつ様々な自動化を容易にすることが可能になります。
例えば、後方互換性のある新しい API を追加するコミットのメッセージは feat: add new api のようになり、type にあたる feat を読み取ることでマイナーバージョンアップを行います。
仕様の詳細は下記のページが参考になります。
Angular のコミットメッセージガイドラインにインスパイアされたものらしく、Web フロントエンドや Node.js 系のコミュニティでよく使われているのを見かけます。 最近だと Deno の開発でも使用されていますね。
業務においてチームとしてきっちりルールを決めて運用したような経験はないですが、個人的にこの仕様に則ったコミットメッセージを書くことが多いです。 コミットメッセージの一行目を見るだけで
- どのような種類の変更であるか
- どのような変更であるか
が一定のルールで記述されるので、Conventional Commits に則ってメッセージを作成することで理解しやすいコミットを自然と作成できることがメリットだと感じています（逆に、適切なコミットメッセージをつけられるようなコミットの粒度を意識するように矯正できるとも言えるかもしれません）。
普段は VSCode の Conventional Commits 拡張機能（Conventional Commits - Visual Studio Marketplace）を使ってコミットすることが多かったのですが、ターミナル上で git コマンドと一緒に動かせるものを探した結果自分で作ってみることにしました。
git-cc
CLI は以下のような方針で作成しました。
git-xxxという CLI にする- Rust で作る
- インタラクティブな UI をもつ
git には git-subcommand という実行可能ファイルを PATH に追加しておくと git subcommand で実行できる仕組みがあります。
git add したのちに git xxx でコミットできるような統一感がほしいなーと思い、git-cc という CLI を作ることにしました。
（cc は conventional commits あるいは commit conventionally の略です）
使用言語は現在勉強している Rust にしました。 書き捨てるための Rust - Qiitaという記事を読んで、とりあえず動くものを書いてみてリファクタリングしながら Rust への理解をより深めていこうと思いました。 CLI を作るための crate も充実していたのでさほど困ることも多くなかったです。 と言いつつ、v0.1.0 の時点では最低限の実装しかしていないため、インタラクティブなプロンプトを提供してくれる dialoguer にのみ依存しています。 使用していた VSCode 拡張機能と似たような使い勝手にしたかったので、質問に一つ一つ回答していけば自然と Conventional Commits なコミットメッセージができあがるようにしました。
利用方法
インストール
2022 年 5 月 9 日時点では cargo install によるインストールのみ対応しています。
$ cargo install git-cc
使い方
インデックスにファイルがある状態で git-cc または git cc を呼び出すだけです。
$ git add hoge.txt
$ git-cc
# or
$ git cc
デモ
まとめ
The Book のコマンドラインプログラムのパートや Command Line Applications in Rust を読みながら実装をすることで詰まることなく簡単な CLI の作成ができました。 core API や crate のドキュメントが充実していてかつ統一的で見やすいことも Rust の利点だと感じました（Go でも似たような経験はできますね）。 自分でも使い倒しながらブラッシュアップしていきます。
