Gitのブランチに説明をつける方法 / もうちょっと楽するツールを作った

1 min read 1

最近Gitのブランチに説明を設定できる機能を知りました。
普段ブランチ名はプロジェクトで管理しているチケットIDをそのままつけているのですが、IDの桁数が増え数字の認知がしづらくなり困っていたので、その機能にさて幸いと飛びつきました。

ブランチの説明を編集する

git branch --edit-description {ブランチ名(省略時はカレントブランチ)}

ブランチの説明を見る

git config branch.{ブランチ名}.description

・・・編集する方はともかくとして、見る方のコマンドが全く使いやすいと思えません🥲 なので、ブランチ一覧とブランチの説明を同時に表示してブランチの操作をいい感じにできるツールを作りました。

https://github.com/nyamogera/git-branches

▼ ブランチの選択画面

▼ ブランチの操作画面

  • インストール
    ターミナルやPowerShellで以下のコマンドを入力します
npm install -g https://github.com/nyamogera/git-branches
  • 使い方
    ターミナルやPowerShellで以下のコマンドを入力します
git-branches
  • オプションとして、以下のコマンドを入力できます
    • 動作(いずれの1つのみ指定可能)
      • --edit ブランチ説明を編集する
      • --checkout
      • --delete
    • ブランチの指定
      • --current カレントブランチを初期で選択し、ブランチの選択を省略します

▼ 例)以下のようにコマンドを入力すると、ブランチの選択後そのままブランチをチェックアウトします

git-branches --checkout

▼ 例)以下のようにコマンドを入力すると、ブランチの選択なしに、ブランチの説明編集画面へ移行します。

git-branches --current --edit

git branch --edit-descriptionと対して入力量が変わらない、かつ、カレントブランチでできる操作がeditしかないというツッコミは自分の中で何度かしました


なお、stackoverflowでブランチと説明を同時表示するシェルスクリプトも見つけました。こっちは選択できないけど、サクッと解決してて良いと思います。

https://stackoverflow.com/questions/2108405/branch-descriptions-in-git
GitHubで編集を提案

Discussion

試させていただきました。これは神ツールですね😍

ログインするとコメントできます