Web-Types

欢迎来到 Web-Types，这是一种用于记录 Web 组件库的 JSON 格式。

Web-Types 是一种与框架无关的格式，旨在为 IDE 和其他工具提供有关组件库内容的元数据信息。其强大的命名模式可以编码有关 Web 框架语法的信息，或为支持 Web-Types 的 IDE 中的大型图标库自定义代码补全建议。

2.0 版本格式

Web-Types 最初是为支持 Vue 库而创建的格式，但我们一直希望提供一个更通用的解决方案。最终，Web-Types 2.0 版本可以无缝地适用于任何类型的 Web 框架、Web 组件库或 CSS 图标包。

格式的详细文档可在这里找到。

从 WebStorm（以及其他 JetBrains IDE）的 2021.3.1 版本开始，完全支持新的 Web-Types 格式（新格式自 2021.2 版本起已部分支持）。现在您可以添加自定义 HTML 元素和属性、自定义 CSS 类、属性、函数、伪类和伪元素。Vue 和 Angular 支持与该格式完全集成，因此您可以轻松地在 Angular 或 Vue 模板中混合使用 Web 组件。

示例 Web-Types 文件可在 examples 文件夹中找到。Angular 和 Vue 框架的 Web-Types 可在 examples/references 目录中找到。它们需要 IDE 插件基于项目源代码的动态贡献才能正常工作。

Piotr Tomiak 解释新版本格式和模式处理工作原理的网络研讨会录像可在 YouTube 上观看。

新版本的 Web-Types 与仅支持 Vue 的 Web-Types 向后兼容。

使用 Web-Types 进行本地开发

要在项目中启用 Web-Types 文件，请通过本地项目 package.json 文件的 web-types 属性链接它。您可以通过提供路径数组来指定多个 Web-Types 文件。

分发

欢迎库提供者包含详细的 Web-Types JSON 文件，并通过 package.json 中的 web-types 属性链接它们。例如：

{
  ...
  "web-types": "./web-types.json"
  ...
}

许多库都提供了这个功能，例如：

Vue.js
- vuetify (https://github.com/vuetifyjs/vuetify/pull/9440)
- quasar (https://github.com/quasarframework/quasar/pull/4749)
- bootstrap-vue (https://github.com/bootstrap-vue/bootstrap-vue/pull/4110)
- nuxt.js (https://github.com/nuxt/nuxt.js/pull/7611)
- @ionic/vue (https://github.com/ionic-team/ionic-framework/pull/22428)

如果某个库没有提供 Web Types，它们可以在 NPM 上的 @web-types 作用域下发布。目前，以下框架和库以这种方式得到支持：

Vue.js
- quasar-framework
Web Components
- lit

已发布的 JSON 文件被检入到本仓库的 packages 文件夹下。对于发布到 @web-types 作用域的 Web-Types，IDE 应该能够下载所需的 JSON 文件，而无需对用户项目结构进行任何更改。

各种 IDE 在扫描 node_modules 目录时会进行优化，因此为确保您的包的 web-types 始终可用，请确保它列在 packages/registry.json 中。

模式

Web-Types JSON 模式可在 schema 文件夹中找到。使用以下 URL 之一在您的 JSON 文件中引用它：

http://json.schemastore.org/web-types

或

https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json

生成 Web-Types

从源代码

目前支持以下组件文档格式：

使用 styleguidist vue-docgen-api 库的 JSDoc - 将 vue-docgen-web-types 包添加到您的项目中，然后运行 vue-docgen-web-types 命令。您可以通过传递 --watch 参数在监视模式下启动它，也可以通过 --configFile 参数传递自定义配置文件。有关支持的配置文件选项的详细信息，请参阅 config.d.ts。

如果您的项目中没有使用 JSDoc，可以为 web-types JSON 创建自己的构建器。有关示例，请参阅上面的 vuetify、quasar 或 bootstrap-vue 拉取请求。

发布到 `@web-types` 作用域

我们欢迎您在 packages 文件夹中为库提交 Web-Types 的 PR。每个库应该有一个单独的文件，格式如下：

packages/<pkg-name>/<pkg-name>@<pkg-version>.web-types.json

我们使用 script/publish.sh 脚本同步 packages 文件夹的内容，其使用语法如下：

publish.sh <package-name> [--dry-run]

该脚本会扫描 packages/<package-name> 文件夹中提供的 Web-Types json 文件，并与 NPM 同步内容。

`@web-types` 作用域的版本控制和命名

版本控制和命名规则如下：

包 pkg-name 的 Web-Types 可在 @web-types/pkg-name 下获得
包 @scope/pkg-name 的 Web-Types 可在 @web-types/at-scope-pkg-name 下获得
版本 1.2.3 的 Web-Types 发布为预发布版本 1.2.3-n，例如 1.2.3-3
预发布版本 1.2.3-rc.1 的 Web-Types 发布时会添加额外的段，例如 1.2.3-rc.1.3
要搜索适当的 Web-Types 包，请使用范围 <pkg-ver 并包括预发布版本，例如要查找版本 1.2.6 的 Web-Types，请使用 <1.2.6 查询包列表，这可能匹配版本 1.2.4-12 的 Web-Types
所有过时的版本都被标记为已弃用，应被 IDE 忽略