blocks.jsonスキーマ
スキーマ全体
JSON
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"public": "https://example.com/registry.json",
"private": {
"url": "https://private.example.com/registry.json",
"headers": {
"Authorization": "Bearer ${REGISTRY_TOKEN}"
}
}
}
}
フィールド
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
$schema |
string |
いいえ | エディター検証用のJSONスキーマURL。 |
directory |
string |
はい | ブロックのインストール先となるblocks.jsonからの相対パス。空欄にはできません。 |
registries |
Record<string, string | RegistryRef> |
はい | 名前空間名とレジストリ参照の対応表。空でもかまいません。 |
レジストリ参照の形式
registriesの各値には、文字列URLまたはオブジェクトを指定します。
文字列: registry.jsonファイルを指す有効なURL。
オブジェクト:
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
url |
string |
はい | registry.jsonファイルを指す有効なURL。 |
headers |
Record<string, string> |
いいえ | このレジストリへのすべてのリクエストに送信するHTTPヘッダー。値では${ENV_VAR}による展開を利用できます。 |
検証ルール
directoryは空でない文字列でなければなりません。registriesの各キーは空でない文字列でなければなりません。- 文字列形式のレジストリ値には、有効なURLを指定してください。
- オブジェクト形式のレジストリ値には、有効な
urlフィールドが必要です。 - ヘッダー内の
${ENV_VAR}参照は実行時に解決されます。変数が見つからない場合は、変数名とヘッダー名を含むエラーが発生します。 registriesオブジェクトは空でもかまいません。その場合、addはNo registries configured in blocks.json. Add a registry first.で終了し、listはNo registries configured.を表示し、searchはNo blocks matching "<query>".を表示します。
設定ファイルの検索
CLIは現在の作業ディレクトリから親ディレクトリを最大20階層さかのぼってblocks.jsonを探します。最初に見つかったblocks.jsonが使用されます。