Přejít k obsahu

Schéma blocks.json

Úplné schéma

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

Pole

Pole Typ Povinné Popis
$schema string Ne Schéma JSON URL pro ověřování v editoru.
directory string Ano Relativní cesta od blocks.json, kam se instalují bloky. Nesmí být prázdná.
registries Record<string, string | RegistryRef> Ano Mapování názvů jmenných prostorů na odkazy na registry. Může být prázdné.

Formáty odkazů na registry

Každá hodnota v registries je buď řetězec URL, nebo objekt:

Řetězec: platná adresa URL k souboru registry.json.

Objekt:

Pole Typ Povinné Popis
url string Ano Platná adresa URL k souboru registry.json.
headers Record<string, string> Ne Hlavičky HTTP odesílané s každým požadavkem do tohoto registru. Hodnoty podporují interpolaci ${ENV_VAR}.

Pravidla ověřování

  • directory musí být neprázdný řetězec.
  • Každý klíč v registries musí být neprázdný řetězec.
  • Hodnoty registru ve formě řetězce musí být platné adresy URL.
  • Hodnoty registru ve formě objektu musí obsahovat platné pole url.
  • Odkazy ${ENV_VAR} v hlavičkách se vyhodnocují za běhu. Chybějící proměnné vyvolají chybu, která uvede název proměnné i hlavičky.
  • Objekt registries může být prázdný. V takovém případě add skončí s No registries configured in blocks.json. Add a registry first., list vypíše No registries configured. a search vypíše No blocks matching "<query>".

Vyhledání konfigurace

CLI hledá blocks.json od aktuálního pracovního adresáře směrem nahoru přes nadřazené adresáře, a to až do 20 úrovní. Použije se první nalezený blocks.json.