Schemat blocks.json
Pełny schemat
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}"
}
}
}
}
Pola
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
$schema |
string |
Nie | Schemat JSON URL do walidacji w edytorze. |
directory |
string |
Tak | Ścieżka względna względem blocks.json, gdzie instalowane są bloki. Nie może być pusta. |
registries |
Record<string, string | RegistryRef> |
Tak | Mapa nazw przestrzeni nazw na odwołania do rejestrów. Może być pusta. |
Formaty odwołań do rejestru
Każda wartość w registries to ciąg znaków URL lub obiekt:
Ciąg znaków: prawidłowy URL do pliku registry.json.
Obiekt:
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
url |
string |
Tak | Prawidłowy URL do pliku registry.json. |
headers |
Record<string, string> |
Nie | Nagłówki HTTP wysyłane z każdym żądaniem do tego rejestru. Wartości obsługują interpolację ${ENV_VAR}. |
Zasady walidacji
directorymusi być niepustym ciągiem znaków.- Każdy klucz w
registriesmusi być niepustym ciągiem znaków. - Wartości rejestru w postaci ciągu znaków muszą być prawidłowymi adresami URL.
- Wartości rejestru w postaci obiektu muszą zawierać prawidłowe pole
url. - Odwołania
${ENV_VAR}w nagłówkach są rozwiązywane w czasie działania. Brakujące zmienne powodują błąd zawierający nazwę zmiennej i nagłówka. - Obiekt
registriesmoże być pusty. W takim przypadkuaddkończy działanie z kodemNo registries configured in blocks.json. Add a registry first.,listwyświetlaNo registries configured., asearchwyświetlaNo blocks matching "<query>".
Wyszukiwanie konfiguracji
CLI wyszukuje blocks.json, zaczynając od bieżącego katalogu roboczego i przechodząc w górę przez katalogi nadrzędne, maksymalnie o 20 poziomów. Używany jest pierwszy znaleziony blocks.json.