Pāriet uz saturu

blocks.json shēma

Pilnā shē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}"
      }
    }
  }
}

Lauki

Lauks Tips Obligāts Apraksts
$schema string Nē JSON Schema URL redaktora validācijai.
directory string Jā Relatīvais ceļš no blocks.json, kurā tiek instalēti bloki. Nedrīkst būt tukšs.
registries Record<string, string | RegistryRef> Jā Nosaukumvietu nosaukumu un reģistra atsauču kartējums. Var būt tukšs.

Reģistra atsauču formāti

Katra vērtība laukā registries ir vai nu virkne URL, vai objekts:

Virkne: derīgs URL uz registry.json failu.

Objekts:

Lauks Tips Obligāts Apraksts
url string Jā Derīgs URL uz registry.json failu.
headers Record<string, string> Nē HTTP galvenes, kas tiek nosūtītas katrā pieprasījumā šim reģistram. Vērtībās tiek atbalstīta ${ENV_VAR} interpolācija.

Validācijas noteikumi

  • directory jābūt netukšai virknei.
  • Katrai atslēgai laukā registries jābūt netukšai virknei.
  • Reģistra vērtībām virknes formā jābūt derīgiem URL.
  • Reģistra vērtību objektiem jābūt derīgam laukam url.
  • ${ENV_VAR} atsauces galvenēs tiek atrisinātas izpildlaikā. Ja mainīgā trūkst, tiek parādīta kļūda ar mainīgā un galvenes nosaukumu.
  • Objekts registries var būt tukšs. Tādā gadījumā add iziet ar No registries configured in blocks.json. Add a registry first., list izvada No registries configured., bet search izvada No blocks matching "<query>".

Konfigurācijas atrašana

CLI meklē blocks.json, sākot no pašreizējā darba direktorija un virzoties augšup pa vecākelementu direktorijiem līdz 20 līmeņiem. Tiek izmantots pirmais atrastais blocks.json.