registry.json-Schema
Vollständiges Schema
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"
]
}
]
}
Felder der obersten Ebene
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
$schema |
string |
Nein | JSON-Schema URL zur Validierung im Editor. |
name |
string |
Ja | Registry-Kennung. Darf nicht leer sein. |
description |
string |
Nein | Kurzbeschreibung der Registry. |
baseUrl |
string |
Ja | Basis-URL zum Herunterladen von Blockdateien. Muss eine gültige URL sein. |
blocks |
BlockEntry[] |
Ja | Array verfügbarer Blöcke. Muss mindestens einen Eintrag enthalten. |
Felder eines Blockeintrags
| Feld | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
name |
string |
Ja | Name des Blockordners und Kennung CLI. Darf nicht leer sein. |
title |
string |
Nein | Lesbarer Anzeigename. |
description |
string |
Nein | Einzeilige Beschreibung für Suchergebnisse. |
category |
string |
Nein | Gruppierungsbezeichnung für die Listenausgabe. |
type |
"blockstudio" | "create-block" | "wordpress" |
Nein | Blocktyp. Dient nur zur Information und beeinflusst das Verhalten von CLI nicht. |
dependencies |
string[] |
Nein | Namen von Blöcken in derselben Registry, die zusammen mit diesem Block installiert werden müssen. |
files |
string[] |
Ja | Dateipfade relativ zum Blockordner. Mindestens eine Datei ist erforderlich. |
Dateien auflösen
Jede Datei wird hier abgerufen:
Code
{baseUrl}/{block.name}/{file}
Und hier gespeichert:
Code
{directory}/{block.name}/{file}
Unterverzeichnisse in Dateipfaden werden automatisch erstellt.
Validierungsregeln
namemuss sowohl auf Registry- als auch auf Blockebene nicht leer sein.baseUrlmuss eine gültige URL sein.blocksmuss mindestens einen Eintrag enthalten.filesjedes Blocks muss mindestens einen Eintrag enthalten.typemuss, falls angegeben, einem der drei zulässigen Werte entsprechen.dependenciesmuss, falls angegeben, ein Array aus Zeichenfolgen sein. Jede Abhängigkeit muss in derselben Registry vorhanden sein, andernfalls gibt CLI beim Auflösen einen Fehler aus.