Schéma registry.json
Schéma complet
JSON
{
"$schema": "https://blockstudio.dev/schema/registry.json",
"name": "my-registry",
"description": "A collection of WordPress blocks.",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"description": "Full-width hero section with heading and CTA.",
"category": "layout",
"type": "blockstudio",
"dependencies": ["button"],
"files": [
"block.json",
"index.php",
"style.scss"
]
}
]
}
Champs de premier niveau
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
$schema |
string |
Non | Schéma JSON URL pour la validation de l’éditeur. |
name |
string |
Oui | Identifiant du registre. Ne doit pas être vide. |
description |
string |
Non | Brève description du registre. |
baseUrl |
string |
Oui | URL de base pour télécharger les fichiers de bloc. Doit être un URL valide. |
blocks |
BlockEntry[] |
Oui | Tableau des blocs disponibles. Doit contenir au moins une entrée. |
Champs d’entrée de bloc
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name |
string |
Oui | Nom du dossier de bloc et identifiant CLI. Ne doit pas être vide. |
title |
string |
Non | Nom d’affichage lisible. |
description |
string |
Non | Description sur une ligne pour les résultats de recherche. |
category |
string |
Non | Libellé de regroupement pour l’affichage en liste. |
type |
"blockstudio" | "create-block" | "wordpress" |
Non | Type de bloc. À titre informatif uniquement, sans effet sur le comportement de CLI. |
dependencies |
string[] |
Non | Noms des blocs du même registre qui doivent être installés avec celui-ci. |
files |
string[] |
Oui | Chemins des fichiers relatifs au dossier du bloc. Au moins un fichier est requis. |
Résolution des fichiers
Chaque fichier est téléchargé depuis :
Code
{baseUrl}/{block.name}/{file}
Et écrit dans :
Code
{directory}/{block.name}/{file}
Les sous-répertoires des chemins de fichiers sont créés automatiquement.
Règles de validation
namene doit pas être vide, tant au niveau du registre que du bloc.baseUrldoit être un URL valide.blocksdoit contenir au moins une entrée.- La valeur
filesde chaque bloc doit contenir au moins une entrée. - Si
typeest fourni, il doit correspondre à l’une des trois valeurs autorisées. - Si
dependenciesest fourni, il doit s’agir d’un tableau de chaînes. Chaque dépendance doit exister dans le même registre, sinon le CLI échouera lors de la résolution.