丰富的代码导航体验初探

2018 年 12 月 4 日 Jonathan Carter, @lostintangent

拉取请求是数百万开发者每天使用的关键协作工具，它促进了异步代码审查以及团队和开源社区之间的知识传播。由于其广泛的实用性和普及性，PR 审查工作流程的任何改进都能显著影响开发人员的生产力、产品质量和发布速度。

九月，我们与 GitHub 共同发布了 GitHub Pull Requests 扩展，它让开发者可以在编写源代码的同一个地方——他们熟悉且高度定制的编辑器中——进行代码审查。今天，我们很高兴能分享一个新体验的预览，它将通过支持丰富的多存储库代码导航，进一步增强编辑器内的 PR 审查功能。

告别肤浅的审查

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

我们正在构建的丰富代码导航体验帮助开发者在他们的开发环境（通过 Visual Studio 和 Visual 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，你也可以直接导航到这些源！这样，你就可以充分地——更重要的是，快速地——评估一项更改的影响，无论你的应用程序在版本控制中如何组织。我们相信这是一项极其强大的功能，特别是随着越来越多的团队正在构建多存储库应用程序/微服务并严重依赖开源软件（OSS）。

Navigating into a Mobx repo

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

以社区为中心的设计

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

作为构建此服务的一部分，我们已开始为各种语言（TypeScript、Java、C++ 和 C#）实现 LSIF 支持，并且我们对迄今为止的结果感到非常兴奋。然而，为了使这项工作取得成功，我们必须就标准和额外的语言实现与社区合作。要了解更多关于 LSIF 的信息，并为未来的讨论做出贡献，请查阅LSIF 规范草案。

我们需要您的反馈！

我们很高兴分享这一丰富代码导航体验的初探！在它成为您可以尝试的功能之前，我们还有很多工作要做，但我们希望与社区就我们正在进行的工作展开开放对话。如果您有兴趣与我们的团队交流，并参与潜在的预览，您可以在此处注册。我们期待在不久的将来分享更多更新！

审查愉快！

Jonathan, @lostintangent