Schéma
Pour faciliter le développement grâce à la saisie semi-automatique et à la validation dans votre IDE, Blockstudio propose son propre schéma :
Le schéma Blockstudio est une copie (toujours à jour) du schéma WordPress block.json, à laquelle s’ajoute une propriété blockstudio qui regroupe toutes les fonctionnalités du plugin, comme les schémas de champs, sans interférer avec d’éventuelles propriétés natives futures.
Ajouter à JSON
Ajoutez simplement une clé $schema avec la valeur https://blockstudio.dev/schema/block à votre block.json ; votre IDE devrait alors vous proposer des suggestions pour les propriétés spécifiques à Blockstudio.
{
"$schema": "https://blockstudio.dev/schema/block",
"name": "blockstudio/native",
"title": "Native Block",
"category": "text",
"icon": "star-filled",
"description": "Native Blockstudio block.",
"blockstudio": true
}
Prise en charge des IDE
VS Code
VS Code détecte automatiquement le schéma à partir de la propriété $schema.
Pour appliquer les paramètres à tout l’espace de travail, ajoutez-les à .vscode/settings.json :
{
"json.schemas": [
{
"fileMatch": ["**/block.json"],
"url": "https://blockstudio.dev/schema/block"
}
]
}
IDE de JetBrains
PhpStorm et les autres IDE JetBrains prennent automatiquement en charge le schéma JSON via la propriété $schema.
Schémas disponibles
| Schéma | URL |
|---|---|
| Schéma de bloc | https://blockstudio.dev/schema/block |
| Schéma d’extension | https://blockstudio.dev/schema/extend |
Avantages
- Saisie semi-automatique : obtenez des suggestions pour toutes les propriétés disponibles
- Validation : détectez les erreurs avant l’exécution
- Documentation : survolez les propriétés pour afficher leur documentation
- Sécurité des types : vérifiez que les valeurs sont du bon type