Preskoči na vsebino

Shema blocks.json

Celotna shema

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}"
      }
    }
  }
}

Polja

Polje Vrsta Obvezno Opis
$schema string Ne Shema JSON URL za preverjanje v urejevalniku.
directory string Da Relativna pot od blocks.json, kamor se namestijo bloki. Ne sme biti prazna.
registries Record<string, string | RegistryRef> Da Preslikava imen imenskih prostorov na sklice registrov. Lahko je prazna.

Oblike sklicev na registre

Vsaka vrednost v registries je bodisi niz URL bodisi objekt:

Niz: veljaven URL do datoteke registry.json.

Objekt:

Polje Vrsta Obvezno Opis
url string Da Veljaven URL do datoteke registry.json.
headers Record<string, string> Ne Glave HTTP, poslane ob vsaki zahtevi temu registru. Vrednosti podpirajo interpolacijo ${ENV_VAR}.

Pravila preverjanja

  • directory mora biti neprazen niz.
  • Vsak ključ v registries mora biti neprazen niz.
  • Vrednosti registrov v obliki nizov morajo biti veljavni URL-ji.
  • Vrednosti registrov v obliki objektov morajo imeti veljavno polje url.
  • Sklici ${ENV_VAR} v glavah se razrešijo med izvajanjem. Manjkajoče spremenljivke povzročijo napako, ki navede spremenljivko in glavo.
  • Objekt registries je lahko prazen. V tem primeru se add konča z No registries configured in blocks.json. Add a registry first., list izpiše No registries configured., search pa izpiše No blocks matching "<query>"..

Iskanje konfiguracije

CLI išče blocks.json od trenutnega delovnega imenika navzgor po nadrejenih imenikih, do 20 ravni. Uporabi prvo najdeno datoteko blocks.json.