Gitのコミットメッセージで feat:fix:chore: といったプレフィックス(Conventional Commits)を使っていると、「あれ、設定ファイルの変更って chore だっけ? style だっけ?」 と度忘れしてしまうことはありませんか?

毎回ブラウザで検索するのも地味にストレスですよね。

今回は、普段使っているターミナルで コマンドを1回打つだけで一瞬でプレフィックス一覧を表示できるエイリアス(alias)の設定手順 を解説します。

スポンサーリンク

達成イメージ

ターミナルで git-prefix と入力して Enter を押すだけで、以下のようにチートシートがサッと表示されます。

$ git-prefix

feat:     新機能追加
fix:      バグ修正
docs:     ドキュメントのみの変更
style:    コードの意味に影響を与えないフォーマット修正
refactor: リファクタリング(機能追加・バグ修正を含まない)
perf:     パフォーマンス改善
test:     テストコードの追加・修正
chore:    ビルド、設定ファイル、依存関係の更新など
ci:       CI/CD設定の変更

作業の画面から切り替えることなく確認できるので、git commit -m派 の人には特におすすめです。

設定手順(3ステップ)

作業は 約2分 で完了します。

Step 1. Zshの設定ファイル(~/.zshrc)を開く

ターミナルを開き、以下のコマンドで設定ファイルを開きます。

nano ~/.zshrc

(VS Codeで編集したい場合は code ~/.zshrc でもOKです)

Step 2. エイリアスコードを貼り付ける

ファイルの最下行に、以下の設定コードをコピー&ペーストします。

# Git Commit Prefix Cheat Sheet
alias git-prefix='echo "
feat:     新機能追加
fix:      バグ修正
docs:     ドキュメントのみの変更
style:    コードの意味に影響を与えないフォーマット修正
refactor: リファクタリング(機能追加・バグ修正を含まない)
perf:     パフォーマンス改善
test:     テストコードの追加・修正
chore:    ビルド、設定ファイル、依存関係の更新など
ci:       CI/CD設定の変更
"'

カスタマイズのヒント

git-prefix の部分を gprefgc-help など、入力しやすいショートカット名に変更しても問題ありません。

Step 3. 設定を反映する

設定ファイルを保存して閉じた後、変更をシェルに反映させます。

source ~/.zshrc

これで準備完了です!

スポンサーリンク

使い方

プレフィックスの分類に迷ったら、ターミナルで登録したコマンドを叩くだけです。

git-prefix

一覧を確認しながら、そのまま以下のようにコミットを打ち込めます。

git commit -m "chore: 依存ライブラリのアップデート"

まとめ

暗記しようとしなくても、「すぐに見られる仕組み」 を開発環境の中に作っておくことで、無駄な検索時間をゼロにできます。

「いつもプレフィックスを何にするか迷ってしまう」という方は、ぜひ試してみてください!


この記事が気に入ったら『目黒で働く分析担当の作業メモ』ご支援をお願いします!

※OFUSEに飛びます


おすすめの記事