はじめに
私は普段、Visual Studio Code（以下VSCode）エディタを用いて開発を行っていますが、
ターミナルでgit commit実行時にエラーが発生しVSCodeエディタが立ち上がらず困りました。
そこでVSCodeを用いてコミットメッセージが入力出来るように設定手順を解説します。
前提として、Gitはローカル環境にインストールした状態で読み進めてください。
環境
- MacBookPro
- VSCodeバージョン：1.74.0
解決方法
GitのエディタにVSCodeを設定する
まず、VSCodeをGitのエディタとして設定します。
以下のコマンドをターミナルで実行します。
$ git config --global core.editor "code --wait"
では、GitのエディタとしてVSCodeが設定されたか確認してみましょう。
以下のコマンドをターミナルで実行します。
$ git config core.editor
以下のように表示されていればOKです。
code --wait
これで無事設定が出来た！と思いきや、
git commitとコマンドを打つと以下のようなエラーが表示されてしまうんですね。。。
hint: Waiting for your editor to close the file... code --wait: code: command not found
error: There was a problem with the editor 'code --wait'.
Please supply the message using either -m or -F option.
上記の解決方法について、次で解説します。
VSCodeの設定
まず、VSCodeを起動します。
起動できたら「コマンドパレット(⇧⌘P)」(or「表示」>「コマンドパレット」)の入力欄に「shell command」と入力し、
下図のような選択肢が出てきたら「シェルコマンド:PATH内に'code'コマンドをインストールします」を選択しインストールを実行します。
続いて、以下のコマンドをターミナルで実行し、表示されたパスをコピーします。
$ which git
VSCodeで「⚙」>「①設定(⌘,)」をクリック、「②git path」と検索、「③settings.jsonで編集」をクリックします。
編集画面にて以下のコードを追加します。
パス部分に先ほどターミナルでコピーしたご自身のパスをペーストし、保存してしてください。
"git.path": "/usr/bin/git"
以上で全ての作業が完了です。
お疲れ様でした。
まとめ
git commitしてもVSCodeが開かない時は、以下のコマンドで現在設定しているエディタを一度確認してみましょう。
$ git config core.editor
Git 公式ドキュメント:
あとがき
最後までご覧いただきありがとうございました！
初めての作業ってすごく緊張しますよね。
ましてやそこでエラーが発生したりした時には、オロオロしてしまったり。。。
そんな時こそ焦らずに調べながら、少しずつ作業を進める余裕を持ちたいですね。
この記事が少しでも皆様のお役に立てれば幸いです。