架构
为通过自动补全和验证提升 IDE 中的开发体验,Blockstudio 推出了自己的 Schema:
Blockstudio Schema 是 WordPress 核心 block.json Schema 的副本(始终保持最新),并额外包含一个 blockstudio 属性,用于容纳字段 Schema 等所有插件功能,避免与未来可能新增的核心属性冲突。
添加到 JSON
只需在你的 block.json 中添加一个值为 https://blockstudio.dev/schema/block 的 $schema 键,IDE 就会开始提示 Blockstudio 专属属性。
JSON
{
"$schema": "https://blockstudio.dev/schema/block",
"name": "blockstudio/native",
"title": "Native Block",
"category": "text",
"icon": "star-filled",
"description": "Native Blockstudio block.",
"blockstudio": true
}
IDE 支持
VS Code
VS Code 会自动读取 $schema 属性中的 Schema。
如需为整个工作区设置,请添加到 .vscode/settings.json:
JSON
{
"json.schemas": [
{
"fileMatch": ["**/block.json"],
"url": "https://blockstudio.dev/schema/block"
}
]
}
JetBrains IDE
PhpStorm 和其他 JetBrains IDE 会通过 $schema 属性自动支持 JSON Schema。
可用的 Schema
| Schema | URL |
|---|---|
| 区块 Schema | https://blockstudio.dev/schema/block |
| 扩展 Schema | https://blockstudio.dev/schema/extend |
优点
- 自动补全:获取所有可用属性的建议
- 验证:在运行时之前发现错误
- 文档:将鼠标悬停在属性上即可查看行内文档
- 类型安全:确保值的类型正确