blocks.json-skema
Komplet skema
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}"
}
}
}
}
Felter
| Felt | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
$schema |
string |
Nej | JSON-skema URL til validering i editoren. |
directory |
string |
Ja | Relativ sti fra blocks.json, hvor blokke installeres. Må ikke være tom. |
registries |
Record<string, string | RegistryRef> |
Ja | Knytning fra navneområder til registerreferencer. Kan være tom. |
Formater for registerreferencer
Hver værdi i registries er enten en streng URL eller et objekt:
Streng: en gyldig URL til en registry.json-fil.
Objekt:
| Felt | Type | Påkrævet | Beskrivelse |
|---|---|---|---|
url |
string |
Ja | Gyldig URL til en registry.json-fil. |
headers |
Record<string, string> |
Nej | HTTP-headers, der sendes med hver anmodning til dette register. Værdier understøtter ${ENV_VAR}-interpolation. |
Valideringsregler
directoryskal være en ikke-tom streng.- Hver nøgle i
registriesskal være en ikke-tom streng. - Strengværdier for registre skal være gyldige URL’er.
- Registerværdier som objekter skal have et gyldigt
url-felt. ${ENV_VAR}-referencer i headers løses ved kørsel. Manglende variabler giver en fejl, der angiver variablen og headeren.registries-objektet kan være tomt.addafsluttes da medNo registries configured in blocks.json. Add a registry first.,listudskriverNo registries configured., ogsearchudskriverNo blocks matching "<query>".
Konfigurationssøgning
CLI søger efter blocks.json fra den aktuelle arbejdsmappe og går op gennem overmapperne, højst 20 niveauer. Den første blocks.json, der findes, bruges.