Edit

嵌入式编程语言

Name: Visual Studio Code
Author: Microsoft

Visual Studio Code 为编程语言提供了丰富的语言功能。正如您在语言服务器扩展指南中所读到的，您可以编写语言服务器以支持任何编程语言。然而，为嵌入式语言启用此类支持需要更多的努力。

如今，嵌入式语言的数量正在不断增加，例如：

HTML中的JavaScript和CSS
JavaScript中的JSX
模板语言中的插值，例如 Vue、Handlebars 和 Razor
PHP中的HTML

本指南重点介绍如何实现嵌入式语言的语言特性。如果您对为嵌入式语言提供语法高亮感兴趣，可以在语法高亮指南中找到相关信息。

本指南包含两个示例，展示了构建此类语言服务器的两种方法：语言服务和请求转发。我们将回顾这两个示例，并总结每种方法的优缺点。

两个示例的源代码可以在以下位置找到：

这是我们即将构建的嵌入式语言服务器：

两个示例都贡献了一种新语言，html1，用于说明目的。您可以创建一个文件.html1并测试以下功能：

HTML标签的自动补全
在
CSS 诊断（仅在语言服务示例中）

语言服务

一个语言服务是一个库，它为单一语言实现编程语言特性。一个语言服务器可以嵌入语言服务来处理嵌入的语言。

以下是VS Code的HTML支持概述：

内置的 html 扩展仅提供 HTML 的语法高亮和语言配置。
内置的 html-language-features 扩展包含一个 HTML 语言服务器，为 HTML 提供编程语言功能。
HTML 语言服务器使用 vscode-html-languageservice 来支持 HTML。
CSS 语言服务器使用 vscode-css-languageservice 来支持 HTML 中的 CSS。

HTML语言服务器分析HTML文档，将其分解为语言区域，并使用相应的语言服务来处理语言服务器请求。

例如：

对于在<|处的自动完成请求，HTML语言服务器使用HTML语言服务来提供HTML补全。
对于在处的自动补全请求，HTML语言服务器使用CSS语言服务来提供CSS补全。

让我们来检查一下lsp-embedded-language-service示例，这是一个简化版的HTML语言服务器，实现了HTML和CSS的自动完成功能，以及CSS的诊断错误功能。

语言服务示例

注意: 本示例假设您已经了解编程语言特性主题和语言服务器扩展指南。代码基于lsp-sample构建。

源代码可在microsoft/vscode-extension-samples获取。

与lsp-sample相比，客户端代码是相同的。

如上所述，服务器将文档分解为不同的语言区域以处理嵌入的内容。

这是一个简单的例子：

<div></div>
<style>.foo { }</style>

在这种情况下，服务器检测到

在特定位置给定一个自动完成请求，服务器使用以下逻辑来计算响应：

如果位置落入任何区域
- 使用该区域语言的虚拟文档处理它，同时用空格替换所有其他区域
如果位置超出任何区域
- 在HTML中使用虚拟文档处理它，同时用空白替换所有区域

例如，在此位置进行自动完成时：

<div></div>
<style>.foo { | }</style>

服务器确定位置在区域内，并计算出一个虚拟的CSS文档，内容如下（█代表空格）：

███████████
███████.foo { | }████████

服务器随后使用vscode-css-languageservice来分析此文档并计算完成项列表。由于内容现在不包含HTML，CSS语言服务可以毫无问题地处理它。通过将所有非CSS内容替换为空白，我们避免了手动偏移位置的需要。

处理完成请求的服务器代码：

connection.onCompletion(async (textDocumentPosition, token) => {
  const document = documents.get(textDocumentPosition.textDocument.uri);
  if (!document) {
    return null;
  }

  const mode = languageModes.getModeAtPosition(document, textDocumentPosition.position);
  if (!mode || !mode.doComplete) {
    return CompletionList.create();
  }
  const doComplete = mode.doComplete!;

  return doComplete(document, textDocumentPosition.position);
});

负责处理所有属于CSS区域的语言服务器请求的CSS模式：

export function getCSSMode(
  cssLanguageService: CSSLanguageService,
  documentRegions: LanguageModelCache<HTMLDocumentRegions>
): LanguageMode {
  return {
    getId() {
      return 'css';
    },
    doComplete(document: TextDocument, position: Position) {
      // Get virtual CSS document, with all non-CSS code replaced with whitespace
      const embedded = documentRegions.get(document).getEmbeddedDocument('css');
      // Compute a response with vscode-css-languageservice
      const stylesheet = cssLanguageService.parseStylesheet(embedded);
      return cssLanguageService.doComplete(embedded, position, stylesheet);
    }
  };
}

这是一种简单有效的处理嵌入式语言的方法。然而，这种方法也有一些缺点：

您必须持续更新您的语言服务器所依赖的语言服务。
包含与语言服务器不同语言编写的语言服务可能会具有挑战性。例如，用PHP编写的PHP语言服务器会发现包含用TypeScript编写的vscode-css-languageservice很麻烦。

我们现在将介绍请求转发，这将解决上述问题。

请求转发

简而言之，请求转发的工作方式与语言服务类似。请求转发方法也接收语言服务器请求，计算虚拟内容，并计算响应。

主要区别是：

虽然语言服务方法使用库来计算语言服务器响应，但请求转发将请求发送回VS Code，以使用已激活并为嵌入式语言注册了完成提供程序的扩展。

这是简单的示例再次展示：

<div></div>
<style>.foo { | }</style>

自动完成是这样发生的：

语言客户端使用workspace.registerTextDocumentContentProvider为embedded-content文档注册一个虚拟文本文档提供者。
语言客户端劫持了对的完成请求。
语言客户端确定请求位置落入CSS区域。
语言客户端构造一个新的URI，例如 embedded-content://css/.css。
语言客户端随后调用 commands.executeCommand('vscode.executeCompletionItemProvider', ...)
- VS Code 的 CSS 语言服务器响应此提供者请求。
- 虚拟文本文档提供者为 CSS 语言服务器提供虚拟内容，其中所有非 CSS 代码都被替换为空白。
- 语言客户端接收来自 VS Code 的响应并将其作为响应发送。

通过这种方法，即使我们的代码不包含任何理解CSS的库，我们也能够计算CSS自动完成。随着VS Code更新其CSS语言服务器，我们无需更新代码即可获得最新的CSS语言支持。

现在让我们回顾一下示例代码。

请求转发示例

注意: 本示例假设您已经了解编程语言特性主题和语言服务器扩展指南。代码基于lsp-sample构建。

源代码可在microsoft/vscode-extension-samples获取。

保持文档的URI与其虚拟文档之间的映射，并为相应的请求提供它们：

const virtualDocumentContents = new Map<string, string>();

workspace.registerTextDocumentContentProvider('embedded-content', {
  provideTextDocumentContent: uri => {
    // Remove leading `/` and ending `.css` to get original URI
    const originalUri = uri.path.slice(1).slice(0, -4);
    const decodedUri = decodeURIComponent(originalUri);
    return virtualDocumentContents.get(decodedUri);
  }
});

通过使用语言客户端的middleware选项，我们劫持了自动完成的请求：

let clientOptions: LanguageClientOptions = {
  documentSelector: [{ scheme: 'file', language: 'html' }],
  middleware: {
    provideCompletionItem: async (document, position, context, token, next) => {
      // If not in `<style>`, do not perform request forwarding
      if (
        !isInsideStyleRegion(
          htmlLanguageService,
          document.getText(),
          document.offsetAt(position)
        )
      ) {
        return await next(document, position, context, token);
      }

      const originalUri = document.uri.toString(true);
      virtualDocumentContents.set(
        originalUri,
        getCSSVirtualContent(htmlLanguageService, document.getText())
      );

      const vdocUriString = `embedded-content://css/${encodeURIComponent(originalUri)}.css`;
      const vdocUri = Uri.parse(vdocUriString);
      return await commands.executeCommand<CompletionList>(
        'vscode.executeCompletionItemProvider',
        vdocUri,
        position,
        context.triggerCharacter
      );
    }
  }
};

潜在问题

在实现嵌入式语言服务器时，我们遇到了许多问题。尽管我们还没有一个完美的解决方案，但我们想提前告知您，因为您也可能会遇到这些问题。

难以实现的语言特性

通常，跨语言区域边界工作的语言功能更难实现。例如，自动完成或悬停内容很容易实现，因为您可以检测嵌入内容的语言并根据嵌入内容计算响应。然而，格式化或重命名等语言功能可能需要特殊处理。在格式化的情况下，您需要处理单个文档内多个区域的缩进和格式化设置。对于重命名，使其在不同文档的不同区域之间工作可能具有挑战性。

语言服务可能是有状态的且难以嵌入

VS Code 的 HTML 支持提供了 HTML、CSS 和 JavaScript 语言特性。尽管 HTML 和 CSS 语言服务是无状态的，但支持 JavaScript 语言特性的 TypeScript 服务器是有状态的。我们只在 HTML 文档中提供基本的 JavaScript 支持，因为很难向 TypeScript 告知项目的状态。例如，如果你包含一个指向托管在 CDN 上的 lodash 库的

编码和解码

文档的主要语言可能与其嵌入语言有不同的编码或转义规则。例如，根据HTML规范，这个HTML文档是无效的：

<SCRIPT type="text/javascript">
  document.write ("<EM>This won't work</EM>")
</SCRIPT>

在这种情况下，如果嵌入式JavaScript的语言服务器返回的结果包含，则应将其转义为<\/。

结论

两种方法各有优缺点。

语言服务：

+ 完全控制语言服务器和用户体验。
+ 不依赖其他语言服务器。所有代码都在一个仓库中。
+ 语言服务器可以在所有符合LSP的代码编辑器中重复使用。
- 可能难以嵌入用其他语言编写的语言服务。
- 需要持续维护以从语言服务依赖中获取新功能。

请求转发：

+ 避免嵌入未用语言服务器语言编写的语言服务时出现问题（例如，在Razor语言服务器中嵌入C#编译器以支持C#）。
+ 无需维护即可从其他语言服务获取新功能。
- 不适用于诊断错误。VS Code API 不支持可以“拉取”（请求）诊断的诊断提供程序。
- 由于缺乏控制，难以与其他语言服务器共享状态。
- 跨语言功能可能难以实现（例如，当存在时，为.foo提供CSS补全）。

总体而言，我们建议通过嵌入语言服务来构建语言服务器，因为这种方法使您能够更好地控制用户体验，并且该服务器可重复用于任何符合LSP标准的编辑器。然而，如果您有一个简单的用例，其中嵌入内容可以在没有上下文或语言服务器状态的情况下轻松处理，或者如果捆绑Node.js库对您来说是一个问题，您可以考虑使用请求转发方法。

12/11/2024