Към съдържанието

Схема на 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.