在 VS Code 中使用 Git 源代码控制

Visual Studio Code 集成了源代码管理 (SCM)，并开箱即用地支持 Git。通过 Visual Studio Marketplace 上的扩展，还可以使用许多其他源代码控制提供程序。

借助 VS Code 中的 GitHub Copilot，你可以在提交代码更改之前获取提交消息、拉取请求和代码评审的建议。了解有关 VS Code 中的 GitHub Copilot 的更多信息。

在 Git 仓库中工作

VS Code 会在你打开 Git 仓库文件夹时识别出来。源代码管理视图使你无需使用命令行即可执行大多数 Git 操作。

你可以通过在活动栏中选择源代码管理图标或使用键盘快捷键 ⌃⇧G (Windows, Linux Ctrl+Shift+G) 来访问源代码管理视图。如果你有更改，源代码管理图标会指示你当前仓库中有多少更改。

源代码管理视图显示当前仓库更改的详细信息：更改、已暂存更改和合并更改。你还可以查看源代码管理图，以了解你的更改与仓库历史记录的关系。

当你在源代码管理视图中选择一个文件时，你将在差异编辑器中看到你对该文件所做的更改。

你还可以在 VS Code 状态栏的左下角找到仓库状态的指示器：当前分支、脏指示器以及当前分支的传入和传出提交的数量。要检出仓库中的任何分支，请选择状态指示器并从列表中选择 Git 引用。

克隆仓库

如果你尚未打开文件夹，源代码管理视图将为你提供从本地计算机打开文件夹或克隆仓库的选项。

如果你选择克隆仓库，系统会要求你提供远程仓库的 URL（例如在 GitHub 上）以及放置本地仓库的父目录。

对于 GitHub 仓库，你可以在 GitHub 的代码对话框中找到 URL。

然后将该 URL 粘贴到Git: 克隆提示符中。

你还会看到从 GitHub 克隆的选项。在 VS Code 中使用你的 GitHub 帐户进行身份验证后，你将能够按名称搜索仓库，并选择任何仓库进行克隆。你还可以通过命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中的Git: 克隆命令启动克隆 Git 仓库的流程。要查看分步演练，请查看我们的从 VS Code 克隆仓库视频。

初始化仓库

如果你的工作区在本地机器上，你可以通过使用初始化仓库命令创建 Git 仓库来启用 Git 源代码控制。当 VS Code 未检测到现有 Git 仓库时，源代码管理视图将为你提供初始化仓库或发布到 GitHub的选项。

你还可以从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 运行Git: 初始化仓库和发布到 GitHub命令。

• 初始化仓库：创建必要的 Git 仓库元数据文件，并将你的工作区文件显示为未跟踪的更改，随时可以暂存。
• 发布到 GitHub：直接将你的工作区文件夹发布到 GitHub 仓库，允许你在私有和公共仓库之间进行选择。查看我们的发布仓库视频，了解有关发布到 GitHub 的更多信息。

提交

暂存 (git add) 和取消暂存 (git reset) 可以通过文件中的上下文操作或拖放来完成。

你可以在更改上方键入提交消息，然后按 Ctrl+Enter (macOS: ⌘+Enter) 来提交它们。如果存在任何已暂存的更改，则只提交这些更改。否则，系统会提示你选择要提交的更改，并提供更改提交设置的选项。

我们发现这是一个很棒的工作流程。例如，在前面的屏幕截图中，只有对 overview.png 的暂存更改会包含在提交中。后续的暂存和提交操作可以包含对 versioncontrol.md 和另外两个 .png 图像的更改，作为单独的提交。

更具体的提交操作可以在源代码管理视图顶部的视图和更多操作 ... 菜单中找到。

使用 AI 生成提交消息

VS Code 中的 GitHub Copilot 可以根据你所做的代码更改为你生成提交消息。在源代码管理视图中，选择提交消息输入框中的使用 Copilot 生成提交消息按钮 ()。

如果你的组织或项目对提交消息有特定要求，你可以使用 Copilot 自定义指令来生成提交消息。例如，提交消息的最大长度为 60 个字符，并且应以现在时的动词开头。获取有关Copilot 自定义指令以生成提交消息的更多详细信息。

使用编辑器编写提交消息

如果你在提交更改时未输入提交消息，VS Code 将为 COMMIT_EDITMSG 文件打开一个编辑器，你可以在其中在编辑器中编写提交消息。提供提交消息后，关闭编辑器选项卡，或选择编辑器工具栏中的接受提交消息按钮以提交更改。

要取消提交操作，你可以清除文本编辑器的内容并关闭编辑器选项卡，或选择编辑器工具栏中的放弃提交消息按钮。

你可以通过切换 git.useEditorAsCommitInput 设置来禁用此功能。更改设置后，你需要重新启动 VS Code 才能使更改生效。

要在集成终端中执行的 git commit 命令使用相同的流程，请启用 git.terminalGitEditor 设置。

Git blame 信息

VS Code 可以在编辑器内联和状态栏中显示 git blame 信息。将鼠标悬停在状态栏项目或内联提示上以查看详细的 git blame 信息。

要启用或禁用 git blame 信息，请使用Git: 切换 Git Blame 编辑器装饰和Git: 切换 Git Blame 状态栏项命令，或配置这些设置

• git.blame.statusBarItem.enabled（默认启用）
• git.blame.editorDecoration.enabled

你可以使用 git.blame.editorDecoration.template 和 git.blame.statusBarItem.template 设置来自定义在编辑器和状态栏中显示的消息格式。你可以使用变量来获取最常见的信息。

例如，以下模板显示了提交的主题、作者姓名以及作者相对于现在的日期

{
  "git.blame.editorDecoration.template": "${subject}, ${authorName} (${authorDateAgo})"
}

要调整编辑器装饰的颜色，请使用 git.blame.editorDecorationForeground 主题颜色。

使用 AI 评审未提交的代码更改

VS Code 中的 GitHub Copilot 可以帮助你评审未提交的代码更改。

1. 在源代码管理视图中，选择代码评审按钮以开始评审未提交的更改

   

2. Copilot 在编辑器中生成代码评审注释和建议作为覆盖层

   

   你还可以在注释面板中查看所有代码评审注释的列表。

3. 你可以通过使用相应的按钮或注释面板中的上下文菜单操作来应用或放弃建议

在 GitHub 文档中获取有关使用 Copilot 评审代码更改的更多详细信息。

分支和标签

你可以通过命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中的Git: 创建分支和Git: 切换到命令直接在 VS Code 中创建和切换分支。

如果你运行Git: 切换到，你将看到一个包含当前仓库中所有分支或标签的下拉列表。如果你认为创建新分支是更好的选择，它还会为你提供创建新分支的选项，或以分离模式切换分支。

Git: 创建分支命令可让你快速创建新分支。只需提供新分支的名称，VS Code 将创建该分支并切换到它。如果你选择从...创建新分支，你将获得一个额外的提示，允许你指定新分支应指向哪个提交。

远程

鉴于你的仓库已连接到某个远程，并且你已检出的分支具有到该远程中某个分支的上游链接，VS Code 为你提供了有用的操作来推送、拉取和同步该分支（后者将运行拉取命令，然后运行推送命令）。你可以在视图和更多操作 ... 菜单中找到这些操作，以及添加或删除远程的选项。

VS Code 能够定期从你的远程获取更改。这使得 VS Code 能够显示你的本地仓库领先或落后远程的更改数量。此功能默认禁用，你可以使用 git.autofetch 设置 来启用它。

源代码管理图

当配置了远程仓库时，你可以看到你领先或落后远程的提交数量。源代码管理视图中的图视图以图形方式显示传入和传出提交。

该图包含当前分支、当前分支的上游分支以及可选的基分支。图的根是这些分支的共同祖先。

该图提供以下功能

• 选择一个条目以查看在该提交中更改的文件。选择打开更改操作以在编辑器中查看提交的差异。
• 右键单击一个提交以执行操作，例如检出、拣选、将其添加为聊天上下文等等。
• 选择一个文件以在编辑器中查看该文件的差异。

使用图视图工具栏中的操作选择分支、获取、拉取、推送和同步更改。

Git 状态栏操作

当当前检出的分支配置了上游分支时，状态栏中分支指示器旁边有一个同步更改操作。同步更改会将远程更改拉取到你的本地仓库，然后将本地提交推送到上游分支。

如果未配置上游分支且 Git 仓库已设置远程，则启用发布操作。这将允许你将当前分支发布到远程。

如果你的工作区包含多个 Git 仓库，状态栏将显示当前仓库。当你选择状态栏项时，你可以选择哪个仓库应该处于活动状态的行为。

装订线指示器

如果你打开一个 Git 仓库文件夹并开始进行更改，VS Code 将在装订线和概览尺中添加有用的注释。

• 红色三角形表示已删除的行
• 绿色条表示新添加的行
• 蓝色条表示修改的行

合并冲突

VS Code 会识别合并冲突。差异会突出显示，并有内联操作来接受其中一个或两个更改。解决冲突后，暂存冲突文件，以便你可以提交这些更改。

三向合并编辑器

为了帮助你解决合并冲突，VS Code 提供了一个三向合并编辑器，你可以在其中交互式地接受传入和当前更改，并查看和编辑生成的合并文件。三向合并编辑器通过选择 Git 合并冲突文件右下角的在合并编辑器中解决按钮打开。

三向合并编辑器显示传入更改（左侧）、当前更改（右侧）和合并结果（底部）的独立视图。冲突会突出显示，可以使用 CodeLens 按钮解决。

解决冲突

三向合并编辑器允许你通过接受其中一个或两个更改来解决冲突。你还可以手动编辑合并结果。

对于某些冲突，合并编辑器会显示一个接受组合按钮。接受组合通过智能合并两个更改来解决当前冲突。这对于在同一行但不触及相同字符的更改特别有用。

使用忽略按钮表示既不接受传入更改也不接受当前更改，但将冲突标记为已解决。这会将冲突区域重置为在进行任何更改之前的状态。

完成合并

你可以使用结果编辑器右侧的冲突计数器来跟踪剩余的未解决冲突数量。单击计数器会跳转到下一个未解决冲突。解决所有冲突后，你可以通过选择右下角的完成合并来完成合并。这会暂存文件并关闭合并编辑器。

替代布局及更多

选择合并编辑器右上角的三个点 (···) 会打开一个包含其他选项的上下文菜单。你可以切换到垂直布局并显示基本视图，该视图显示了在进行任何更改之前文件的状态。

传入、当前和结果旁边的三个点为每个视图提供选项，例如显示与基准的并排差异、接受所有更改或重置结果。

了解冲突

如果你想了解有关三向合并编辑器工作原理的更多详细信息，我们推荐以下视频

查看差异

我们的 Git 工具支持在 VS Code 中查看差异。

差异编辑器中间有一个独立的装订线，可让你暂存或还原代码块的更改。如果你选择一段文本，可以还原或暂存选择中包含的更改。

无障碍差异查看器

差异编辑器中有一个无障碍差异查看器，它以统一的补丁格式显示更改。你可以使用转到下一个差异 (F7) 和转到上一个差异 (⇧F7 (Windows, Linux Shift+F7)) 在更改之间导航。可以使用箭头键导航行，按 Enter 将跳回差异编辑器并跳到选定的行。

时间线视图

时间线视图默认位于文件资源管理器的底部，它是一个统一的视图，用于可视化文件的时序事件（例如，Git 提交）。

VS Code 内置的 Git 支持提供了指定文件的 Git 提交历史记录。选择一个提交将打开该提交引入的更改的差异视图。当你右键单击一个提交时，你将获得复制提交 ID和复制提交消息的选项。

Visual Studio Code 通过 VS Code Marketplace 上提供的扩展支持更多 Git 历史记录工作流程。

Git 输出窗口

你随时可以查看我们正在使用的 Git 命令。如果发生奇怪的事情或者你只是好奇，这会很有帮助。:)

要打开 Git 输出窗口，请运行视图 > 输出，然后从下拉列表中选择日志 (Git)。

VS Code 作为 Git 编辑器

当你从命令行启动 VS Code 时，你可以传递 --wait 参数，使启动命令等待直到你关闭新的 VS Code 实例。当将 VS Code 配置为 Git 外部编辑器时，这会很有用，这样 Git 将等待直到你关闭启动的 VS Code 实例。

以下是执行此操作的步骤

1. 确保你可以从命令行运行 code --help 并获得帮助。
   • 如果你没有看到帮助，请按照以下步骤操作
     • macOS：从命令面板中选择Shell 命令：在路径中安装“Code”命令。
     • Windows：确保你在安装过程中选择了添加到 PATH。
     • Linux：确保你通过我们的新 .deb 或 .rpm 包安装了 Code。
2. 从命令行运行 git config --global core.editor "code --wait"

现在你可以运行 git config --global -e 并使用 VS Code 作为编辑器来配置 Git。

VS Code 作为 Git difftool 和 mergetool

即使在使用命令行 Git 时，你也可以使用 VS Code 的差异和合并功能。将以下内容添加到你的 Git 配置中，以使用 VS Code 作为差异和合并工具

[diff]
    tool = default-difftool
[difftool "default-difftool"]
    cmd = code --wait --diff $LOCAL $REMOTE
[merge]
    tool = code
[mergetool "code"]
    cmd = code --wait --merge $REMOTE $LOCAL $BASE $MERGED

这使用了可以传递给 VS Code 的 --diff 选项来并排比较两个文件。合并工具将在 Git 发现合并冲突时下次使用。

总而言之，以下是一些你可以使用 VS Code 作为编辑器的示例

• git rebase HEAD~3 -i 使用 VS Code 进行交互式 rebase
• git commit 使用 VS Code 作为提交消息编辑器
• git add -p 后跟 e 进行交互式添加
• git difftool <commit>^ <commit> 使用 VS Code 作为更改的差异编辑器

使用 GitHub 拉取请求和问题

Visual Studio Code 还可以引入 GitHub 的拉取请求和问题。在 VS Code 中创建你的 PR，通过注释进行评审，并在不切换上下文的情况下批准它们。了解有关VS Code 中的 GitHub PR 和问题的更多信息。

SCM 提供程序

VS Code 支持同时处理多个源代码管理提供程序。例如，你可以打开多个 Git 仓库以及你的 Azure DevOps Server 本地工作区，并在你的项目之间无缝工作。要打开源代码管理提供程序视图，请选择源代码管理视图中的溢出菜单 (⌃⇧G (Windows, Linux Ctrl+Shift+G))，将鼠标悬停在视图上，并确保源代码管理仓库已勾选。源代码管理提供程序视图显示检测到的提供程序和仓库，你可以通过选择特定提供程序来限制更改的显示范围。

SCM 提供程序扩展

如果你想安装另一个 SCM 提供程序，你可以在扩展视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 中搜索scm providers扩展类别。开始键入“@ca”，你将看到调试器和 linter 等扩展类别的建议。选择 @category:"scm providers" 以查看可用的 SCM 提供程序。

后续步骤

• 介绍视频 - Git 版本控制 - 一个介绍性视频，概述了 VS Code Git 支持。

• GitHub 协作简介 - 了解如何在 VS Code 中使用 GitHub。

• 了解有关 Copilot VS Code 的更多信息 - 了解 VS Code 中的 Copilot。

• 源代码管理 API - 如果你想将另一个源代码管理提供程序集成到 VS Code 中，请参阅我们的源代码管理 API。