blocks.json-skeema
Täysi skeema
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}"
}
}
}
}
Kentät
| Kenttä | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
$schema |
string |
Ei | JSON-skeema URL editorin validointia varten. |
directory |
string |
Kyllä | Suhteellinen polku kohteesta blocks.json, johon lohkot asennetaan. Ei saa olla tyhjä. |
registries |
Record<string, string | RegistryRef> |
Kyllä | Nimiavaruuksien nimien ja rekisteriviittausten kartta. Voi olla tyhjä. |
Rekisteriviittausten muodot
Kukin registriesn arvo on joko merkkijono URL tai objekti:
Merkkijono: kelvollinen URL-osoite registry.json-tiedostoon.
Objekti:
| Kenttä | Tyyppi | Pakollinen | Kuvaus |
|---|---|---|---|
url |
string |
Kyllä | Kelvollinen URL-osoite registry.json-tiedostoon. |
headers |
Record<string, string> |
Ei | HTTP-otsakkeet, jotka lähetetään jokaisen tähän rekisteriin kohdistuvan pyynnön yhteydessä. Arvot tukevat ${ENV_VAR}-interpolointia. |
Validointisäännöt
directoryn on oltava ei-tyhjä merkkijono.- Jokaisen kohdan
registriesavaimen on oltava ei-tyhjä merkkijono. - Merkkijonomuotoisten rekisteriarvojen on oltava kelvollisia URL-osoitteita.
- Objektimuotoisilla rekisteriarvoilla on oltava kelvollinen
url-kenttä. - Otsakkeissa olevat
${ENV_VAR}-viittaukset ratkaistaan suorituksen aikana. Puuttuva muuttuja aiheuttaa virheen, jossa mainitaan muuttujan ja otsakkeen nimi. registries-objekti voi olla tyhjä. Tällöinaddpäättyy koodiinNo registries configured in blocks.json. Add a registry first.,listtulostaaNo registries configured.jasearchtulostaaNo blocks matching "<query>".
Asetustiedoston etsiminen
CLI etsii hakemistosta blocks.json alkaen nykyisestä työhakemistosta ja siirtyy ylöspäin enintään 20 emohakemiston verran. Ensimmäistä löytyvää tiedostoa blocks.json käytetään.