在 VS Code 中使用 Git 源代码控制
Visual Studio Code 集成了源代码控制管理 (SCM),并开箱即用地包含 Git 支持。许多其他源代码控制提供程序可通过 Visual Studio Marketplace 上的扩展获得。
借助 VS Code 中的 GitHub Copilot,你可以获得提交消息、拉取请求的建议,并在提交代码更改之前进行评审。了解更多关于 VS Code 中的 GitHub Copilot 的信息。
如果你还没有 Copilot 订阅,可以通过注册 Copilot 免费计划 免费使用 Copilot。你将获得每月有限的补全和聊天交互次数。
在 Git 仓库中工作
VS Code 在你打开 Git 仓库的文件夹时会识别出来。源代码控制视图使你无需使用命令行即可执行大多数 Git 操作。
确保你的机器上安装了 Git。VS Code 使用你机器上安装的 Git(至少版本 2.0.0
),因此你需要先 安装 Git,然后才能获得这些功能。
你可以通过选择活动栏中的源代码控制图标或使用键盘快捷方式 ⌃⇧G (Windows、Linux Ctrl+Shift+G) 来访问源代码控制视图。如果你有更改,源代码控制图标会指示你的仓库中当前有多少更改。
源代码控制视图显示当前仓库更改的详细信息:CHANGES(更改)、STAGED CHANGES(暂存更改)和 MERGE CHANGES(合并更改)。你还可以查看源代码控制图,了解你的更改与仓库历史的关系。
当你在源代码控制视图中选择一个文件时,你将在差异编辑器中看到你对该文件所做的更改。
对于未暂存的更改,右侧的编辑器仍然允许你编辑文件:随意使用它!
你还可以在 VS Code 状态栏的左下角找到仓库状态的指示器:当前分支、脏文件指示器以及当前分支传入和传出提交的数量。要切换到仓库中的任何分支,请选择状态指示器,然后从列表中选择 Git 引用。
你可以在 Git 仓库的子目录中打开 VS Code。VS Code 的 Git 服务将像往常一样工作,显示仓库中的所有更改,但范围目录之外的文件更改会以阴影显示,并带有工具提示,表明它们位于当前工作区之外。
克隆仓库
如果你尚未打开文件夹,源代码控制视图将为你提供选项,从本地计算机打开文件夹或克隆仓库。
如果你选择克隆仓库,系统会要求你输入远程仓库的 URL(例如在 GitHub 上)以及存放本地仓库的父目录。
对于 GitHub 仓库,你会在 GitHub 代码对话框中找到 URL。
然后,你会将该 URL 粘贴到Git:克隆提示中。
你还会看到选项从 GitHub 克隆。在 VS Code 中使用你的 GitHub 账户进行身份验证后,你将能够按名称搜索仓库,并选择任何仓库进行克隆。你还可以通过命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中的 Git: Clone 命令开始克隆 Git 仓库的流程。要查看分步说明,请查看我们的从 VS Code 克隆仓库视频。
如果你想在不将内容克隆到本地机器的情况下处理仓库,可以安装 GitHub Repositories 扩展,直接在 GitHub 上浏览和编辑。你可以在GitHub Repositories 扩展部分了解更多信息。
初始化仓库
如果你的工作区在本地机器上,你可以通过使用初始化仓库命令创建 Git 仓库来启用 Git 源代码控制。当 VS Code 未检测到现有 Git 仓库时,源代码控制视图会为你提供选项,初始化仓库或发布到 GitHub。
你还可以通过命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 运行 Git: Initialize Repository 和 Publish to GitHub 命令。
- 初始化仓库:创建必要的 Git 仓库元数据文件,并将你的工作区文件显示为未跟踪的更改,准备好进行暂存。
- 发布到 GitHub:直接将你的工作区文件夹发布到 GitHub 仓库,允许你在私有和公共仓库之间进行选择。查看我们的发布仓库视频,了解更多关于发布到 GitHub 的信息。
提交
可以通过文件中的上下文操作或拖放操作来进行暂存 (git add
) 和取消暂存 (git reset
)。
配置你的 Git 用户名和电子邮件。提交时,请注意,如果你的 Git 配置中未设置用户名和/或电子邮件,Git 将回退使用你本地机器上的信息。你可以在Git 提交信息中找到详细信息。
你可以在更改上方键入提交消息,然后按 Ctrl+Enter (macOS: ⌘+Enter) 来提交。如果有任何已暂存的更改,则只提交这些更改。否则,系统会提示你选择要提交哪些更改,并可以选择更改提交设置。
我们发现这是一种很棒的工作流程。例如,在前面的截图中,提交中只包含对 overview.png
的已暂存更改。稍后的暂存和提交操作可以将对 versioncontrol.md
和另外两个 .png
图像的更改作为单独的提交包含进去。
更具体的提交操作可以在源代码控制视图顶部的视图和更多操作 ...
菜单中找到。
如果你将更改提交到了错误的分支,可以使用命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中的 Git: Undo Last Commit 命令来撤消提交。
使用 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: Toggle Git Blame Editor Decoration 和 Git: Toggle Git Blame Status Bar Item 命令,或配置以下设置
你可以使用 git.blame.editorDecoration.template 和 git.blame.statusBarItem.template 设置自定义在编辑器和状态栏中显示的消息格式。你可以使用变量来表示最常见的信息。
例如,以下模板显示提交的主题、作者姓名和相对于当前的作者日期
{
"git.blame.editorDecoration.template": "${subject}, ${authorName} (${authorDateAgo})"
}
要调整编辑器装饰的颜色,请使用 git.blame.editorDecorationForeground
主题颜色。
使用 AI 评审未提交的代码更改
使用 AI 评审未提交的代码更改
-
VS Code 中的 GitHub Copilot 可以帮助你评审未提交的代码更改。
-
在源代码控制视图中,选择 Copilot Code Review 按钮以启动对未提交更改的代码评审
Copilot 在编辑器中以叠加层的方式生成代码评审评论和建议
-
你还可以在评论面板中查看所有代码评审评论的列表。
你可以使用相应的按钮或评论面板中的上下文菜单操作来应用或放弃建议
分支和标记
在 GitHub 文档中获取有关使用 Copilot 评审代码更改的更多详细信息。
你可以通过命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 中的 Git: Create Branch 和 Git: Checkout to 命令直接在 VS Code 中创建和切换分支。
如果你运行 Git: Checkout to,你将看到一个下拉列表,其中包含当前仓库中的所有分支或标记。它还会为你提供创建新分支的选项,如果你认为这是更好的选择,或者以分离模式切换到分支。
Git: Create Branch 命令可以让你快速创建一个新分支。只需提供新分支的名称,VS Code 就会创建分支并切换到该分支。如果你选择从...创建新分支,你将获得额外的提示,允许你指定新分支应该指向哪个提交。
远程仓库
VS Code 可以在你切换到其他分支时自动保存和恢复打开的编辑器。使用 scm.workingSets.enabled 设置启用此功能。要控制首次切换到分支时打开的编辑器,可以使用 scm.workingSets.default 设置。
鉴于你的仓库已连接到某个远程仓库,并且你当前所在的分支与该远程仓库中的一个分支具有上游链接,VS Code 为你提供了有用的操作来推送 (push)、拉取 (pull) 和同步 (sync) 该分支(后者将先运行拉取命令,后运行推送命令)。你可以在视图和更多操作 ...
菜单中找到这些操作,以及添加或删除远程仓库的选项。
VS Code 可以定期从远程仓库获取更改。这使得 VS Code 可以显示你的本地仓库领先或落后于远程仓库的更改数量。此功能默认禁用,你可以使用 git.autofetch 设置来启用它。
源代码控制图
你应该设置一个凭据助手,以避免每次 VS Code 与你的 Git 远程仓库通信时都要求输入凭据。如果你不这样做,你可能需要考虑通过 git.autofetch 设置禁用自动获取,以减少收到的提示次数。
配置远程仓库后,可以看到领先或落后于远程仓库的提交数量。源代码控制视图中的图视图以图形方式显示传入和传出的提交。
该图包含当前分支、当前分支的上游分支以及一个可选的基础分支。图的根是这些分支的共同祖先。
- 该图提供以下功能
- 选择一个条目即可查看该提交中更改的文件。选择打开更改操作可在编辑器中查看提交的差异。
- 右键单击提交可执行检出、cherry-pick 等操作。使用 Copilot 操作可总结提交或将其作为上下文附加到聊天提示中。
选择文件可在编辑器中查看该文件的差异。
Git 状态栏操作
使用图视图工具栏中的操作可选择分支、获取、拉取、推送和同步更改。
如果当前所在的分支配置了上游分支,状态栏中分支指示器旁边会有一个同步更改操作。同步更改会将远程更改拉取到本地仓库,然后将本地提交推送到上游分支。
如果未配置上游分支且 Git 仓库设置了远程仓库,则发布操作已启用。这将允许你将当前分支发布到远程仓库。
边沟指示器
如果你的工作区包含多个 Git 仓库,状态栏将显示当前仓库。选择状态栏项时,可以选择哪个仓库应为活动仓库的行为。
- 如果你打开 Git 仓库的文件夹并开始进行更改,VS Code 会在边沟和概览标尺中添加有用的注释。
- 红色三角形表示删除的行
- 绿色条表示新增的行
合并冲突
蓝色条表示修改的行
三向合并编辑器
VS Code 可以识别合并冲突。差异会突出显示,并且有内联操作可以接受其中一个或两个更改。冲突解决后,暂存冲突文件,以便可以提交这些更改。
为了帮助你解决合并冲突,VS Code 提供了一个三向合并编辑器,你可以在其中交互式地接受传入和当前更改,并查看和编辑合并后的结果文件。通过选择具有 Git 合并冲突的文件右下角的在合并编辑器中解决按钮,可以打开三向合并编辑器。
三向合并编辑器显示传入更改(左侧)、当前更改(右侧)和合并结果(底部)的单独视图。冲突会突出显示,可以通过使用 CodeLens 按钮来解决。
解决冲突
三向合并编辑器允许你通过接受其中一个或两个更改来解决冲突。你也可以手动编辑合并结果。
对于某些冲突,合并编辑器会显示一个接受组合按钮。接受组合通过智能合并两个更改来解决当前冲突。这对于在同一行但不触及相同字符的更改特别有用。
使用忽略按钮既不接受传入更改也不接受当前更改,但将冲突标记为已解决。这将冲突区域重置为在进行任何更改之前的状态。
完成合并
你可以使用结果编辑器右侧的冲突计数器来跟踪还剩下多少未解决的冲突。单击计数器会跳转到下一个未解决的冲突。所有冲突解决后,可以通过选择右下角的完成合并来完成合并。这将暂存文件并关闭合并编辑器。
备用布局等
选择合并编辑器右上角的三个点 (···) 会打开一个上下文菜单,其中包含其他选项。你可以切换到垂直布局并显示基础视图,该视图显示在进行任何更改之前的文件状态。
Incoming、Current 和 Result 旁边的三个点为每个视图提供了选项,例如显示与基础文件的并排差异、接受所有更改或重置结果。
了解冲突
查看差异
如果你想了解更多关于三向合并编辑器工作原理的详细信息,我们可以推荐以下视频
我们的 Git 工具支持在 VS Code 内查看差异。
差异编辑器中间有一个单独的边沟,你可以通过它暂存或恢复代码块更改。如果选择一段文本,可以恢复或暂存所选内容中包含的更改。
你可以通过首先在文件资源管理器视图中右键单击文件并选择选择以进行比较,然后右键单击要比较的第二个文件并选择与已选择的内容比较来比较任意两个文件。或者,打开命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)),然后选择任意文件:比较命令。了解更多关于在 VS Code 中比较文件的不同选项。
辅助功能差异查看器
差异编辑器中有一个辅助功能差异查看器,它以统一的补丁格式呈现更改。你可以使用转到下一个差异 (F7) 和转到上一个差异 (⇧F7 (Windows、Linux Shift+F7)) 在更改之间导航。可以使用箭头键导航行,按 Enter 将跳转回差异编辑器中的选定行。
时间轴视图
此体验对于屏幕阅读器用户尤其有用。
时间线视图默认位于文件资源管理器的底部,它是用于可视化文件的时间序列事件(例如 Git 提交)的统一视图。
VS Code 内置的 Git 支持提供指定文件的 Git 提交历史记录。选择提交将打开该提交引入的更改的差异视图。右键单击提交时,你将获得复制提交 ID 和复制提交消息的选项。
Visual Studio Code 通过 VS Code Marketplace 上提供的扩展支持更多的 Git 历史记录工作流程。
Git 输出窗口
单击扩展磁贴以阅读 Marketplace 中的描述和评论。
你可以随时查看我们使用的 Git 命令。如果发生奇怪的事情或你只是好奇,这很有帮助。:)
将 VS Code 用作 Git 编辑器
要打开 Git 输出窗口,运行视图 > 输出,然后从下拉列表中选择日志 (Git)。
从命令行启动 VS Code 时,可以传递 --wait
参数,使启动命令等待直到你关闭新的 VS Code 实例。当你将 VS Code 配置为 Git 外部编辑器时,这非常有用,这样 Git 将等待直到你关闭启动的 VS Code 实例。
- 以下是执行此操作的步骤
- 确保你可以从命令行运行
code --help
并获得帮助。- 如果你没有看到帮助,请按照以下步骤操作
- macOS:从命令面板中选择Shell Command: Install 'Code' command in path。
- Windows:确保你在安装过程中选择了添加到 PATH。
- 确保你可以从命令行运行
- Linux:确保你通过我们新的
.deb
或.rpm
包安装了 Code。
从命令行运行 git config --global core.editor "code --wait"
现在,你可以运行 git config --global -e
并使用 VS Code 作为编辑器来配置 Git。
VS Code 作为 Git 差异工具和合并工具
[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
即使从命令行使用 Git,你也可以使用 VS Code 的差异和合并功能。将以下内容添加到你的 Git 配置中,以使用 VS Code 作为差异和合并工具
这使用了可以传递给 VS Code 的 --diff
选项,以并排比较两个文件。合并工具将在 Git 下次发现合并冲突时使用。
- 总而言之,以下是你可以使用 VS Code 作为编辑器的一些示例
git rebase HEAD~3 -i
使用 VS Code 进行交互式 rebasegit commit
使用 VS Code 编写提交消息git add -p
后跟 e 进行交互式 add
使用 GitHub 拉取请求和问题
git difftool <commit>^ <commit>
使用 VS Code 作为更改的差异编辑器
SCM 提供程序
Visual Studio Code 通过 VS Code Marketplace 上提供的扩展支持更多的 Git 历史记录工作流程。
Visual Studio Code 还可以集成 GitHub 的拉取请求和问题。在 VS Code 中创建你的 PR,通过评论进行评审,并在不切换上下文的情况下批准它们。了解更多关于VS Code 中的 GitHub PR 和问题的信息。
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。