远程仓库

2021 年 6 月 10 日，作者：Brigit Murtaugh，@BrigitMurtaugh，Eric Amodio，@eamodio

注意：自这篇博客文章发布以来，“远程仓库”扩展已重命名为 GitHub 仓库。您还可以查看最新文档，其中将包含有关该扩展的最新信息。

我们很高兴推出适用于 Visual Studio Code 的全新 远程仓库 扩展！这是我们与 GitHub 的朋友合作构建的全新体验，旨在让您在 VS Code 中快速安全地处理源代码仓库。

打开源代码仓库的更快方法

在 VS Code 中，我们从一开始就提供了对 Git 的集成支持，并且我们通过扩展支持了许多其他源代码管理 (SCM) 提供程序。这使开发人员可以直接在 VS Code 中克隆和使用仓库。

但是，开发人员每天所做的大部分工作都涉及阅读他人的代码：审查拉取请求、浏览开源仓库、试验新技术或项目、检查上游依赖项以调试应用程序等等。所有这些的共同点是，作为第一步，您通常会先将仓库克隆到本地，然后在您最喜欢的代码编辑器（我们希望是 VS Code！）中打开代码。然而，克隆仓库需要时间，如果您忘记拉取，可能会导致您审查过时的仓库版本，并且如果您不熟悉代码，有时可能会存在安全风险。

由 GitHub 发布的全新 远程仓库 扩展，使在 VS Code 中打开源代码仓库的体验变得即时且安全。有了它，您可以直接从 VS Code 中快速浏览、搜索、编辑和提交到任何远程 GitHub 仓库（以及即将推出的 Azure Repos），无需克隆！

您可以处理任意数量的仓库，而无需在您的机器上保存任何源代码。“远程仓库”扩展可以节省您的时间和本地磁盘空间，并使您能够在 VS Code 中完成所有源代码管理任务。

在这篇博客文章中，我们将探讨如何轻松开始使用“远程仓库”扩展，打开您的第一个远程仓库后可以做什么，支持此虚拟环境的技术细节，以及您今天如何向我们提供反馈。

在 VS Code 中打开您的第一个远程仓库

让我们在 VS Code 中打开一个远程仓库。首先，请确保您已安装 远程仓库 扩展。

目前，“远程仓库”扩展支持 GitHub 仓库，对 Azure Repos 的支持即将推出。在这篇博客文章中，我们将首先打开 VS Code 仓库 (microsoft/vscode)。

安装“远程仓库”扩展后，通过单击 VS Code 左下角的远程指示器（以及您已安装的任何其他 远程开发扩展 的命令），我们可以立即访问其 打开远程仓库 命令

如果您之前没有从 VS Code 登录到 GitHub，系统会提示您验证您的 GitHub 帐户。登录后，搜索仓库或 PR，选择您想要的那个，您就可以开始了。

在下面的简短视频中，我们搜索并选择了 VS Code 仓库，VS Code 重新加载，仓库的内容加载，就像我们在本地克隆它一样

您可以在不离开 VS Code 的情况下浏览仓库并为其做出贡献。您感觉就像在处理本地代码，使用熟悉的 VS Code 界面，并且可以使用 VS Code 资源管理器、搜索、时间线视图、快速打开以及当然还有源代码管理等功能。

您现在已连接到所谓的虚拟工作区（有关虚拟工作区的更多信息，请参阅下方）；远程指示器显示“GitHub”。当您将鼠标悬停在远程指示器上时，您会收到通知，告知在虚拟工作区中某些功能不可用

虚拟工作区是一种特殊设置，某些功能（例如扩展）被禁用或功能受限。您可以通过单击鼠标悬停在远程指示器上时显示的 某些功能 链接，轻松找出哪些扩展被禁用。

单击该链接会显示哪些扩展被禁用以及哪些扩展的功能受到限制。当您将鼠标悬停在扩展上时，可以看到功能受限的情况。

如果您想在虚拟工作区中手动启用扩展，您可以使用用户 settings.json 文件中的 extensions.supportVirtualWorkspaces 设置。

    "extensions.supportVirtualWorkspaces": { "<extensionID>": true }

请记住，扩展可能没有实现为处理无法访问本地文件系统的虚拟工作区，因此扩展可能无法按预期工作。

您打开了一个仓库，接下来做什么？

打开您的仓库后，“远程仓库”扩展使您可以轻松地为您的项目做出贡献。

简化的 Git 工作流程，可让您的项目保持最新

“远程仓库”扩展可帮助您每次都保持仓库的最新版本，而无需任何复杂的 Git 命令。

每当您打开一个新的仓库时，您都会打开最新版本。每当“远程仓库”扩展检测到 GitHub 上有新的更改时，它都会在状态栏中列出您需要拉取的提交次数

并在资源管理器中突出显示修改后的文件

当您提交更改时，它们将自动显示在 GitHub 上 – 您无需推送您的更改或发布您创建的任何新分支。

创建或检出拉取请求

“远程仓库”扩展与 GitHub Pull Requests and Issues 扩展 配合良好，该扩展允许您直接在 VS Code 中审查和管理来自 GitHub 的拉取请求和问题。并行使用这两个扩展，可以快速检出 PR 并处理问题，而无需在本地克隆代码或离开 VS Code。

您可以更改您的代码，基于该更改创建一个新分支和一个拉取请求 (PR)，然后检出 PR，只需单击几下即可完成。

您可以在我们的 使用 GitHub 文章中了解有关 GitHub Pull Requests and Issues 扩展的更多信息。

将更改隔离到分支

在完成工作时，您可能需要在分支之间切换。在典型的环境中，当您需要决定要暂存或提交哪些更改时，这可能会变得棘手。

“远程仓库”扩展使您可以轻松地同时处理不同的分支。当您暂停在一个分支上的工作并切换到新分支时，系统不会询问您是否要暂存更改 - 它们将自动保留在之前的分支上。当您返回到之前的分支时，您的更改仍然在那里，您可以从上次中断的地方继续。

让我们探索如何将更改推送到分支。

在状态栏中，选择您当前的分支以打开分支列表，例如“main”

选择 + 创建新分支... 并键入您的分支名称

然后您可以切换到该新分支

新分支将不包含您先前分支的任何更改。

局限性

使用“远程仓库”扩展时存在某些限制

• 调试、终端和任务 - 当前不支持。终端在您的本地文件系统上打开，并且无法访问远程仓库的虚拟文件系统。
• 有限的语言智能 - 诸如 IntelliSense 和 转到定义 等功能可能会受到影响，因为许多语言尚不了解“远程仓库”扩展的虚拟化环境。
• 搜索 - GitHub 搜索本身存在局限性，例如不索引分支。“远程仓库”扩展可以避免此限制，并通过启用索引来执行全文搜索。索引从 GitHub 拉取仓库的浅克隆，并在本地执行完整搜索，从而提供比 GitHub 的模糊默认分支本机搜索更强大的功能。您可以从“搜索”视图中在“远程仓库”扩展中启用索引。
• 扩展限制 - 并非所有扩展都可以在虚拟工作区中运行，但随着时间的推移，将有更多扩展支持它。严重依赖于访问本地文件的扩展无法支持此设置。有关更多详细信息，请参阅下面的虚拟工作区部分 below。

我们才刚刚开始这段旅程，因此随着我们继续开发，预计功能集将不断增长，限制将不断缩小。

继续在更强大的环境中工作

使用“远程仓库”扩展，VS Code 在并非所有功能都可用的环境中运行，因为没有物理文件系统。这非常适合快速开始浏览仓库，但是当您准备好进行一些更“高级”的工作时，例如

• 您想要积极地处理仓库并获得 VS Code 的全部功能。
• 您需要通过定期从远程拉取来积极跟踪仓库的更改。

为了转移到更高级的工作流程，“远程仓库”扩展提供了一种方法，让您可以“升级”您的环境并在那里继续您的工作，从您当前所在的位置继续。

单击左下角的远程指示器，然后选择 继续在...上工作。

您将看到三个选项

• 本地克隆仓库：将当前仓库克隆到您的本地机器。将弹出一个本地文件资源管理器，允许您选择磁盘上的位置来克隆远程仓库。
• 在容器卷中克隆仓库：使用 Dev Containers 扩展在 Docker 容器卷 中克隆当前仓库（您需要安装 Dev Containers 扩展和 Docker）。VS Code 将重新加载并使用 Dev Containers 连接，远程指示器现在将显示 Dev Container: {镜像名称}。
• 在 Codespaces 中打开：在 GitHub Codespace 中继续您的工作。当您选择此选项时，浏览器将打开并引导您到此仓库的 Codespaces 列表。

现在我们已经探索了如何在 VS Code 中使用“远程仓库”扩展，我们想描述一些支持此体验的技术细节，以及如何确保您的扩展在“远程仓库”会话中工作。

虚拟文件系统和工作区

支持此远程工作的核心概念是虚拟文件系统和虚拟工作区。

作为最终用户，您只需要知道您想要处理哪个仓库或 PR – VS Code 将负责虚拟文件系统并为您管理您的工作区。作为扩展开发人员，您需要采用虚拟文件系统 API，以确保您的扩展按预期运行。

虚拟文件系统的工作原理

当您在传统 git 工作流程中工作时，您会“git clone”一个仓库，并将副本保存到您计算机的本地文件系统。但是，当使用“远程仓库”扩展时，代码并不位于您的本地计算机上；它仍然只在 GitHub 上。

您通过虚拟文件系统处理代码，虚拟文件系统是从物理磁盘上存在的文件中抽象出来的。虚拟文件系统可以从 GitHub 等代码托管服务、云存储或数据库中提供内容，并无缝地将这些内容作为文件提供给 VS Code 中的用户。

当您在虚拟文件系统上打开工作区时，它被称为虚拟工作区。在虚拟工作区中工作时，您仍然可以访问 VS Code 功能，包括扩展。

确保您的扩展在虚拟工作区中工作

为了使扩展正常运行，它们必须支持虚拟文件系统。

当扩展没有代码但只是纯粹的颜色主题、键绑定、代码片段或语法扩展时，它可以在虚拟工作区中运行，并且无需进行任何适配。

运行实际代码的扩展（意味着它定义了一个主入口点）需要检查并可能需要适配。

虚拟文件系统的 API 支持 通过 FileSystemProvider 接口实现。文件系统提供程序为新的 URI 方案（例如，vscode-vfs）注册，并且该文件系统上的资源将由使用该方案的 URI 表示 (vscode-vfs://github/microsoft/vscode/package.json)。

扩展的 package.json 中有一个 capabilities 属性，virtualWorkspaces 子属性用于指示扩展是否适用于虚拟工作区。

您可以在 虚拟工作区扩展作者指南 中了解有关虚拟文件系统、工作区以及如何为扩展实现它们的更多信息。

反馈 & 延伸阅读

我们很高兴您试用“远程仓库”扩展，并迫不及待地想收到您的反馈。

请安装 远程仓库 扩展。您可以提交任何 问题或功能请求，或在 Twitter 上发布您的想法 @code。

您还可以观看我们关于如何使用“远程仓库”扩展的全新 YouTube 视频。

如果您是扩展作者，请查看 虚拟工作区对扩展作者的支持指南，并在我们的 跟踪问题 中分享任何问题或反馈。您还可以加入扩展作者社区 Slack 群组。

祝您编码愉快！

Brigit Murtaugh，VS Code 项目经理 @BrigitMurtaugh
Eric Amodio，VS Code 首席软件工程师 @eamodio