Vai al contenuto

Schema blocks.json

Schema completo

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

Campi

Campo Tipo Obbligatorio Descrizione
$schema string No Schema JSON URL per la convalida nell’editor.
directory string Sì Percorso relativo a blocks.json in cui vengono installati i blocchi. Non può essere vuoto.
registries Record<string, string | RegistryRef> Sì Mappa dei nomi degli spazi dei nomi ai riferimenti dei registri. Può essere vuota.

Formati dei riferimenti ai registri

Ogni valore in registries è una stringa URL oppure un oggetto:

Stringa: un URL valido per un file registry.json.

Oggetto:

Campo Tipo Obbligatorio Descrizione
url string Sì URL valido per un file registry.json.
headers Record<string, string> No Intestazioni HTTP inviate con ogni richiesta a questo registro. I valori supportano l’interpolazione ${ENV_VAR}.

Regole di convalida

  • directory deve essere una stringa non vuota.
  • Ogni chiave in registries deve essere una stringa non vuota.
  • I valori stringa del registro devono essere URL validi.
  • I valori oggetto del registro devono avere un campo url valido.
  • I riferimenti ${ENV_VAR} nelle intestazioni vengono risolti in fase di esecuzione. Le variabili mancanti generano un errore che indica il nome della variabile e dell’intestazione.
  • L’oggetto registries può essere vuoto. In tal caso, add esce con No registries configured in blocks.json. Add a registry first., list stampa No registries configured. e search stampa No blocks matching "<query>".

Individuazione della configurazione

Il CLI cerca blocks.json a partire dalla directory di lavoro corrente e risale le directory genitrici fino a un massimo di 20 livelli. Viene usato il primo blocks.json trovato.