loading...
Cover image for Make VS Code Your Default Git Editor πŸ“

Make VS Code Your Default Git Editor πŸ“

deadlybyte profile image Carl Saunders ・2 min read

Recently I've found myself using the git command git commit --amend to change typos in my commit messages. By default the GNU nano text editor is used, which for me isn't a great experience and was starting to BUG me!

Default GNU nano editor for changing git message

GNU nano editor is used by default to change git commit message

I use VS Code daily and as I'm typing the git command in the built-in VS Code terminal, naturally I want to edit the commit message using the same editor. Well luckily you can configure this with a one liner.

Default VS Code As The Git Editor (Globally)

Type the following in the command prompt / bash shell.

git config --global core.editor "code --wait"

Or, alternatively if you don't like typing too much then use.

git config --global core.editor "code -w"

Note: The --wait or -w flag is crucial without this git won't know the editing has completed and in turn won't finish executing the git command.

See It Working!

Below is a gif showing VS Code as the default editor for git.

VS Code As The Default Git Editor

Working example of VS Code as the default git editor

Default VS Code As The Git Editor (Local Repo)

But wait there's more, if you don't want the change to happen globally you can set it locally for a git repository by using the flag --local.

git config --local core.editor "code -w"

Revert Back To GNU nano (or default)

And if you prefer GNU nano and want to reset this to the default git editor, then run the following command.

git config --global --unset core.editor

Note: If you set the editor locally and you want to reset then replace the --global flag with the --local flag instead.

Posted on by:

deadlybyte profile

Carl Saunders

@deadlybyte

I'm a full stack software developer specialising in React. With 20+ years’ experience, I'm passionate about following best practices and standards.

Discussion

markdown guide
 

Useful and clear article! πŸ‘

Although we can change the last commit message directly in one command (git commit --amend -m "New message"), configuring the git editor is useful for other commands like interactive rebase (git rebase -i).

Moreover I think the --local flag is the default value, so it's not necessary: git config core.editor "code -w".

 

Nice addition! I always use -m "Message". But for interacative rebase is a pain to use vim, always need to check a cheatsheet to use it!

Thanks for this article, will set Code as default editor

 

I just found out the flag --disable-extensions to, well, disable all extensions for this session. This would speed up the launch time of code.

 

Isn't Vim the default? I changed it to nano, BTW.

 

For me it was nano, idk, now I'm so used to editing it with nano I don't think I'll ever chabge it lol

 

If I was using VS Code as commit message editor, I would even feel like I'm writing a commit message.

 

Very cool. I never got the code command to work on my machine. I probably need to manually have it added to my profile or something.

I love this idea though. Nice write up.

 

Yup, you have to add it to your path.

You can do that from within VSCode, just search for 'shell' in the command palette and you'll see β€œShell Command: Install code in PATHβ€œ, simply do that and afterwards you may use code in your external shell.