registry.jsonスキーマ
スキーマ全体
JSON
{
"$schema": "https://blockstudio.dev/schema/registry.json",
"name": "my-registry",
"description": "A collection of WordPress blocks.",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"description": "Full-width hero section with heading and CTA.",
"category": "layout",
"type": "blockstudio",
"dependencies": ["button"],
"files": [
"block.json",
"index.php",
"style.scss"
]
}
]
}
トップレベルのフィールド
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
$schema |
string |
いいえ | エディター検証用のJSONスキーマURL。 |
name |
string |
はい | レジストリ識別子。空欄にはできません。 |
description |
string |
いいえ | レジストリの短い説明。 |
baseUrl |
string |
はい | ブロックファイルのダウンロード元となるベースURL。有効なURLでなければなりません。 |
blocks |
BlockEntry[] |
はい | 利用可能なブロックの配列。1件以上必要です。 |
ブロックエントリーのフィールド
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
name |
string |
はい | ブロックフォルダー名およびCLI識別子。空欄にはできません。 |
title |
string |
いいえ | 表示用の名前。 |
description |
string |
いいえ | 検索結果に表示する1行の説明。 |
category |
string |
いいえ | リスト出力で使うグループ名。 |
type |
"blockstudio" | "create-block" | "wordpress" |
いいえ | ブロックの種類。情報表示のみで、CLIの動作には影響しません。 |
dependencies |
string[] |
いいえ | 同じレジストリ内で、このブロックと一緒にインストールする必要があるブロック名。 |
files |
string[] |
はい | ブロックフォルダーからの相対ファイルパス。1つ以上必要です。 |
ファイルの解決
各ファイルのダウンロード元:
コード
{baseUrl}/{block.name}/{file}
書き込み先:
コード
{directory}/{block.name}/{file}
ファイルパス内のサブディレクトリは自動的に作成されます。
検証ルール
nameはレジストリレベルとブロックレベルの両方で空欄にできません。baseUrlは有効なURLでなければなりません。blocksには1件以上のエントリーが必要です。- 各ブロックの
filesには1件以上のエントリーが必要です。 typeを指定する場合は、許可された3つの値のいずれかでなければなりません。dependenciesを指定する場合は文字列の配列でなければなりません。依存先が同じレジストリに存在しない場合、CLIは解決時にエラーになります。