registry.json séma
Teljes sé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"
]
}
]
}
Legfelső szintű mezők
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
$schema |
string |
Nem | JSON Schema URL a szerkesztői ellenőrzéshez. |
name |
string |
Igen | A nyilvántartás azonosítója. Nem lehet üres. |
description |
string |
Nem | A nyilvántartás rövid leírása. |
baseUrl |
string |
Igen | A blokkfájlok letöltéséhez használt alap-URL. Érvényes URL-nek kell lennie. |
blocks |
BlockEntry[] |
Igen | Az elérhető blokkok tömbje. Legalább egy elemet kell tartalmaznia. |
A blokkbejegyzés mezői
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
name |
string |
Igen | A blokk mappaneve és CLI azonosítója. Nem lehet üres. |
title |
string |
Nem | Ember által olvasható megjelenítési név. |
description |
string |
Nem | Egysoros leírás a keresési találatokhoz. |
category |
string |
Nem | Csoportosító címke a lista kimenetéhez. |
type |
"blockstudio" | "create-block" | "wordpress" |
Nem | Blokktípus. Csak tájékoztató jellegű, a CLI működésére nincs hatással. |
dependencies |
string[] |
Nem | Az ugyanabban a nyilvántartásban található azon blokkok nevei, amelyeket ezzel együtt kell telepíteni. |
files |
string[] |
Igen | A blokk mappájához viszonyított fájlútvonalak. Legalább egy fájl megadása kötelező. |
Fájlok feloldása
Minden fájl letöltési helye:
Kód
{baseUrl}/{block.name}/{file}
A fájlok ide kerülnek:
Kód
{directory}/{block.name}/{file}
A fájlútvonalakban szereplő alkönyvtárak automatikusan létrejönnek.
Érvényesítési szabályok
- A
nameértéke sem a nyilvántartás, sem a blokk szintjén nem lehet üres. - A
baseUrlértékének érvényes URL-nek kell lennie. - A
blockslegalább egy bejegyzést kell tartalmazzon. - Minden blokk
filesmezőjének legalább egy bejegyzést kell tartalmaznia. - A
typemezőnek, ha meg van adva, a három engedélyezett érték egyikének kell lennie. - A
dependenciesmezőnek, ha meg van adva, karakterláncok tömbjének kell lennie. Minden függőségnek szerepelnie kell ugyanabban a nyilvántartásban, különben a CLI hibaüzenetet ad feloldáskor.