15
4

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 3 years have passed since last update.

VSCodeでGitのコミットメッセージを書きやすくする拡張機能

Last updated at Posted at 2021-09-30

VSCodeのソース管理でGitのコミットメッセージを書く時の不満点

VSCodeでGitのコミットを行う時、コミットメッセージの入力はどうしていますか?
普通に下画像の、ソース管理のコミットメッセージ入力欄で書いているという方が多いのではないでしょうか?

image.png

この入力欄に、私は以下のような不満を感じていました。

入力欄が狭い

このVSCodeのソース管理機能が表示される左側のペインは、通常それほどの幅は取っていないと思います。しかし、通常取っている幅だと日本語にして20文字程度しか入らず、コミットメッセージを書くにはさすがに狭すぎます。
そのため、コミットメッセージを書くたびに左側のペインを広げたり狭めたりする必要があります。
また、改行すると行が追加されていきますが、行数が多くなっても最大5行ほどしか同時に表示できません。縦も横も窮屈です。

入力欄のフォントがプロポーショナルフォント

入力欄のフォントがプロポーショナルフォントであるため、文字種によっては入力した桁数がどのくらいなのか視覚的にわからなくなります。
1行の桁数が多くなってコミットメッセージとして推奨されている文字数を超えると一応警告を出してくれるのですが、日本語も1文字1桁と計算してしまうので、通常1文字でアルファベット2桁分の幅を取る日本語のコミットメッセージだと全く用をなしていない状態です。

Commit Message Editor 拡張機能

そこでなにか良い拡張機能はないかと探したところ、その名も Commit Message Editor という拡張機能を見つけました。

Commit Message Editor 拡張機能をインストールすると、ソース管理のコミットメッセージのところに下のようなペンのアイコンが追加されます。

image.png

これを押すとエディタ領域に以下のようなコミットメッセージの入力欄が現れます。

image.png

この入力欄にメッセージを入力して、「Save」ボタンを押すと通常のソース管理のメッセージ入力欄に内容が反映されるので、そのままチェックアイコンを押すなりしてコミットすればOKです。

Commit Message Editor の良いところ

コミットメッセージ入力欄が広い

まずはこれにつきます。エディタ領域で入力できるため、当然横幅は十分に確保されますし、縦も10行分1あるので、広々としたエリアで入力できます。

固定幅フォントを使える

デフォルトではプロポーショナルフォントなのですが、設定2を変更することで等幅フォントでメッセージを入力できるようになります。

ルーラーが付く

設定で固定幅フォントにすると、コミットメッセージの1行の長さの目安となるルーラーが付きます。上で記載した画像でも2本縦線が入っているのが確認できると思います。
この2つのルーラーは、1行目の要約行の目安とされる50桁と、3行目以降のコミットメッセージ本文の目安とされる72桁に設置されているので、適切な1行の長さのコミットメッセージを作成しやすくなります。

コミットメッセージのテンプレートが使える

コミットメッセージのテンプレートを設定することができ、「Load template」を押すと下画像のようにコミットメッセージのテンプレートが挿入されます。(画像の物はデフォルトで設定されているテンプレート。)

image.png

プロジェクトでコミットメッセージの体裁が決められている場合等、便利だと思います。

  1. 設定(commit-message-editor.view.visibleLines)で変更可能。

  2. commit-message-editor.view.useMonospaceEditor

15
4
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
15
4

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?