知識の枝

"All is well"

VSCodeでGitコマンドを使えるようにする

約29日前 2021年10月29日0:49
デジタル
コマンド Git エディタ

改訂履歴


2021/10/29 投稿

1. ソースコード管理を始める準備


元々このブログを立ち上げる際にGitを利用してファイルの管理を行っていました。

ただ当時は何も分からないなりにググりながら進めたこともあったので、
言われるがまま(書いてあるまま)にコマンドを実行してファイルの更新やサーバーへのクローンを行っていました。


私の開発環境はWindows10で、既にGitもインストール済みという状態です。
これから説明する内容はWindows準拠で書かれておりますので、Macの方の参考にはならないかもしれません。


このたび新しくドメインを取得してウェブアプリを始めることになりましたので、
今回からはしっかりソースコード管理を行おうということで、
普段メインで使用しているエディタ Visual Studio Codeと Gitを連携させることにしました。


スムーズに連携ができればこのような記事は書かなくて済んだのですが、
そう上手く進まなかったのでメモ代わりに整理しておこうと思います。


2. git initが使えない


ローカルフォルダにある程度ソースコードが出来上がっていたので、
プロジェクトのルートディレクトリをGitのローカルリポジトリとして設定しようとしました。

設定は簡単で下記コマンドをVisual Studio Codeで実行するだけみたいです。
PS C:\Users\hoge\project> git init
赤い字でエラーが数行でました。

どうもパソコンにインストールしてあるGitとVisual Studio Codeの連携ができていないみたいです。


原因は「Gitをインストールする際にデフォルトのエディタとしてVisual Studio Codeを選択していなかった」

とのことです。


というわけで「Gitのデフォルトのエディタ設定を変更する必要がある」ということが分かりました。


3. Gitの設定変更は簡単そうで難しい


Gitコマンドが使える環境で設定を書き換える必要があります。

Gitをインストールした際に「Git CMD」というプログラムが入っていますので、
それを起動します。


ターミナルで下記コマンドを実行すると「現在のデフォルトエディタ設定」を確認可能です。
C:\Users\hoge>git config --global core.editor

何も設定されていなければ、下記コマンドでデフォルトエディタをVisual Studio Codeに設定可能です。
C:\Users\hoge>git config --global core.editor "code --wait"

Visual Studio Code以外が登録されている場合は、下記コマンドで書き換えられます。
C:\Users\hoge>git config --global core.editor "code --wait"  --replace-all


再度デフォルトエディタ設定を確認すると「code --wait」と表示されると思います。
C:\Users\hoge>git config --global core.editor
code --wait



設定が完了しましたので、下記コマンドでGit CMDからVisual Studio Codeを起動します。
C:\Users\hoge>git config --global -e
hint: Waiting for your editor to close the file...

少し待つとVisual Studio Codeが立ち上がります。


これで連携完了です。


4. 改めてgit initしてみる


先程はエラーが出ましたが、連携後は出ません。
PS C:\Users\hoge\project> git init
Initialized empty Git repository in C:/Users/hoge/project/.git/


無事ローカルリポジトリの設定が完了しました。

トラブルは当たり前なので、めげずにトラブルシューティングしていきましょう。


5. まだGitをインストールしていない人へ


インストールのときにVisual Studio Codeを選んどけば、こんなことをしなくて済みます。