Gitのコミットメッセージを効果的に統一するためにcommitizenを利用する

commitizenとは

commitizenは、Gitのコミットメッセージを効果的に統一するためのツールで、対話的なプロンプトを提供してコミットメッセージを作成できる。これにより、一貫性のあるメッセージを作成しやすくなる。

導入

commitizenのインストール

最初に、以下のコマンドを使用してcommitizenをグローバルにインストールする。

➜ npm install -g commitizen

これにより、commitizenがコマンドラインから利用可能になる。

cz-conventional-changelogのインストール

commitizenを使用する際、どのような形式でコミットメッセージを記述するかを定義するツールが必要となる。今回は、cz-conventional-changelogを使用する。cz-conventional-changelogは、Conventional Commitsと呼ばれるフォーマットに従ったコミットメッセージの記載が可能となる。

以下のコマンドを実行して、これをインストールする。

➜ npm install -g cz-conventional-changelog

設定ファイルに追加する。

➜ vim .czrc
{ "path": "cz-conventional-changelog" }

これにより、cz-conventional-changelogが利用可能になる。

使用方法

通常のgit commitコマンドではなく、 git czコマンドを使用してコミットメッセージを作成する。このコマンドを実行すると、対話型のプロンプトが表示され、コミットメッセージの各部分を選択して入力することができる。

➜ git:(main) touch test.md
➜ git:(main) ✗ git add test.md
➜ git:(main) ✗ git cz
cz-cli@4.3.0, cz-conventional-changelog@3.3.0

? Select the type of change that you're committing: (Use arrow keys)
❯ 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

Tags: