Gitのデフォルト・エディタにVSCodeを指定

目次

Git で使用するエディタは、設定ファイルのcore.editorで指定する。ただし VSCode は、コマンドラインから起動すると background になるため、foreground で実行するように--waitオプションを加える必要がある。


目的

Git の commit や interactive rebase で使用するエディターを Visual Studio Code (VSCode)にする。

コマンドラインで Git を使っていてエディタが必要になった場合は、環境変数EDITORで指定されたエディタが起動します。また、環境変数EDITORが指定されていない場合は、nanoが起動されます1

そこで VSCode を使うようにしたいのですが、codeを実行するとバックグラウンドで起動されプロンプトがすぐ帰ってきてしまいます。そのため、このままでは Git のエディタとして使用することができません。

方法

codeには、foreground で実行する--waitオプションがあります。このオプションを付けてcodeを実行するれば Git のエディタとして VSCode を使用できます。

具体的には、次のコマンドを実行してエディタの指定を設定ファイルに加えます。

git config --global core.editor 'code --wait'
# current project onyl
# git config core.editor 'code --wait'

--globalオプションを指定した場合には、~/.gitconfigにエディタの指定が加えられます。このオプションがない場合は、プロジェクトごとの設定ファイルである.git/configに指定が加えられます。

参考サイト


  1. nanoが使われるのは、Ubuntu だけかもしれません。 ↩︎