blocks.json séma
Teljes séma
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}"
}
}
}
}
Mezők
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
$schema |
string |
Nem | JSON Schema URL a szerkesztői ellenőrzéshez. |
directory |
string |
Igen | Relatív útvonal innen: blocks.json, ahol a blokkok települnek. Nem lehet üres. |
registries |
Record<string, string | RegistryRef> |
Igen | A névterek neveit nyilvántartás-hivatkozásokhoz rendelő leképezés. Üres is lehet. |
A nyilvántartás-hivatkozások formátumai
A registries minden értéke vagy egy karakterlánc URL, vagy egy objektum:
Karakterlánc: érvényes URL egy registry.json fájlhoz.
Objektum:
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
url |
string |
Igen | Érvényes URL egy registry.json fájlhoz. |
headers |
Record<string, string> |
Nem | HTTP fejlécek, amelyeket a rendszer minden, ehhez a nyilvántartáshoz intézett kéréssel elküld. Az értékek támogatják a ${ENV_VAR} interpolációt. |
Érvényesítési szabályok
- A
directoryértékének nem üres karakterláncnak kell lennie. - A
registriesminden kulcsának nem üres karakterláncnak kell lennie. - A karakterlánc típusú nyilvántartásértékeknek érvényes URL-eknek kell lenniük.
- Az objektum típusú nyilvántartásértékeknek érvényes
urlmezővel kell rendelkezniük. - A fejlécekben szereplő
${ENV_VAR}hivatkozásokat futásidőben oldja fel a rendszer. A hiányzó változókat megnevező hiba a változót és a fejlécet is feltünteti. - A
registriesobjektum lehet üres. Ilyenkor aaddNo registries configured in blocks.json. Add a registry first.értékkel lép ki, alistkiírja aNo registries configured.értéket, asearchpedig aNo blocks matching "<query>".értéket.
Konfiguráció felderítése
A CLI az aktuális munkakönyvtártól kezdve keresi a blocks.json fájlt, majd a szülőkönyvtárakon felfelé haladva legfeljebb 20 szintet vizsgál. Az elsőként megtalált blocks.json fájlt használja.