VSCode 中的多行 git 提交消息

Multiline git commit message in VSCode

当使用 VSCode 的 Git 集成提交文件时,有什么方法可以编写多行提交消息,还是我只能写一行?

截至目前,VSCode 非常擅长暂存文件。但似乎我仍然需要从终端编写大部分提交消息。

在 0.5.0 版本中,我们现在支持多行提交消息。只需按 Enter 键即可添加新行。

虽然 绝对可行,但您真的想在侧边栏内置的基本文本框中编写重要的提交消息吗?我宁愿在 VS 代码选项卡中编写我的提交消息,以释放编辑器的全部功能。

设置

  1. 将 VS Code 的默认终端设置为 Git Bash(可选且仅在使用 Windows 时相关),方法是在 VS Code 设置中放置如下内容.实际上,如 所述,只需通过 GUI 即可。 (请注意,您可以从该终端执行 cmdpowershell,然后 bash 返回。)

    "terminal.integrated.profiles.windows": {
        "Git Bash": {
            "source": "Git Bash"
        }
    },
    "terminal.integrated.defaultProfile.windows": "Git Bash",
    
  2. 将 Git 的默认编辑器设置为 VS Code,方法是在 Git 安装期间选择 VS Code 作为默认编辑器,或者将如下内容放入全局.git 配置文件。有关详细信息,请参阅

    [core]
        editor = 'C:\Users\your user dir\AppData\Local\Programs\Microsoft VS Code\Code.exe' --wait
    
  3. 通过 Rewrap, Code Spell Checker, MetaGo 等扩展,结合可执行文件文件夹中的 settings.json 文件中的特定语言设置,设置 VS Code 以获得更愉快的提交体验, 例如:

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

用法

  1. 如果 VS Code 终端尚不可见,请按 ctrl+` 将其调出。

  2. 用它来执行git commit -a或其他什么。

  3. VS Code 中将出现一个新选项卡,您可以在其中输入提交消息。

  4. 完成后,保存并关闭该选项卡以完成提交,或关闭选项卡而不保存以中止它。您可以再次点击 ctrl+` 来隐藏终端。

动作镜头

关于将 Rewrap 与多个标尺一起使用:

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.

有关详细信息,请参阅 the documentation

对于方便的多行提交消息编辑器,安装名为“adam-bender.commit-message-editor”的扩展。

如果您使用命令面板并提示 Git 提交,则无法编写多行提交消息,所以是的,如果您的提交消息相当长,请使用终端:外部终端或集成终端进入 vscode.

您可以配置 git 以使用任何编辑器。例如,如果你喜欢使用 VSC 编辑器来处理长提交消息,你可以 运行 在终端中输入以下命令:

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

然后在不带“-m”的情况下提交它

它将在 VS 代码上打开一个提交编辑选项卡,您可以在其中键入您的长提交消息。当您关闭该选项卡时,您的提交消息将被添加

注意:您可能需要 运行 Control + shift + P 打开命令面板并安装代码

Git 给其他编辑的说明: https://git-scm.com/book/en/v2/Appendix-C%3A-Git-Commands-Setup-and-Config