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