Skema registry.json
Skema lengkap
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"
]
}
]
}
Bidang tingkat atas
| Bidang | Tipe | Wajib | Deskripsi |
|---|---|---|---|
$schema |
string |
Tidak | JSON Schema URL untuk validasi editor. |
name |
string |
Ya | Pengenal registri. Tidak boleh kosong. |
description |
string |
Tidak | Deskripsi singkat registri. |
baseUrl |
string |
Ya | URL dasar untuk mengunduh file blok. Harus berupa URL yang valid. |
blocks |
BlockEntry[] |
Ya | Array blok yang tersedia. Harus berisi setidaknya satu entri. |
Bidang entri blok
| Bidang | Tipe | Wajib | Deskripsi |
|---|---|---|---|
name |
string |
Ya | Nama folder blok dan pengenal CLI. Tidak boleh kosong. |
title |
string |
Tidak | Nama tampilan yang mudah dibaca. |
description |
string |
Tidak | Deskripsi satu baris untuk hasil pencarian. |
category |
string |
Tidak | Label pengelompokan untuk keluaran daftar. |
type |
"blockstudio" | "create-block" | "wordpress" |
Tidak | Jenis blok. Hanya sebagai informasi, tidak memengaruhi perilaku CLI. |
dependencies |
string[] |
Tidak | Nama blok dalam registri yang sama dan harus dipasang bersama blok ini. |
files |
string[] |
Ya | Jalur file relatif terhadap folder blok. Wajib ada setidaknya satu file. |
Resolusi file
Setiap file diunduh dari:
Kode
{baseUrl}/{block.name}/{file}
Dan ditulis ke:
Kode
{directory}/{block.name}/{file}
Subdirektori dalam jalur file dibuat secara otomatis.
Aturan validasi
nametidak boleh kosong, baik pada tingkat registri maupun blok.baseUrlharus berupa URL yang valid.blocksharus berisi setidaknya satu entri.filessetiap blok harus berisi setidaknya satu entri.- Jika diberikan,
typeharus berupa salah satu dari tiga nilai yang diizinkan. - Jika diberikan,
dependenciesharus berupa array string. Setiap dependensi harus ada di registri yang sama, atau CLI akan menghasilkan kesalahan saat proses penyelesaian.