尝试以扩展 VS Code 中的代理模式！

介绍 Markdown 语言服务器

2022 年 8 月 16 日，作者：Matt Bierner，@MattBierner

当我 2016 年加入 Visual Studio Code 团队时，Markdown 支持是我接手的第一个功能。哇，真的已经六年了吗？不过这真是天作之合。我使用 Markdown 的时间足够长，以至于我经常发现自己会满怀希望地在 Twitter、Outlook 以及几乎所有光标停留的文本框里输入反引号和星号。这些年来，能够逐步完善 VS Code 内置的 Markdown 支持，并看到我们的 Markdown 扩展如何直接和间接地影响了像 webview 和 notebook 这样的核心功能，这让我感到非常有成就感。

因此，我很高兴能分享一个我过去半年里一直在默默推进的项目，一个我认为代表了 VS Code Markdown 工具下一步发展的项目：一个 Markdown 语言服务器。通过这个语言服务器，我们将 VS Code 内置的大部分 Markdown 语言工具——从文档大纲、智能折叠到路径补全——开放给其他编辑器和工具使用。我们的目标是，用通常与编程语言相关联的那种智能来推动 Markdown 工具的发展。

Markdown 语言服务器的工作分为两个新的（且名称相似的！）开源库：

虽然这些库仍处于早期阶段，但它们已经被 VS Code 1.70+ 版本所使用（希望你从未注意到过 :-)）。我们甚至已经从这次转换中看到了一些好处，比如将 Markdown 工具移至一个独立的进程，这样它就不会阻塞其他扩展。

但在我讲得太远之前，也许你会好奇：为什么需要一个 Markdown 语言服务器？说实话，我自己也花了六年时间才想通这一点。这也追溯了我对 Markdown 认知的演变：从最初认为它只是加了几个星号、方括号和井号来增加趣味的纯文本，到后来理解它是一种标记语言，并且可以从我们为 TypeScript 或 Python 等编程语言提供的许多相同工具中受益。

深入了解 Markdown 工具

在发现 VS Code 之前，我主要使用一个简单的文本编辑器来编码。这意味着我必须记住符号名称，每次想用时都得手动输入。如果我想重命名一个变量，我会进行文本查找/替换，并寄希望于我的单元测试能捕捉到那些不可避免的输错或搞乱名称的情况。这种工作方式既慢又不可靠，但我却很满足，因为我不知道事情可以变得更好。直到我最终接触到更智能的工具后，我才真正领悟到我以前的工作流程是多么原始。

最近，我在 Markdown 上有了同样的感悟。多年来，我一直满足于使用 VS Code 相对简单的 Markdown 编辑器。我对语法高亮和内置的 Markdown 预览感到满意。文档大纲和可点击的编辑器链接都只是额外的福利。我已经习惯了手动写出链接。我已经接受了如果我更改了一个标题名称，我就需要进行文本搜索来更新所有指向该标题的链接。而且因为我把 Markdown 看作不过是花哨的纯文本，我甚至无法想象有更好的方式是可能的。

但有一天，在我感觉像是第一百次输错图片路径后，我终于意识到：这一点也不好玩！我为什么要浪费生命去手动输入和验证这些链接？这不正是工具该干的事吗！我知道我想要的不仅仅是任何工具，我想要一个能帮助我以文本形式阅读和编写 Markdown，而不是把 Markdown 源码隐藏在某种所见即所得（WYSIWYG）式的 UI 魔法后面的工具。这与 VS Code 的理念以及我们思考如何支持编程语言的方式非常一致。为什么我们为传统编程语言提供的许多智能功能不能同样应用于 Markdown 呢？第二天，我就开始了链接补全的工作。

链接补全是帮助你编写指向当前文件内标题或工作区内其他文件链接的建议。我甚至添加了对补全指向其他 Markdown 文件内标题链接的支持。真棒！这是一个小小的补充，但却极大地提高了我的生产力。很快，我就无法想象没有它我该怎么活。

Markdown 补全的成功让我欣喜若狂，我开始陶醉地想象接下来还能为 Markdown 带来哪些其他的语言智能。我幻想着自己能自信地在标题上按 F2 来安全地重命名它们。我幻想着红色的波浪线能从模糊的文本海洋中射出，帮助识别无效链接。这一切都显得那么理所当然！为什么我几年前没有想到呢？我开始将 Markdown 理解为结构化文本，而不仅仅是纯文本，更好的 Markdown 工具的可能性似乎无穷无尽。

Markdown 语言特性

我不会用每个新功能的背后故事或所有实现的血腥细节来烦你。 suffice it to say，我采取了一种增量的方法，这使得在我投入到 VS Code Markdown 支持的有限时间内，所有这些努力都成为可能。例如，我没有直接去构建重命名支持，而是先让一个可靠的**查找所有引用**版本运行起来（因为如果你想重命名一个符号，你首先需要知道它被引用的所有地方）。增量工作并将每个功能建立在另一个之上，也帮助我在实现新功能时测试旧功能。例如，实现链接的重命名帮助我捕捉了大量链接检测的错误。（这种方法的唯一缺点是，你意识到你那“哦，如此优雅”的塔是建在几个非常棘手的正则表达式之上的）。

当报告无效文件/图片链接的实验性支持在春末推出时，我退后一步审视我的工作。Markdown 语言功能集现在包括：

  • 文档大纲
  • 工作区符号
  • 文档链接
  • 智能折叠
  • 智能选择
  • 补全
  • 重命名
  • 查找所有引用
  • 转到定义
  • 损坏链接的诊断
  • 文件移动/重命名时更新链接

我知道这些新工具会让处理 Markdown 更快、更安全。但当我回顾这个在编程语言中很常见的功能列表时，一个想法一直在困扰我。几个月前我还认为这很荒谬，但现在，当我再次思考时，我意识到，也许是时候推出一个 Markdown 语言服务器了。

你被“服务器”了吗？（Are you being servered?）

到 2022 年春末，所有 VS Code 的 Markdown 工具仍然运行在常规的扩展 API 上。虽然我想探索将所有这些工具迁移到一个合适的语言服务器，但进行这一改变会有实际的工程成本。我需要确保这是值得的。

我为此反复考虑了一个多月。尽管现有代码状况良好，但仍有许多未知数。如果我中途发现行不通怎么办？我以前甚至没有认真地开发过语言服务器。

在辩论这一切的同时，我通过重构 Markdown 扩展的源代码来让自己保持忙碌，就好像它将被移动到语言服务器一样。我试图隔离对 VS Code 扩展 API 的依赖，我将更多的逻辑切换到使用服务注入，并确保测试不依赖于文件系统。这样，即使我最终没有投身于语言服务器，至少我也在清理代码库。

最终有几个考虑因素说服了我，一个 Markdown 语言服务器是正确的下一步。首先是一个相当平凡的原因：我发现为 Markdown 文件高效地实现链接诊断非常具有挑战性。在一个大型的 Markdown 工作区，比如 vscode-docs，我总是会不小心阻塞扩展主机几百毫秒。这可不好。而语言服务器则作为自己的进程运行。不仅如此，语言服务器现在还有一个新的诊断拉取模型，我很想尝试一下。

然后还有更崇高的理由。例如，一个 Markdown 语言服务器对其他编辑器和工具也会很有用。这包括 VS Code 团队发布的另一个编辑器：Monaco！更不用说像 Markdown CLI 工具这样的可能性了。如果我没有时间自己构建这样的工具，也许其他人可以，以语言服务器为起点。我在 VS Code 的 Markdown 工具上投入了大量工作，如果所有这些工作也能惠及他人，那就太好了。

通过提供一个新的语言服务器，我也许还能启动一个围绕改进 Markdown 工具的共同努力。VS Code 既是开源软件的多产生产者，也是其用户，我看到了这类项目带来的明显好处。一个开源的 Markdown 语言服务器将帮助其他编辑器，但反过来也会吸引贡献，最终帮助 VS Code！与其让每个编辑器/工具重复劳动实现自己的 Markdown 支持，一个语言服务器可以将开发者聚集在一起，共同致力于一个能让所有人受益的更大项目。

如果没有一个如何实际构建语言服务器的计划，所有这些宏大的思考都是无关紧要的。即使经过我所有的重构，将代码迁移到语言服务器也将是一项巨大的工作！这看起来势不可挡，直到我意识到我不必一次性完成。我可以增量地构建服务器，一次从 VS Code Markdown 扩展迁移一个功能到新的 Markdown 语言服务器。如果我做得对，我可以把每个小的增量迁移都提交进去，这样用户在构建新语言服务器的同时就在测试它。理想情况下，用户永远不会注意到一个功能从扩展迁移到了语言服务器。

也许这很明显，但我已经成为这种大型代码变更增量方法的忠实信徒。没有数十万行代码的 PR，也没有持续数月（或数年！）的庞大功能分支。相反，对 main 分支进行一系列小的、安全的更改。如果一切按计划进行，为这项工作画上句号的提交应该是平淡无奇的。这就是我们在整个 VS Code 代码库中逐步使用严格空值检查所采取的方法，这也是我觉得我可以快速且尽可能平稳地将所有 VS Code 的 Markdown 工具迁移到新语言服务器的方式。

剧透一下：它成功了！我一次一个地迁移了语言功能。我边做边学，并在需要时进行重构。诊断是最后一个迁移的功能，因为我不仅将它们迁移到语言服务器，还重写了它们以使用语言服务器新的拉取诊断模型。整个工作的最后一次提交主要是删除了 Markdown 扩展中现在未使用的代码。所以今天，如果你使用的是 VS Code 1.70+，几乎所有的 Markdown 语言功能都使用了新的语言服务器。

共同构建更好的 Markdown 工具

在许多方面，过去六个月在 VS Code 的 Markdown 工具方面的进展比我过去六年在这个领域工作的总和还要多。今天，我们推出了许多新工具，其中一些是 Markdown 以前从未有过的。这些功能中的许多都惠及了最普通的 Markdown 读者和作者，而其他功能则只有高级用户才会欣赏。然而，尽管取得了所有这些进步，我知道我们才刚刚开始探索 Markdown 工具的可能性。

真正让我对 Markdown 语言服务器感到兴奋的是，现在这个项目已经超越了 VS Code 本身。通过让我们的 Markdown 工具易于使用，我希望我们能帮助推动所有人的 Markdown 工具向前发展。这些开源项目是邀请大家共同构建 Markdown 工具未来的邀请函。如果你有兴趣贡献，请查看这些新项目，看看你能用它们创造出什么。你可以提交错误报告和功能请求，甚至可以提交一个 PR！还有很多我连想都没想到的智能 Markdown 语言功能。让我们一起构建它们吧！

如果你有兴趣查看源代码或做出贡献，可以在 GitHub 和 npm 上找到 Markdown 语言服务和服务器：

编码愉快！

Matt Bierner, @MattBierner