Treci la conținut

Schema blocks.json

Schema completă

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

Câmpuri

Câmp Tip Obligatoriu Descriere
$schema string Nu JSON Schema URL pentru validarea în editor.
directory string Da Calea relativă din blocks.json unde sunt instalate blocurile. Nu poate fi goală.
registries Record<string, string | RegistryRef> Da Hartă de la numele spațiilor de nume la referințele registrelor. Poate fi goală.

Formatele referințelor la registre

Fiecare valoare din registries este fie un șir URL, fie un obiect:

Șir: un URL valid către un fișier registry.json.

Obiect:

Câmp Tip Obligatoriu Descriere
url string Da URL valid către un fișier registry.json.
headers Record<string, string> Nu Antete HTTP trimise cu fiecare cerere către acest registru. Valorile acceptă interpolarea ${ENV_VAR}.

Reguli de validare

  • directory trebuie să fie un șir nevid.
  • Fiecare cheie din registries trebuie să fie un șir nevid.
  • Valorile de registru de tip șir trebuie să fie URL-uri valide.
  • Valorile de registru de tip obiect trebuie să aibă un câmp url valid.
  • Referințele ${ENV_VAR} din antete sunt rezolvate în timpul execuției. Variabilele lipsă generează o eroare care indică variabila și antetul.
  • Obiectul registries poate fi gol. În acest caz, add se încheie cu No registries configured in blocks.json. Add a registry first., list afișează No registries configured., iar search afișează No blocks matching "<query>".

Descoperirea configurației

CLI caută blocks.json pornind din directorul curent de lucru și urcă prin directoarele părinte până la 20 de niveluri. Este folosit primul blocks.json găsit.