Схема 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 или объект:
Строка: корректный URL к файлу registry.json.
Объект:
| Поле | Тип | Обязательно | Описание |
|---|---|---|---|
url |
string |
Да | Корректный URL к файлу registry.json. |
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 ищет blocks.json, начиная с текущего рабочего каталога и поднимаясь по родительским каталогам не более чем на 20 уровней. Используется первый найденный blocks.json.