Перейти до вмісту

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