Schema van blocks.json
Volledig schema
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}"
}
}
}
}
Velden
| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
$schema |
string |
Nee | JSON-schema URL voor validatie in de editor. |
directory |
string |
Ja | Relatief pad vanaf blocks.json waar blokken worden geïnstalleerd. Mag niet leeg zijn. |
registries |
Record<string, string | RegistryRef> |
Ja | Toewijzing van namespacenamen aan registerverwijzingen. Mag leeg zijn. |
Indelingen voor registerverwijzingen
Elke waarde in registries is een tekenreeks URL of een object:
Tekenreeks: een geldige URL naar een registry.json-bestand.
Object:
| Veld | Type | Vereist | Beschrijving |
|---|---|---|---|
url |
string |
Ja | Geldige URL naar een registry.json-bestand. |
headers |
Record<string, string> |
Nee | HTTP-headers die bij elk verzoek aan dit register worden meegestuurd. Waarden ondersteunen interpolatie van ${ENV_VAR}. |
Validatieregels
directorymoet een niet-lege tekenreeks zijn.- Elke sleutel in
registriesmoet een niet-lege tekenreeks zijn. - Registerwaarden als tekenreeks moeten geldige URL’s zijn.
- Registerwaarden als object moeten een geldig veld
urlbevatten. - Verwijzingen naar
${ENV_VAR}in headers worden tijdens runtime opgelost. Ontbrekende variabelen veroorzaken een fout met de naam van de variabele en header. - Het object
registriesmag leeg zijn.addwordt dan afgesloten metNo registries configured in blocks.json. Add a registry first.,listtoontNo registries configured.ensearchtoontNo blocks matching "<query>".
Configuratie zoeken
De CLI zoekt vanaf de huidige werkmap naar blocks.json en doorzoekt daarbij bovenliggende mappen tot maximaal 20 niveaus omhoog. Het eerste gevonden blocks.json wordt gebruikt.