Preskočiť na obsah

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

Polia

Pole Typ Povinné Opis
$schema string Nie Schéma JSON URL na overovanie v editore.
directory string Áno Relatívna cesta od blocks.json, kam sa inštalujú bloky. Nesmie byť prázdna.
registries Record<string, string | RegistryRef> Áno Mapa názvov priestorov názvov na odkazy na registre. Môže byť prázdna.

Formáty odkazov na registre

Každá hodnota v registries je buď reťazec URL, alebo objekt:

Reťazec: platná adresa URL na súbor registry.json.

Objekt:

Pole Typ Povinné Opis
url string Áno Platná adresa URL na súbor registry.json.
headers Record<string, string> Nie Hlavičky HTTP odosielané pri každej požiadavke do tohto registra. Hodnoty podporujú interpoláciu ${ENV_VAR}.

Pravidlá overovania

  • directory musí byť neprázdny reťazec.
  • Každý kľúč v registries musí byť neprázdny reťazec.
  • Hodnoty reťazcov registra musia byť platné adresy URL.
  • Hodnoty objektov registra musia obsahovať platné pole url.
  • Odkazy ${ENV_VAR} v hlavičkách sa rozlíšia počas behu. Chýbajúce premenné vyvolajú chybu s názvom premennej a hlavičky.
  • Objekt registries môže byť prázdny. add potom skončí s kódom No registries configured in blocks.json. Add a registry first., list vypíše No registries configured. a search vypíše No blocks matching "<query>".

Vyhľadávanie konfigurácie

CLI hľadá blocks.json od aktuálneho pracovného adresára smerom nahor cez nadradené adresáre, najviac do hĺbky 20 úrovní. Použije sa prvý nájdený súbor blocks.json.