现已可用!阅读有关 11 月份的新功能和修复的信息。

远程仓库

2021 年 6 月 10 日,Brigit Murtaugh,@BrigitMurtaugh,Eric Amodio,@eamodio

注意:自此博客文章发布以来,“远程仓库”扩展已更名为 GitHub 仓库。您还可以查看最新文档,其中包含有关该扩展的最新信息。

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

Remote Repositories extension

一种更快捷地打开源代码仓库的方法

在 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 左下角的远程指示器(以及您已安装的任何其他远程开发扩展的命令)立即访问其 打开远程仓库 命令

Remote indicator in VS Code

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

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

Gif of using Open Remote Repository command, search for "microsoft/vscode," repo loads, open readme

您可以在无需离开 VS Code 的情况下浏览并为仓库做出贡献。您感觉就像在本地代码上工作一样,使用熟悉的 VS Code 界面,并且可以使用诸如 VS Code 资源管理器、搜索、时间线视图、快速打开以及当然的源代码管理等功能。

您现在已连接到所谓的虚拟工作区(有关虚拟工作区的更多信息请参见下方);远程指示器显示“GitHub”。当您将鼠标悬停在远程指示器上时,系统会通知您在虚拟工作区中某些功能不可用

Hover over remote indicator for limited virtual workspace message

虚拟工作区是一种特殊的设置,某些功能(如扩展)会被禁用或功能有限。您可以轻松地通过单击悬停在远程指示器上时显示的 某些功能 链接来找出哪些扩展被禁用。

单击该链接会显示哪些扩展被禁用以及哪些扩展的功能有限。当鼠标悬停在扩展上时,可以看到有限的功能。

VS Code Extensions view with limited and disabled extensions

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

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

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

您打开了一个仓库,接下来呢?

打开您的仓库后,远程仓库使您可以轻松地为您的项目做出贡献。

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

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

每次打开新仓库时,您都会打开最新版本。并且每当远程仓库检测到 GitHub 有新的更改时,它将在状态栏中列出您需要拉取多少提交

VS Code Status bar showing "GitHub" in remote indicator and 1 pending change

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

VS Code Explorer listing files and README has 1 change

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

创建或检出拉取请求

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

您可以更改代码,基于该更改创建新分支和拉取请求 (PR),然后检出 PR,所有操作只需点击几下即可完成。

Gif using GitHub Pull Request extension to create branch and PR, and check out that PR

您可以在我们的使用 GitHub文章中了解有关 GitHub 拉取请求和问题扩展的更多信息。

将更改隔离到分支

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

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

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

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

VS Code Status bar on Main branch

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

VS Code Command Palette with options to create new branch

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

Remote Repositories prompt to switch to new branch

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

限制

在使用远程仓库时存在某些限制

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

我们才刚刚开始这段旅程,因此随着我们继续开发,功能集将会增加,限制将会减少,敬请期待。

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

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

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

为了转移到更高级的工作流程,远程存储库提供了一种“升级”您环境的方法,并在您当前所在的位置继续您的工作。

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

VS Code Command Palette with "Continue Working on..." command

您将看到三个选项

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

VS Code Command Palette with options to continue locally, in a volume, or in 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