registry.json skeem
Täielik skeem
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"
]
}
]
}
Ülataseme väljad
| Väli | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
$schema |
string |
Ei | JSON skeem URL redaktoris valideerimiseks. |
name |
string |
Jah | Registri tunnus. Ei tohi olla tühi. |
description |
string |
Ei | Registri lühikirjeldus. |
baseUrl |
string |
Jah | Põhi-URL plokifailide allalaadimiseks. Peab olema kehtiv URL. |
blocks |
BlockEntry[] |
Jah | Saadaolevate plokkide massiiv. Peab sisaldama vähemalt üht kirjet. |
Ploki kirje väljad
| Väli | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
name |
string |
Jah | Ploki kausta nimi ja CLI tunnus. Ei tohi olla tühi. |
title |
string |
Ei | Inimloetav kuvatav nimi. |
description |
string |
Ei | Üherealine kirjeldus otsingutulemuste jaoks. |
category |
string |
Ei | Loendiväljundi rühmitussilt. |
type |
"blockstudio" | "create-block" | "wordpress" |
Ei | Ploki tüüp. Ainult teavitav; ei mõjuta CLI käitumist. |
dependencies |
string[] |
Ei | Sama registri plokid, mis tuleb koos selle plokiga installida. |
files |
string[] |
Jah | Failide rajad ploki kausta suhtes. Nõutav on vähemalt üks fail. |
Failide lahendamine
Iga fail laaditakse alla asukohast:
Kood
{baseUrl}/{block.name}/{file}
Ja kirjutatakse asukohta:
Kood
{directory}/{block.name}/{file}
Alamkaustad luuakse failiradade põhjal automaatselt.
Valideerimisreeglid
nameei tohi registri ega ploki tasemel tühi olla.baseUrlpeab olema kehtiv URL.blockspeab sisaldama vähemalt üht kirjet.- Iga ploki
filespeab sisaldama vähemalt üht kirjet. - Kui
typeon määratud, peab see olema üks kolmest lubatud väärtusest. - Kui
dependencieson määratud, peab see olema stringide massiiv. Iga sõltuvus peab samas registris olemas olema, vastasel juhul annab CLI lahendamise ajal vea.