Liigu sisu juurde

blocks.json skeem

Täielik skeem

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

Väljad

Väli Tüüp Kohustuslik Kirjeldus
$schema string Ei JSON skeem URL redaktoris valideerimiseks.
directory string Jah Suhteline tee asukohast blocks.json, kuhu plokid installitakse. Ei tohi olla tühi.
registries Record<string, string | RegistryRef> Jah Nimeruumide nimede ja registriviidete vastendus. Võib olla tühi.

Registriviite vormingud

Iga registries väärtus on kas string URL või objekt:

String: kehtiv URL, mis viitab failile registry.json.

Objekt:

Väli Tüüp Kohustuslik Kirjeldus
url string Jah Kehtiv URL failile registry.json.
headers Record<string, string> Ei HTTP päised, mis saadetakse iga päringuga sellesse registrisse. Väärtused toetavad ${ENV_VAR} asendamist.

Valideerimisreeglid

  • directory peab olema mittetühi string.
  • Iga registries võti peab olema mittetühi string.
  • Registri stringväärtused peavad olema kehtivad URL-id.
  • Registri objektväärtustel peab olema kehtiv väli url.
  • Päistes olevad viited ${ENV_VAR} lahendatakse käitusajal. Puuduvate muutujate korral kuvatakse viga, kus nimetatakse muutujat ja päist.
  • Objekt registries võib olla tühi. Sel juhul lõpetab add koodiga No registries configured in blocks.json. Add a registry first., list väljastab No registries configured. ja search väljastab No blocks matching "<query>"..

Konfiguratsiooni leidmine

CLI otsib faili blocks.json alates praegusest töökataloogist, liikudes kuni 20 taset mööda ülemkatalooge üles. Kasutatakse esimest leitud faili blocks.json.