Aller au contenu

Schéma blocks.json

Schéma 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}"
      }
    }
  }
}

Champs

Champ Type Obligatoire Description
$schema string Non Schéma JSON URL pour la validation de l’éditeur.
directory string Oui Chemin relatif depuis blocks.json où les blocs sont installés. Ne doit pas être vide.
registries Record<string, string | RegistryRef> Oui Correspondance entre les noms d’espaces de noms et les références de registre. Peut être vide.

Formats des références de registre

Chaque valeur de registries est soit une chaîne URL, soit un objet :

Chaîne : un URL valide vers un fichier registry.json.

Objet :

Champ Type Obligatoire Description
url string Oui URL valide vers un fichier registry.json.
headers Record<string, string> Non En-têtes HTTP envoyés avec chaque requête à ce registre. Les valeurs acceptent l’interpolation ${ENV_VAR}.

Règles de validation

  • directory doit être une chaîne non vide.
  • Chaque clé de registries doit être une chaîne non vide.
  • Les valeurs de registre sous forme de chaîne doivent être des URL valides.
  • Les valeurs de registre sous forme d’objet doivent comporter un champ url valide.
  • Les références ${ENV_VAR} dans les en-têtes sont résolues à l’exécution. Les variables manquantes entraînent une erreur qui indique leur nom et l’en-tête concerné.
  • L’objet registries peut être vide. add se termine alors avec No registries configured in blocks.json. Add a registry first., list affiche No registries configured., et search affiche No blocks matching "<query>".

Découverte de la configuration

Le CLI recherche blocks.json à partir du répertoire de travail courant, en remontant les répertoires parents sur 20 niveaux au maximum. Le premier blocks.json trouvé est utilisé.