在 VS Code 中试用

首次体验丰富的代码导航

2018年12月4日 Jonathan Carter, @lostintangent

拉取请求是数百万开发者日常使用的关键协作工具,它有助于异步代码审查以及团队和开源社区之间的知识共享。由于其广泛的实用性和普及性,PR 审查工作流程的任何改进都可能对开发者生产力、产品质量和发布速度产生重大影响。

今年九月,我们与 GitHub 合作,发布了 GitHub Pull Requests 扩展,使开发者能够在他们编写代码的同一位置(即他们熟悉且高度定制的编辑器中)审查源代码。今天,我们很高兴能分享一项新体验的抢先预览,该体验将通过支持丰富的、多仓库的代码导航来进一步增强编辑器内的 PR 审查。

告别肤浅的审查

要彻底审查拉取请求,您需要了解其更改的上下文以及它们如何影响更广泛的代码库。目前,许多开发者在浏览器中进行“轻量级审查”,这提供了一个极其方便的工作流程,但很容易遗漏许多必要的上下文(例如,“此更改会破坏 API 的任何使用者吗?”)。GitHub Pull Requests 扩展通过允许您利用开发环境的功能来构建和导航正在审查的源代码,从而改善了这种体验,但仍要求您在本地检出分支,并安装必要的平台 SDK 和语言扩展。为每个 PR 执行此操作可能需要大量时间和上下文切换,这让您在快速审查远程 PR 的便利性与在本地编辑器中审查它们的强大功能之间做出选择。我们认为开发者应该两者兼得

我们正在构建的丰富代码导航体验帮助开发者在他们的开发环境内(通过 Visual StudioVisual Studio Code 扩展)跟踪他们感兴趣的拉取请求,并随时开始无缝导航远程托管的 PR 中的更改,而无需在本地检出这些主题分支。具体来说,它增强了您从 GitHub Pull Requests 视图中打开的文件,使其具有与其他编辑器体验(例如悬停信息、转到定义、查找所有引用)相同的代码导航功能,但在此情况下,完全由云提供支持。我们相信这可以使团队更高效,并让肤浅的审查成为过去。

Navigating a csharp PR

在 macOS 上导航基于 C# 的 PR,甚至无需安装 C# 扩展或 .NET。

Navigating a C++ PR

在 macOS 上导航基于 C++ 的 PR,甚至无需安装 C++ 扩展。

Navigating a Java PR

在 macOS 上导航基于 Java 的 PR,甚至无需安装 Java 语言支持 (redhat.java) 扩展。

导航一切

通过这种体验,您可以导航到正在审查的文件中定义的符号(例如类、函数、属性),以及作为 PR 一部分更改的其他文件中的符号,以及同一仓库中任意文件中的符号。通过这种方式,您在整个代码库上下文中理解更改的能力不受 PR 范围或本地环境的限制。

此外,如果您正在审查的 PR 使用了外部仓库中的依赖项,或包含外部仓库中的代码所使用的 API,您也可以直接导航到这些源!通过这种方式,您可以完全——更重要的是,快速——评估更改的影响,无论您的应用程序在版本控制中如何组织。我们相信这是一项极其强大的功能,尤其是在越来越多的团队正在构建多仓库应用程序/微服务并严重依赖开源软件的情况下。

Navigating into a Mobx repo

从对 observable 函数的外部引用,直接导航到 GitHub 上的 MobX 仓库

以社区为中心的设计

在幕后,此体验由 语言服务器协议 (LSP) 的一项新增功能提供支持,LSP 已经是 Visual Studio 和 Visual Studio Code 等多种工具中语言支持的基础。这项名为语言服务器索引格式 (LSIF,发音类似于“else if”) 的提案,为语言服务器提供了一种持久化其运行时智能的方式,以便后续可以大规模地用于响应 LSP 请求(例如,悬停和转到定义)。此外,LSIF 定义的数据模型允许通过源代码的丰富图表以及代码与外部仓库的关系来表示仓库。

作为构建此服务的一部分,我们已开始为各种语言(TypeScriptJava、C++ 和 C#)实现 LSIF 支持,到目前为止,我们对结果感到非常兴奋。然而,为了使这项工作取得成功,我们与社区就标准以及额外的语言实现进行合作至关重要。要了解有关 LSIF 的更多信息,并参与到未来的讨论中,请查看LSIF 规范草案

我们需要您的反馈!

我们很高兴分享这一丰富代码导航体验的首次亮相!在您可以试用之前,我们还有很多工作要做,但我们希望与社区就我们正在进行的工作展开公开对话。如果您有兴趣与我们的团队交流,并参与潜在的预览,您可以在此处注册。我们期待在不久的将来分享更多更新!

审查愉快!

Jonathan, @lostintangent