İçeriğe geç

blocks.json Şeması

Tam şema

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "public": "https://example.com/registry.json",
    "private": {
      "url": "https://private.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Alanlar

Alan Tür Gerekli Açıklama
$schema string Hayır Düzenleyici doğrulaması için JSON Şeması URL.
directory string Evet Blokların yüklendiği blocks.json dizinine göreli yol. Boş olamaz.
registries Record<string, string | RegistryRef> Evet Ad alanı adlarını kayıt defteri referanslarıyla eşleyen harita. Boş olabilir.

Kayıt defteri referans biçimleri

registries içindeki her değer bir URL dizesi veya nesnedir:

Dize: Bir registry.json dosyasına giden geçerli bir URL.

Nesne:

Alan Tür Gerekli Açıklama
url string Evet Bir registry.json dosyasına giden geçerli bir URL.
headers Record<string, string> Hayır Bu kayıt defterine yapılan her istekte gönderilen HTTP başlıkları. Değerler ${ENV_VAR} enterpolasyonunu destekler.

Doğrulama kuralları

  • directory boş olmayan bir dize olmalıdır.
  • registries içindeki her anahtar boş olmayan bir dize olmalıdır.
  • Dize biçimindeki kayıt defteri değerleri geçerli URL’ler olmalıdır.
  • Nesne biçimindeki kayıt defteri değerlerinde geçerli bir url alanı bulunmalıdır.
  • Başlıklardaki ${ENV_VAR} referansları çalışma zamanında çözümlenir. Eksik değişkenlerde değişkenin ve başlığın adını belirten bir hata oluşur.
  • registries nesnesi boş olabilir. Bu durumda add, No registries configured in blocks.json. Add a registry first. koduyla çıkar; list, No registries configured. yazdırır; search ise No blocks matching "<query>". yazdırır.

Yapılandırma keşfi

CLI, geçerli çalışma dizininden başlayarak üst dizinlerde yukarı doğru en fazla 20 düzey boyunca blocks.json dosyasını arar. Bulunan ilk blocks.json kullanılır.