Schema registry.json
Schema 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"
]
}
]
}
Câmpuri de nivel superior
| Câmp | Tip | Obligatoriu | Descriere |
|---|---|---|---|
$schema |
string |
Nu | JSON Schema URL pentru validarea în editor. |
name |
string |
Da | Identificatorul registrului. Nu poate fi gol. |
description |
string |
Nu | Descriere scurtă a registrului. |
baseUrl |
string |
Da | URL de bază pentru descărcarea fișierelor blocurilor. Trebuie să fie un URL valid. |
blocks |
BlockEntry[] |
Da | Tabloul blocurilor disponibile. Trebuie să conțină cel puțin o intrare. |
Câmpurile unei intrări de bloc
| Câmp | Tip | Obligatoriu | Descriere |
|---|---|---|---|
name |
string |
Da | Numele dosarului blocului și identificatorul CLI. Nu poate fi gol. |
title |
string |
Nu | Nume de afișare ușor de înțeles. |
description |
string |
Nu | Descriere de o linie pentru rezultatele căutării. |
category |
string |
Nu | Etichetă de grupare pentru rezultatele listei. |
type |
"blockstudio" | "create-block" | "wordpress" |
Nu | Tipul blocului. Are doar rol informativ și nu afectează comportamentul CLI. |
dependencies |
string[] |
Nu | Numele blocurilor din același registru care trebuie instalate împreună cu acesta. |
files |
string[] |
Da | Căi de fișiere relative la dosarul blocului. Este necesar cel puțin un fișier. |
Rezolvarea căilor fișierelor
Fiecare fișier este descărcat din:
Cod
{baseUrl}/{block.name}/{file}
Și scris în:
Cod
{directory}/{block.name}/{file}
Subdirectoarele din căile fișierelor sunt create automat.
Reguli de validare
nametrebuie să fie nevid atât la nivelul registrului, cât și la nivelul blocului.baseUrltrebuie să fie un URL valid.blockstrebuie să conțină cel puțin o intrare.filesfiecărui bloc trebuie să conțină cel puțin o intrare.- Dacă este specificat,
typetrebuie să fie una dintre cele trei valori permise. - Dacă este specificat,
dependenciestrebuie să fie un tablou de șiruri. Fiecare dependență trebuie să existe în același registru, altfel CLI va genera o eroare la rezolvare.