スキーマ
IDEでの自動補完と検証を強化するため、Blockstudioは独自のスキーマを導入しています。
Blockstudioスキーマは、WordPressコアblock.jsonスキーマの常に最新のコピーで、プラグイン機能をすべて格納する追加のblockstudioプロパティを備えています。これにより、将来コアに追加される可能性のあるプロパティとの干渉を避けられます。
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プロパティからスキーマを自動的に読み込みます。
ワークスペース全体の設定には、.vscode/settings.jsonに追加します。
JSON
{
"json.schemas": [
{
"fileMatch": ["**/block.json"],
"url": "https://blockstudio.dev/schema/block"
}
]
}
JetBrains IDE
PhpStormなどのJetBrains IDEは、$schemaプロパティを通じてJSONスキーマを自動的にサポートします。
利用可能なスキーマ
| スキーマ | URL |
|---|---|
| ブロックスキーマ | https://blockstudio.dev/schema/block |
| 拡張スキーマ | https://blockstudio.dev/schema/extend |
メリット
- 自動補完: 利用可能なすべてのプロパティの候補を表示
- 検証: 実行時より前にエラーを検出
- ドキュメント: プロパティにカーソルを合わせると説明を表示
- 型安全性: 正しい値の型を保証