blocks.json schema
Visa 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}"
}
}
}
}
Laukai
| Laukas | Tipas | Privalomas | Aprašas |
|---|---|---|---|
$schema |
string |
Ne | JSON schema URL redaktoriaus tikrinimui. |
directory |
string |
Taip | Santykinis kelias nuo blocks.json, į kurį įdiegiami blokai. Negali būti tuščias. |
registries |
Record<string, string | RegistryRef> |
Taip | Vardų sričių pavadinimų ir registro nuorodų susiejimas. Gali būti tuščias. |
Registro nuorodų formatai
Kiekviena registries reikšmė yra arba eilutė URL, arba objektas:
Eilutė: tinkamas URL į registry.json failą.
Objektas:
| Laukas | Tipas | Privalomas | Aprašas |
|---|---|---|---|
url |
string |
Taip | Tinkamas URL į registry.json failą. |
headers |
Record<string, string> |
Ne | HTTP antraštės, siunčiamos su kiekviena užklausa šiam registrui. Reikšmėse galima naudoti ${ENV_VAR} interpoliaciją. |
Tikrinimo taisyklės
directoryturi būti netuščia eilutė.- Kiekvienas
registriesraktas turi būti netuščia eilutė. - Registro reikšmės eilutėmis turi būti tinkami URL adresai.
- Registro reikšmės objektais turi turėti tinkamą
urllauką. ${ENV_VAR}nuorodos antraštėse išsprendžiamos vykdymo metu. Jei kintamojo nėra, pateikiama klaida, nurodanti kintamąjį ir antraštę.registriesobjektas gali būti tuščias. Tokiu atvejuaddbaigiasi suNo registries configured in blocks.json. Add a registry first.,listišvedaNo registries configured., osearchišvedaNo blocks matching "<query>".
Konfigūracijos paieška
CLI ieško blocks.json nuo dabartinio darbinio katalogo, kildamas aukštyn per pirminius katalogus iki 20 lygių. Naudojamas pirmasis rastas blocks.json.