自定义数据格式：演进中的 HTML 和 CSS 语言功能

2020 年 2 月 24 日，作者：Pine Wu，@octref

Web 正在不断发展，其语言也在演变。新的实体不断添加到 HTML 和 CSS 规范中。Custom Elements 和 Houdini 允许用户扩展 HTML 和 CSS 语义。如今，许多开发者使用嵌入 HTML 和 CSS 的编程语言。尽管 HTML 和 CSS 的使用越来越灵活，但编辑器对新功能的支持往往滞后。

为了现代化 Visual Studio Code 中的 HTML 和 CSS 语言支持，我们设计了自定义数据格式，这是一种用于描述 HTML 和 CSS 实体的声明性 JSON 格式。VS Code 的 HTML 和 CSS 语言服务器可以读取此格式中定义的数据，并为新定义的 HTML 和 CSS 实体提供语言支持。

在本博客文章中，我们将解释该数据格式以及用户和扩展作者如何利用它。

使用自定义数据格式

VS Code 在自动补全和悬停信息中提供有关 HTML/CSS 实体的信息

HTML and CSS Language Features

使用自定义数据格式，用户可以轻松定义新的 HTML/CSS 实体，并获得自动补全、悬停信息和其他语言功能。

要开始使用，用户可以编写一个 JSON 文件 html.html-data.json

{
  "version": 1.1,
  "tags": [
    {
      "name": "my-button",
      "description": "My button. You should use it as in `<my-button type='alert'></mybutton>`.",
      "references": [
        {
          "name": "Bootstrap buttons",
          "url": "https://bootstrap.ac.cn/docs/4.0/components/buttons/"
        }
      ]
    }
  ]
}

然后在您的用户或工作区设置中定义一个指向该数据文件的 html.customData 值

{
  "html.customData": ["./html.html-data.json"]
}

然后您将获得所定义实体的语言功能

Custom Data helloworld

您可以通过使用 VS Code 打开预配置的自定义数据 hello world 示例来试用此功能。您可以编辑 HTML/CSS 自定义数据文件，以便添加、移除或优化自定义实体的定义，并微调语言功能。

html.customData 和 css.customData 设置是使用自定义数据的良好起点。然而，还有其他方式可以利用自定义数据。在以下部分中，我们将介绍扩展作者如何共享精选的自定义数据集或利用自定义数据构建语言支持。

通过扩展共享自定义数据

如今，许多 Web 框架构建在 HTML 之上。例如，Mavo 项目使用各种 mv- 属性扩展了 HTML 语法。自定义数据使得支持此类 Web 框架变得容易

为所有 Mavo 属性生成自定义数据。
在 contributes.html.customData 扩展贡献点中指向自定义数据文件。
发布扩展，以帮助其他人使用 VS Code 中的 Mavo 框架。

通过下载Mavo 扩展，用户可以在 HTML 文件中获得所有 Mavo 属性的自动补全和悬停信息

Mavo demo

该扩展的源代码位于vscode-mavo 仓库。我们希望该项目能成为在 VS Code 中实现 Web 框架或语言支持的起点。您可以在vscode-custom-data 中找到有关 contributes.html.customData 和 contributes.css.customData 贡献点的更多信息。

将自定义数据用于语言服务器

vscode-html-languageservice 和 vscode-css-languageservice 库允许扩展作者轻松实现扩展或嵌入 HTML 和 CSS 的语言的语言服务器。最近，我们添加了一个用于加载自定义数据的 API

import { getLanguageService } from 'vscode-html-languageservice'

getLanguageService({
  customDataProviders: [...]
})

我们内置的HTML 语言服务器利用此 API 加载我们从各种来源收集的精选自定义数据集

HTML、CSS 和 WAI-ARIA 的 W3C 规范
Mozilla 开发者网络
Mozilla 的mdn-data 和 mdn-browser-compat-data 包
Chrome 对 CSS 属性使用情况的排名

我们已将此数据集发布到 NPM。您也可以在GitHub 上找到该数据。语言服务器作者可以将此数据集与我们的 HTML/CSS 语言服务结合使用，为其扩展或嵌入 HTML/CSS 的语言实现支持，或者他们可以使用此数据为转译到 HTML/CSS 的语言（例如 Pug 或 Stylus）实现支持。最后，我们将继续整理此数据集，以便在 VS Code 中为 HTML/CSS 提供最新的语言支持。

总结

VS Code 团队致力于为 Web 语言提供良好的编辑体验。通过自定义数据格式，我们紧跟最新的 HTML 和 CSS 语言功能，并为用户和扩展作者提供了简单的接口来定制他们的 HTML 和 CSS 编辑体验。

Simple interface

您可以在vscode-custom-data 仓库中阅读有关自定义数据格式的更多信息，您可以在那里提交问题和功能请求。

编码愉快！

Pine Wu，VS Code 团队成员 @octref