初探丰富的代码导航体验

2018 年 12 月 4 日 Jonathan Carter, @lostintangent

Pull Request（PR）是数百万开发者每天使用的重要协作工具，它促进了异步代码审查以及团队和开源社区之间的知识传播。由于其广泛的实用性和采用率，PR 审查工作流程的任何改进都可能对开发者生产力、产品质量和发布速度产生重大影响。

在九月份，我们与 GitHub 一起宣布了 GitHub Pull Requests 扩展，该扩展使开发者能够在编写代码的同一位置（即在他们熟悉且高度自定义的编辑器内）审查源代码。今天，我们很高兴分享一项新体验的先睹为快，该体验将通过支持丰富的多仓库代码导航进一步增强编辑器内的 PR 审查。

告别肤浅的评审

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

我们正在构建的丰富的代码导航体验，可帮助开发者在其开发环境中（通过 Visual Studio 和 Visual Studio Code 扩展）跟踪他们感兴趣的 Pull Request，并随时开始无缝导航远程托管的 PR 中的更改，而无需在本地检出这些主题分支。具体来说，它使用户从GitHub Pull Requests视图中打开的文件，能够获得与其他编辑器体验相同的代码导航功能（例如，悬停信息、转到定义、查找所有引用），但在这种情况下，完全由云驱动。我们相信，这可以提高团队的生产力，并使肤浅的审查成为过去。

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

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

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

导航所有内容

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

此外，如果您正在审查的 PR 使用了外部仓库中的依赖项，或者包含外部仓库代码使用的 API，您也可以直接导航到这些源！这样，无论您的应用程序在版本控制中如何组织，您都可以完整且更重要的是快速地评估更改的影响。我们认为这是一个极其强大的功能，尤其是在越来越多的团队正在构建多仓库应用程序/微服务并严重依赖 OSS 的情况下。

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

以社区为中心的设计

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

作为构建此服务的一部分，我们已经开始为各种语言（TypeScript、Java、C++ 和 C#）实施 LSIF 支持，并且我们对目前的结果感到非常兴奋。但是，为了使这项工作取得成功，至关重要的是我们在标准以及其他语言实现方面与社区合作。要了解有关 LSIF 的更多信息，并为推动这项对话做出贡献，请查看LSIF 规范草案。

我们需要您的反馈！

我们很高兴分享丰富的代码导航体验的首次亮相！在它成为您可以试用的功能之前，我们还有很多工作要做，但我们想就我们正在做的事情与社区展开公开对话。如果您有兴趣与我们的团队交流并参与潜在的预览，您可以在此处注册。我们期待在不久的将来分享更多更新！

祝您审查愉快！

Jonathan, @lostintangent