blocks.json
blocks.json je v korenski mapi vaše teme ali vtičnika. CLI pove, kam namestiti bloke in po katerih registrih iskati.
Shema
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json",
"starter": "https://raw.githubusercontent.com/acme/blocks/main/registry.json"
}
}
Polja
$schema
Izbirno. Kaže na shemo JSON za samodokončanje in preverjanje v urejevalniku.
directory
Obvezno. Relativna pot od blocks.json, kamor se namestijo bloki.
Vsak blok dobi svojo podmapo v tem imeniku. Če je directory nastavljen na blockstudio in dodate hero, se datoteke shranijo v blockstudio/hero/.
registries
Obvezno. Objekt, ki imena imenskih prostorov povezuje z referencami registrov.
Ključ je imenski prostor, ki se uporablja v ukazih CLI (npx blockstudio add ui/hero). Vrednost je lahko niz URL ali objekt s poljema url in headers, ki je izbirno.
Oblika niza (javni registri):
{
"registries": {
"ui": "https://example.com/registry.json"
}
}
Oblika objekta (registri z avtentikacijo):
{
"registries": {
"private": {
"url": "https://private.example.com/registry.json",
"headers": {
"Authorization": "Bearer ${REGISTRY_TOKEN}"
}
}
}
}
V isti konfiguraciji lahko kombinirate obe obliki. Nastavite lahko poljubno število registrov. Ko dodate blok brez imenskega prostora, CLI išče po vseh.
Avtentikacija
Registri, ki zahtevajo avtentikacijo, uporabljajo obliko objekta s poljem headers. CLI te glave pošlje ob vsaki zahtevi do registra, tako pri pridobivanju registry.json kot pri prenosu posameznih datotek.
Žeton Bearer
{
"registries": {
"private": {
"url": "https://api.example.com/registry.json",
"headers": {
"Authorization": "Bearer ${REGISTRY_TOKEN}"
}
}
}
}
Osnovna avtentikacija
{
"registries": {
"private": {
"url": "https://api.example.com/registry.json",
"headers": {
"Authorization": "Basic ${REGISTRY_CREDENTIALS}"
}
}
}
}
Glave po meri
Dodate lahko katero koli glavo. To je uporabno za ključe API, identifikatorje organizacije ali karkoli drugega, kar pričakuje strežnik registra:
{
"registries": {
"internal": {
"url": "https://blocks.internal.company.com/registry.json",
"headers": {
"X-API-Key": "${BLOCKS_API_KEY}",
"X-Org-ID": "acme"
}
}
}
}
Spremenljivke okolja
Vrednosti glav podpirajo sintakso ${VAR_NAME} za branje spremenljivk okolja. Tako žetoni ne pridejo v nadzor različic.
CLI razreši spremenljivke okolja med izvajanjem. Če navedena spremenljivka ni nastavljena, se CLI konča z napako, ki navede manjkajočo spremenljivko in glavo, v kateri je bila uporabljena.
Spremenljivko nastavite v lupini ali okolju CI. CLI bere samo okolje procesa; datotek .env ne naloži sam:
export REGISTRY_TOKEN=ghp_abc123
npx blockstudio add private/hero
Statične vrednosti glav (brez ${...}) se posredujejo nespremenjene.
Iskanje konfiguracije
CLI se iz trenutnega delovnega imenika pomika navzgor in išče datoteko blocks.json. Tako lahko ukaze zaženete iz katere koli podmape projekta.
my-theme/
blocks.json <- found here
blockstudio/
hero/
templates/
page.php <- running `npx blockstudio add` here still works
Če datoteka blocks.json ni najdena, vas CLI pozove, da zaženete npx blockstudio init.
Primer: tema z dvema registroma
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.mycompany.com/ui/registry.json",
"internal": "https://blocks.mycompany.com/internal/registry.json"
}
}
Primer: vtičnik z imenikom po meri
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "src/blocks",
"registries": {
"starter": "https://raw.githubusercontent.com/acme/blocks/main/registry.json"
}
}