blocks.json-Schema
Vollständiges 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}"
}
}
}
}
Felder
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
$schema |
string |
Nein | JSON-Schema URL zur Validierung im Editor. |
directory |
string |
Ja | Relativer Pfad ab blocks.json, unter dem Blöcke installiert werden. Darf nicht leer sein. |
registries |
Record<string, string | RegistryRef> |
Ja | Zuordnung von Namespace-Namen zu Registry-Referenzen. Darf leer sein. |
Formate für Registry-Referenzen
Jeder Wert in registries ist entweder eine Zeichenfolge URL oder ein Objekt:
Zeichenfolge: ein gültiges URL zu einer registry.json-Datei.
Objekt:
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
url |
string |
Ja | Gültiges URL zu einer registry.json-Datei. |
headers |
Record<string, string> |
Nein | HTTP-Header, die bei jeder Anfrage an diese Registry gesendet werden. Werte unterstützen die Interpolation von ${ENV_VAR}. |
Validierungsregeln
directorymuss eine nicht leere Zeichenfolge sein.- Jeder Schlüssel in
registriesmuss eine nicht leere Zeichenfolge sein. - Registry-Werte in Form von Zeichenfolgen müssen gültige URLs sein.
- Registry-Werte in Form von Objekten müssen ein gültiges Feld
urlenthalten. ${ENV_VAR}-Referenzen in Headern werden zur Laufzeit aufgelöst. Für fehlende Variablen wird ein Fehler ausgegeben, der die Variable und den Header nennt.- Das Objekt
registriesdarf leer sein. Dann wirdaddmitNo registries configured in blocks.json. Add a registry first.beendet,listgibtNo registries configured.aus undsearchgibtNo blocks matching "<query>".aus.
Konfiguration finden
Die CLI sucht ausgehend vom aktuellen Arbeitsverzeichnis nach blocks.json und durchläuft dabei bis zu 20 Ebenen übergeordneter Verzeichnisse. Die erste gefundene blocks.json wird verwendet.