Schéma registry.json
Úplné schéma
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"
]
}
]
}
Pole nejvyšší úrovně
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
$schema |
string |
Ne | Schéma JSON URL pro ověřování v editoru. |
name |
string |
Ano | Identifikátor registru. Nesmí být prázdný. |
description |
string |
Ne | Stručný popis registru. |
baseUrl |
string |
Ano | Základní adresa URL pro stahování souborů bloků. Musí jít o platnou adresu URL. |
blocks |
BlockEntry[] |
Ano | Pole dostupných bloků. Musí obsahovat alespoň jednu položku. |
Pole položky bloku
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
name |
string |
Ano | Název složky bloku a identifikátor CLI. Nesmí být prázdný. |
title |
string |
Ne | Čitelný zobrazovaný název. |
description |
string |
Ne | Jednořádkový popis ve výsledcích vyhledávání. |
category |
string |
Ne | Označení skupiny ve výpisu. |
type |
"blockstudio" | "create-block" | "wordpress" |
Ne | Typ bloku. Slouží pouze pro informaci a neovlivňuje chování CLI. |
dependencies |
string[] |
Ne | Názvy bloků ve stejném registru, které se musí instalovat společně s tímto blokem. |
files |
string[] |
Ano | Cesty k souborům relativní ke složce bloku. Je vyžadován alespoň jeden soubor. |
Vyhledání souborů
Každý soubor se stáhne z adresy:
Kód
{baseUrl}/{block.name}/{file}
A zapíše do:
Kód
{directory}/{block.name}/{file}
Podadresáře uvedené v cestách k souborům se vytvoří automaticky.
Pravidla ověřování
namenesmí být prázdné na úrovni registru ani bloku.baseUrlmusí být platný URL.blocksmusí obsahovat alespoň jednu položku.fileskaždého bloku musí obsahovat alespoň jednu položku.- Je-li zadáno
type, musí odpovídat jedné ze tří povolených hodnot. - Je-li zadáno
dependencies, musí jít o pole řetězců. Každá závislost musí existovat ve stejném registru, jinak CLI při řešení závislostí skončí chybou.