55

When commiting files using VSCode's Git integration, is there any way of writing a multiline commit message, or am I limited to a single line only?

As of now, VSCode is great at staging files. But it seems I'll still have to write most of my commit messages from the terminal.

Adelost
  • 1,693
  • 2
  • 16
  • 26
  • I raised https://github.com/microsoft/vscode/issues/85721 to make it official, comment/vote for it there. – sorin Nov 27 '19 at 19:24

3 Answers3

45

With the 0.5.0 release we now support multi line commit messages. Just hit the Enter key to add new lines.

enter image description here

Benjamin Pasero
  • 85,636
  • 11
  • 70
  • 52
  • 7
    Is there a way to indicate if the main body is passing 72 characters or to have the message automatically wrapped so messages can follow the 50/72 rule? – Gerry Shaw Oct 29 '16 at 17:50
  • 3
    It seems multi-line commit messages aren't supported anymore in newer releases (e.g., 1.19). – Marc Jan 18 '18 at 02:15
  • Still works for me with GIT. Pressing Enter adds a newline. – Benjamin Pasero Jan 18 '18 at 06:15
  • 10
    This doesn't work for me. It says it right below the input field `Press 'Enter' to confirm, 'Escape' to cancel`. I was hoping for something like Shift-Enter or Alt-Enter to add new lines. – Vince Oct 10 '18 at 00:28
  • 5
    @Vince Look again at the picture. That's the textbox built into the sidebar (visible when the source control tab is showing). I believe you are talking about the textbox that appears temporarily when you run a commit from the command palette. – MarredCheese Jan 11 '19 at 01:27
  • This works on version 1.42.0 on Ubuntu. It also gives you a warning about the 50 character limit on the first line, and the 72 character limit on the other lines. – Greeso Feb 12 '20 at 18:04
34

While Benjamin Pasero's answer is definitely viable, do you really want to compose non-trivial commit messages within that bare-bones textbox built into the sidebar? I would rather write my commit messages within a VS Code tab instead, unlocking the editor's full power.

Setup

  1. Set VS Code's default terminal to Git Bash (optional and only relevant if using Windows) by putting something like the following in your VS Code settings. Actually, just do it via the GUI instead, as stated in this answer. (Note that you can execute cmd or powershell from that terminal and bash to get back.)

    "terminal.integrated.shell.windows": 
    "C:\\ProgramFiles\\Git\\bin\\bash.exe"

  2. Set Git's default editor to VS Code, either by selecting VS Code as the default editor during Git installation or by putting something like the following in your global .gitconfig file. See this question for more detail.

    [core]
    editor = 'C:\\Users\\your user dir\\AppData\\Local\\Programs\\Microsoft VS Code\\Code.exe' --wait

  3. Set VS Code up for a more enjoyable commit experience via extensions like Rewrap, Code Spell Checker, MetaGo, etc., as well as language-specific settings like:

    "[git-commit]": {
    "editor.rulers": [72, 50],
    "editor.wordWrap": "off"
}

Usage

  1. If the VS Code terminal isn't already visible, hit ctrl+` to bring it up.

  2. Use it to execute git commit -a or whatever.

  3. A new tab will appear in VS Code, where you can type in your commit message.

  4. When you are done, save and close that tab to complete the commit, or close the tab without saving to abort it. You can hit ctrl+` again to hide the terminal.

Action Shot

vs code commit

Regarding using Rewrap with multiple rulers:

Just press Alt+q multiple times to wrap to each ruler in turn. The ruler chosen is then remembered for that document for the rest of the session. It cycles through the rulers in the order in which they appear in settings; so if you have a most commonly used ruler, you probably want to put that first.

See the documentation for more detail.

MarredCheese
  • 9,495
  • 5
  • 59
  • 63
  • 1
    I am surprised the vscode team did not made this happen yet. This is why I raised https://github.com/microsoft/vscode/issues/85721 and please comment there if you want to become a reality. – sorin Nov 27 '19 at 19:23
2

For a convenient multiline commit message editor, install an extension called "adam-bender.commit-message-editor".

drjumper
  • 81
  • 3