Premiers pas
Prérequis
- Node.js 18+
- Un thème ou une extension WordPress dans lequel installer les blocs
Le package blockstudio sur npm est en version 0.0.1. Cette version est provisoire : elle ne contient qu’une commande add, qui affiche Adding block: <name> puis se termine sans rien récupérer, et rejette init, list, search, remove, --yes et --dry-run comme inconnus. Les commandes de ces pages décrivent le registre CLI dans le dépôt Blockstudio (packages/registry).
Initialiser votre projet
Exécutez init à la racine de votre thème ou extension :
npx blockstudio init
CLI vous guide dans une configuration interactive :
- Répertoire des blocs : emplacement d’installation des blocs (par défaut :
blockstudio) - Registres : ajoutez un ou plusieurs URL de registre sous un nom
Cela crée un fichier blocks.json :
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
Vous pouvez également ignorer les invites interactives :
npx blockstudio init --yes
Cela crée un fichier blocks.json avec les valeurs par défaut. Vous pourrez le modifier manuellement par la suite.
Ajouter un bloc
npx blockstudio add ui/tabs
Le format est namespace/block, où namespace correspond à une clé de votre configuration registries.
CLI :
- Récupère le registre
- Trouve le bloc
- Résout les dépendances (e.g.
tabsdépend detab-item) - Télécharge tous les fichiers
- Les écrit dans votre répertoire de blocs
Si le bloc n’existe que dans un seul registre, vous pouvez omettre l’espace de noms :
npx blockstudio add tabs
S’il existe dans plusieurs registres, CLI vous demande de choisir dans un terminal. Sans terminal, la commande s’arrête avec une erreur qui répertorie les registres correspondants, et --yes sélectionne le premier selon l’ordre de blocks.json.
Ajouter plusieurs blocs
npx blockstudio add ui/tabs ui/hero ui/accordion
Tous les blocs sont installés en une seule exécution.
Afficher un aperçu avant l’installation
npx blockstudio add ui/tabs --dry-run
Affiche ce qui serait installé sans écrire de fichiers.
Parcourir les blocs disponibles
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
list affiche tous les blocs de tous les registres (ou d’un registre spécifique). search effectue une recherche de sous-chaîne sans distinction entre majuscules et minuscules dans les noms, titres et descriptions des blocs.
Supprimer un bloc
npx blockstudio remove tabs
Cette commande supprime le dossier du bloc. En mode interactif, une confirmation vous est demandée. Transmettez --yes pour ignorer l’invite.
CI et automatisation
init, add et remove acceptent --yes pour ignorer les invites interactives.
list et search ne demandent jamais de confirmation et rejettent --yes comme option inconnue.
Lorsque stdin n’est pas un terminal (exécuteurs CI, entrée redirigée), CLI passe en mode non interactif : init écrase un fichier blocks.json existant, add s’arrête avec une erreur si un dossier de bloc existe déjà ou si un nom de bloc est ambigu, et remove supprime sans demander.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes