MDN浏览器兼容性数据(BCD)项目中的标签使用指南

MDN浏览器兼容性数据(BCD)项目中的标签使用指南

browser-compat-data This repository contains compatibility data for Web technologies as displayed on MDN 项目地址: https://gitcode.com/gh_mirrors/br/browser-compat-data

什么是BCD标签

在MDN浏览器兼容性数据(BCD)项目中，标签(tags)是一种可选属性，用于为任何BCD特性添加分类标记。标签以数组形式存在，每个标签都采用"命名空间:名称"的格式。

标签的基本结构

标签必须遵循严格的格式规范：

"tags": [
  "web-features:idle-detection"
]

• 必须使用数组形式
• 必须包含命名空间前缀
• 名称部分只能包含小写字母(a-z)、数字(0-9)和连字符(-)

标签命名空间详解

命名空间的引入是为了明确标签的用途，便于验证、检查和批量修改。目前BCD项目中只允许使用以下命名空间：

web-features命名空间

这是目前唯一被批准的命名空间，专门用于标记属于特定Web平台特性组的BCD特性。这些标签会被web-platform-dx项目导入使用。

web-features标签命名规范

1. 优先使用广泛认知的标识符

   • 推荐：web-features:javascript
   • 不推荐：web-features:ecmascript

2. 避免技术前缀

   • 推荐：web-features:container-queries
   • 不推荐：web-features:css-container-queries

3. 避免常见缩写和通用名词

   • 推荐：web-features:navigation
   • 不推荐：web-features:navigation-api

4. 使用描述性名词短语

   • 推荐：web-features:offscreen-canvas
   • 不推荐：web-features:offscreencanvas

5. 保持简洁但明确

   • 推荐：web-features:has
   • 不推荐：web-features:has-pseudo-class

标签操作实践

查询特定标签的特性

BCD项目提供了遍历脚本，可以查找所有使用特定标签的特性：

npm run traverse -- -t web-features:idle-detection

执行结果会显示所有相关特性的路径和总数：

api.IdleDetector
api.IdleDetector.IdleDetector
...
8

批量编辑标签

目前BCD项目尚未提供批量编辑标签的命令行工具，但未来会添加这一功能。在工具推出前，建议手动编辑或编写脚本处理大量标签修改。

最佳实践建议

1. 谨慎添加标签：目前web-features命名空间仍处于实验阶段，可能会发生重大变更
2. 保持一致性：严格遵循命名规范，确保标签清晰易懂
3. 避免过度使用：只在特性确实属于某个Web平台特性组时才添加标签

通过合理使用标签系统，可以更好地组织和分类浏览器兼容性数据，为开发者提供更结构化的参考信息。

browser-compat-data This repository contains compatibility data for Web technologies as displayed on MDN 项目地址: https://gitcode.com/gh_mirrors/br/browser-compat-data