Notebooks，Visual Studio Code 风格
2021 年 11 月 8 日，作者：Tanha Kabir, @_tanhakabir
Notebook 是包含丰富 Markdown、可执行代码片段和相应的丰富输出的文档。它们都分隔成不同的单元格，可以按任意顺序交错排列。
如果您不熟悉 Notebook，那您可能熟悉 REPL（read-eval-print loop）？REPL 是一种交互式应用程序，您可以在其中编写少量代码并立即执行代码并查看输出。Notebook 是 REPL 的缩影，可让您快速创建环境，以便迭代并处理小块代码。
Notebook 不仅是出色的 REPL，也是出色的叙事工具，可以将图像、数学公式和解释性文本等 Markdown 元素与代码交织在一起。Notebook 是与同事或公共社区分享和解释您的想法的完美方式。
当今最流行的 Notebook 形式是 Jupyter Notebook，它在数据科学社区中广泛使用，并提供丰富的 Python 支持。Jupyter Notebooks 还通过 Jupyter 内核支持 Julia 或 R 等其他语言，这些内核是遵循特定协议在 Notebook 中运行代码的可执行文件。Visual Studio Code 多年来一直支持 Jupyter Notebooks，但最近在 VS Code 核心中添加了原生 Notebook 支持。
VS Code 中的 Notebook 支持
没错，Notebook 现在是 VS Code 核心功能的一部分！这意味着现在 VS Code 中提供了 Notebook API，以便扩展作者创建自己的 Notebook 体验。任何人都可以制作支持自定义语言和丰富输出的 VS Code Notebook 扩展，创建 Notebook 与创建任何其他扩展没有区别。
在 Notebook API 之前，VS Code 中的 Jupyter Notebook 支持完全由 Jupyter 扩展提供。该扩展在一个隔离的 webview 中创建其 Notebook 体验，这有点像 VS Code 中的独立网页，无法与您安装的任何其他扩展通信。
然而，现在有了核心 Notebook API，Notebook 支持来自 VS Code，并且不在隔离的 webview 中。这意味着 Notebook 扩展可以与 VS Code 的其余部分以及其他扩展进行交互。例如，Rainbow Indent 等编辑器扩展将在 Notebook 的代码单元格中工作。
Notebook API 不限于 Jupyter Notebooks，因为我们相信还有许多其他领域可以从拥有一个帮助您迭代和叙述代码的工具中受益。我们将新的 Notebook API 公开给任何扩展作者，以便他们可以制作自己的自定义 Notebook。
Notebook 扩展生态系统的开端
下一节将介绍我们在验证 Notebook API 时开发的两个自定义 Notebook。
GitHub Issues Notebook
VS Code 团队创建的第一个 Notebook 体验是 GitHub Issues Notebook。它是一个 Notebook，可以帮助我们分类和组织 GitHub 中的数千个问题。使用此 Notebook，我们可以一次检查多个仓库，通过查询找到问题，例如“查找所有标记为 bug 并分配给我的问题”。VS Code 团队每天都使用此 Notebook 来处理团队在多个仓库中工作时遇到的问题。
您可以在 VS Code 仓库的 .vscode/notebooks 下找到我们用于分类的特定 Notebook。其中一个名为 inbox.github-issues，用于将新问题分类到适当的区域和经办人。
GitHub Issues Notebook 已在 VS Code Marketplace 上提供，任何人都可以使用。您可以通过安装扩展、为您的 Notebook 创建一个文件（文件扩展名为 .github-issues，例如 my-notebook.github-issues），然后创建如下查询来试用它：
$repo=repo:microsoft/vscode-github-issue-notebooks
$repo is:open no:assignee
用于创建查询的 Notebook 语言 github-issues 与 GitHub.com 上使用的语法几乎相同。GitHub Issues Notebook 语言的一个新增功能是它允许您创建变量并在任何其他单元格中使用它们。
您可以在 GitHub.com 上查看 GitHub Issues Notebook 的源代码。
REST Book
受 GitHub Issues Notebook 中查询体验的启发，我刚加入 VS Code 团队时创建了 REST Book 作为学习练习。REST Book 允许您在 Notebook 中进行 HTTP 调用。我发现 REST Book 对于与服务器一起迭代我的项目非常有用，因为它可以在一段时间内进行多次调用并在同一页面上轻松比较结果。我还使用 REST Book Notebook 来设置我项目的一些手动测试，并将文档与测试用例交织在一起。
此 REST Book 扩展也已在 Marketplace 上提供。您可以安装 REST Book 扩展，创建一个以 .restbook 结尾的文件，然后执行任何 HTTP 查询，例如 GET github.com。
一开始开发 REST Book 对我来说似乎很复杂，但是有了大量的 VS Code API，编写程序和创建 REST Book 比我预期的要容易得多。最值得注意的是，我大量使用了语言 API 来为我的自定义 REST 查询语言提供语法高亮和自动补全。然后使用 Notebook API，我只需要填充用户想要运行查询时应该做什么。
您可以在此处查看 REST Book 的源代码。
对于这两个 Notebook，拥有 VS Code Notebook UI 来创建这些类似 REPL 的体验真是太棒了。您无需担心创建和维护自己的 UI，只需专注于功能即可。
制作自己的自定义 Notebook 扩展
观看编码教程
几个月前，VS Code 团队录制了一场关于自定义 Notebook 的直播，我在其中演示了如何创建自定义 Notebook 扩展的实时编码。您可以在 YouTube 上观看：VS Code Notebooks：深入探讨。自视频发布以来，一些 Notebook API 已发生变化，但原理仍然相同。
当您准备构建自己的 Notebook 扩展时，您可以参考 Notebook 扩展作者指南以获取最新和详细的信息。
与社区分享您的想法
如果您对创建自己的 Notebook 扩展不感兴趣，但对有用的应用程序有想法，我们鼓励您在 VS Code Twitter 帐户 @code 上发布 Notebook 想法，或者在 VS Code GitHub 仓库中创建问题。这将让 VS Code 社区阅读和讨论您的 Notebook 想法，并希望激励人们将您的 Notebook 变为现实！
我们在这篇博客中介绍的几个自定义 Notebook 仅仅是个开始！我们很高兴看到您将激发和创造出什么样的自定义 Notebook 体验！
编码愉快！
Tanha Kabir (@_tanhakabir) 和 VS Code 团队 (@code)