registry.json schema
Visa 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"
]
}
]
}
Aukščiausio lygio laukai
| Laukas | Tipas | Privalomas | Aprašas |
|---|---|---|---|
$schema |
string |
Ne | JSON schema URL redaktoriaus tikrinimui. |
name |
string |
Taip | Registro identifikatorius. Negali būti tuščias. |
description |
string |
Ne | Trumpas registro aprašas. |
baseUrl |
string |
Taip | Bazinis URL blokų failams atsisiųsti. Turi būti tinkamas URL. |
blocks |
BlockEntry[] |
Taip | Galimų blokų masyvas. Jame turi būti bent vienas įrašas. |
Blokų įrašų laukai
| Laukas | Tipas | Privalomas | Aprašas |
|---|---|---|---|
name |
string |
Taip | Bloko aplanko pavadinimas ir CLI identifikatorius. Negali būti tušti. |
title |
string |
Ne | Žmogui suprantamas rodomas pavadinimas. |
description |
string |
Ne | Vienos eilutės aprašas paieškos rezultatams. |
category |
string |
Ne | Grupavimo žyma sąrašo išvesčiai. |
type |
"blockstudio" | "create-block" | "wordpress" |
Ne | Bloko tipas. Tik informacinis, nekeičia CLI veikimo. |
dependencies |
string[] |
Ne | To paties registro blokų pavadinimai, kuriuos reikia įdiegti kartu su šiuo bloku. |
files |
string[] |
Taip | Failų keliai, santykiniai bloko aplanko atžvilgiu. Reikia bent vieno failo. |
Failų parinkimas
Kiekvienas failas atsisiunčiamas iš:
Kodas
{baseUrl}/{block.name}/{file}
Ir įrašomas į:
Kodas
{directory}/{block.name}/{file}
Poaplankiai failų keliuose sukuriami automatiškai.
Tikrinimo taisyklės
nameneturi būti tuščias nei registro, nei bloko lygmeniu.baseUrlturi būti tinkamas URL.blocksturi turėti bent vieną įrašą.- Kiekvieno bloko
filesturi turėti bent vieną įrašą. - Jei pateiktas,
typeturi būti viena iš trijų leidžiamų reikšmių. - Jei pateiktas,
dependenciesturi būti eilučių masyvas. Kiekviena priklausomybė turi būti tame pačiame registre, antraip CLI pateiks klaidą priklausomybių sprendimo metu.