【ChatGpt】aicommitsでGitのコミットメッセージを自動生成する

環境

• windows10
• macOS Monterey 12.0.1
• VsCode

動作イメージ

aicommitsというnpmパッケージを使用する

追跡対象のファイルをステージングに上げた後（git add後）、aicommits をターミナル上で打つことで、ファイルの変更内容からコミットメッセージを生成し、その候補を提示してくれる

生成するコミットメッセージの数や形式については別途設定で変更可能

設定手順

aicommitsのインストール

npm install -g aicommits

OpenAIのAPI KEYのセット

以下のコマンド実行後、ホーム ディレクトリにファイルが作成され、その中にOPENAI_KEYが追記される。aicommits config setでセットした項目は、このファイルに書き込まれることになる

aicommits config set OPENAI_KEY=<your token>

設定値を取得したい場合は、以下のgetコマンドで可能。

aicommits config get OPENAI_KEY

正常にインストールできているか確認

aicommits --version

使い方

最も基本的な使い方

追跡対象のファイルをステージングに上げた後（git add後）、aicommits をターミナル上で打つ。そうすると、コミットメッセージの候補を1つ生成してくれる。Yを押すとコミット実行、Nを押すと、コミットキャンセルとなる

aicommits

コミット時にステージングへの追加もまとめて行う

ハイフンaオプションつけて実行すると、追跡対象の未ステージング（git add前）のファイルをステージングに追加しつつ、コミットメッセージの生成まで一括で行ってくれる

aicommits -a

複数のコミットメッセージを生成する

ハイフンgオプションに続けて、生成したいメッセージの数を指定する

aicommits -g 5

※指定した数のコミットメッセージが生成されない場合もある。。

コミットメッセージの形式をConventional Commitsに変更する

ハイフンtオプションに続けて、conventionalを指定すると、Conventional Commits（コミットメッセージのための軽量の規約）に沿った形式で生成される。

aicommits -t conventional

まとめ

いかがでしたでしょうか。今回は、aicommitsというChatGptを活用したライブラリを用いて、Gitのコミットメッセージを自動生成するための導入手順や具体的な使い方について紹介しました。こちらを使用することによって、より開発効率を向上させることが可能になりますので、是非活用してみてください。