首次预览丰富的代码导航体验
2018年12月4日,Jonathan Carter,@lostintangent
拉取请求(Pull requests)是数百万开发者每天使用的关键协作工具,它促进了异步代码审查以及团队和开源社区之间的知识传播。由于其广泛的实用性和采用,PR 审查工作流程的任何进步都可能对开发人员的生产力、产品质量和发布速度产生重大影响。
9月,我们与 GitHub 共同发布了 GitHub Pull Requests 扩展,该扩展使开发人员能够在他们编写代码的同一地方(即他们熟悉且高度定制的编辑器中)审查源代码。今天,我们很高兴能分享一个新体验的预览,它将通过支持丰富的、多仓库代码导航,进一步增强编辑器内的 PR 审查。
告别敷衍的审查
要彻底审查一个拉取请求,你需要理解其更改的上下文以及它们如何影响更广泛的代码库。如今,许多开发人员在浏览器中进行“轻量级审查”,这提供了一个极其方便的工作流程,但很容易遗漏急需的上下文(例如,“此更改是否会破坏此 API 的任何消费者?”)。GitHub Pull Requests 扩展通过允许你利用开发环境的功能来构建和导航正在审查的源代码,从而改善了这种体验,但仍然需要你本地检出分支,并安装必要的平台 SDK 和语言扩展。为每个 PR 执行此操作可能需要大量时间和上下文切换,这让你面临在快速审查远程 PR 的便利性与在本地编辑器中审查它们的强大功能之间做出选择。我们认为开发人员应该两者兼得。
我们正在构建的丰富代码导航体验帮助开发人员在他们的开发环境中(通过Visual Studio 和Visual Studio Code 扩展)跟踪他们感兴趣的拉取请求,并且在任何时候,都可以无缝地导航远程托管 PR 中的更改,而无需在本地检出这些主题分支。具体来说,它通过与驱动其他编辑器体验(例如悬停信息、转到定义、查找所有引用)相同的代码导航功能来增强从GitHub Pull Requests视图打开的文件,但在这种情况下,它完全由云端提供支持。我们相信这可以提高团队的生产力,并使敷衍的审查成为历史。

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

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

在 macOS 上导航基于 Java 的 PR,甚至没有安装 Java 语言支持 (redhat.java) 扩展。
导航所有内容
通过此体验,您可以导航到正在审查的文件中、作为 PR 一部分更改的其他文件中以及同一仓库中任意文件中定义的符号(例如,类、函数、属性)。这样,您在整个代码库上下文中理解更改的能力就不会受到 PR 范围或本地环境的限制。
此外,如果正在审查的 PR 使用了外部仓库中的依赖项,或者包含了外部代码所使用的 API,您也可以直接导航到这些源!这样,您可以全面且更重要的是快速评估更改的影响,无论您的应用程序在版本控制中如何组织。我们相信这是一个极其强大的功能,特别是随着越来越多的团队正在构建多仓库应用程序/微服务并严重依赖 OSS。

从对 MobX observable 函数的外部引用直接导航到 GitHub 上的 MobX 仓库。
以社区为中心的设计
在幕后,此体验由语言服务器协议 (LSP) 的一项新增功能提供支持,LSP 已经是 Visual Studio 和 Visual Studio Code 等许多工具中语言支持的基础。这项名为语言服务器索引格式 (LSIF,发音类似于“else if”) 的提案提供了一种让语言服务器持久化其运行时智能的方式,以便随后可以大规模地用于回答 LSP 请求(例如,悬停和转到定义)。此外,LSIF 定义的数据模型能够通过源代码的丰富图表以及代码与外部仓库的关系来表示仓库。
作为构建此服务的一部分,我们已经开始为各种语言(TypeScript、Java、C++ 和 C#)实现 LSIF 支持,并且迄今为止我们对结果感到非常兴奋。然而,为了使这项工作取得成功,我们与社区就标准和额外的语言实现进行合作至关重要。要了解有关 LSIF 的更多信息,并为这项对话做出贡献,请查阅LSIF 规范草案。
我们需要您的反馈!
我们很高兴分享这一丰富代码导航体验的首次预览!在您能够试用它之前,我们还有很多工作要做,但我们希望就我们正在进行的工作与社区展开公开对话。如果您有兴趣与我们的团队交流并参与潜在的预览,您可以在此处注册。我们期待在不久的将来分享更多更新!
祝您审查愉快!
Jonathan,@lostintangent