registry.json Şeması
Tam şema
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"
]
}
]
}
Üst düzey alanlar
| Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
$schema |
string |
Hayır | Düzenleyici doğrulaması için JSON Şeması URL. |
name |
string |
Evet | Kayıt defteri tanımlayıcısı. Boş olamaz. |
description |
string |
Hayır | Kayıt defterinin kısa açıklaması. |
baseUrl |
string |
Evet | Blok dosyalarını indirmek için temel URL. Geçerli bir URL olmalıdır. |
blocks |
BlockEntry[] |
Evet | Kullanılabilir blokların dizisi. En az bir kayıt içermelidir. |
Blok girdisi alanları
| Alan | Tür | Gerekli | Açıklama |
|---|---|---|---|
name |
string |
Evet | Blok klasörünün adı ve CLI tanımlayıcısı. Boş olamaz. |
title |
string |
Hayır | İnsanların okuyabileceği görünen ad. |
description |
string |
Hayır | Arama sonuçları için tek satırlık açıklama. |
category |
string |
Hayır | Liste çıktısı için gruplandırma etiketi. |
type |
"blockstudio" | "create-block" | "wordpress" |
Hayır | Blok türü. Yalnızca bilgi amaçlıdır, CLI davranışını etkilemez. |
dependencies |
string[] |
Hayır | Aynı kayıt defterinde bu blokla birlikte yüklenmesi gereken blok adları. |
files |
string[] |
Evet | Blok klasörüne göreli dosya yolları. En az bir dosya gerekir. |
Dosya çözümleme
Her dosya şu kaynaktan indirilir:
Kod
{baseUrl}/{block.name}/{file}
Şuraya yazılır:
Kod
{directory}/{block.name}/{file}
Dosya yollarındaki alt dizinler otomatik olarak oluşturulur.
Doğrulama kuralları
namehem kayıt defteri hem de blok düzeyinde boş olmamalıdır.baseUrlgeçerli bir URL olmalıdır.blocksen az bir kayıt içermelidir.- Her bloğun
filesalanı en az bir kayıt içermelidir. - Belirtilmişse
type, izin verilen üç değerden biri olmalıdır. - Belirtilmişse
dependenciesbir dize dizisi olmalıdır. Her bağımlılık aynı kayıt defterinde bulunmalıdır; aksi takdirde CLI çözümleme sırasında hata verir.