Shema registry.json
Celotna shema
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"
]
}
]
}
Polja na najvišji ravni
| Polje | Vrsta | Obvezno | Opis |
|---|---|---|---|
$schema |
string |
Ne | Shema JSON URL za preverjanje v urejevalniku. |
name |
string |
Da | Identifikator registra. Ne sme biti prazen. |
description |
string |
Ne | Kratek opis registra. |
baseUrl |
string |
Da | Osnovni URL za prenos datotek blokov. Mora biti veljaven URL. |
blocks |
BlockEntry[] |
Da | Seznam razpoložljivih blokov. Vsebovati mora vsaj en vnos. |
Polja vnosa bloka
| Polje | Vrsta | Obvezno | Opis |
|---|---|---|---|
name |
string |
Da | Ime mape bloka in identifikator CLI. Ne sme biti prazno. |
title |
string |
Ne | Berljivo prikazno ime. |
description |
string |
Ne | Enovrstični opis za rezultate iskanja. |
category |
string |
Ne | Oznaka skupine v izpisu seznama. |
type |
"blockstudio" | "create-block" | "wordpress" |
Ne | Vrsta bloka. Podatek je zgolj informativen in ne vpliva na delovanje CLI. |
dependencies |
string[] |
Ne | Imena blokov v istem registru, ki jih je treba namestiti skupaj s tem blokom. |
files |
string[] |
Da | Poti datotek glede na mapo bloka. Zahtevana je vsaj ena datoteka. |
Razreševanje poti datotek
Vsaka datoteka se prenese iz:
Koda
{baseUrl}/{block.name}/{file}
In zapiše v:
Koda
{directory}/{block.name}/{file}
Podimeniki na poteh datotek se ustvarijo samodejno.
Pravila preverjanja
namene sme biti prazen niti na ravni registra niti na ravni bloka.baseUrlmora biti veljaven URL.blocksmora vsebovati vsaj en vnos.filesvsakega bloka mora vsebovati vsaj en vnos.- Če je naveden
type, mora biti ena od treh dovoljenih vrednosti. - Če je naveden
dependencies, mora biti seznam nizov. Vsaka odvisnost mora obstajati v istem registru, sicer bo CLI med razreševanjem javil napako.