İçeriğe geç

registry.json

registry.json, URL üzerinde barındırılan bir JSON dosyasıdır. Bir kayıt deposunda kullanılabilir tüm blokları, meta verilerini, bağımlılıklarını ve dosya manifestlerini listeler.

Şema

JSON
{
  "$schema": "https://blockstudio.dev/schema/registry.json",
  "name": "ui",
  "description": "Core UI blocks for Blockstudio projects.",
  "baseUrl": "https://raw.githubusercontent.com/acme/blocks/main/blocks",
  "blocks": [
    {
      "name": "tabs",
      "title": "Tabs",
      "description": "Tabbed content with accessible keyboard navigation.",
      "category": "layout",
      "type": "blockstudio",
      "dependencies": ["tab-item"],
      "files": [
        "block.json",
        "index.php",
        "style.scss"
      ]
    }
  ]
}

Üst düzey alanlar

name

Gerekli. Kayıt deposu tanımlayıcısı. CLI bunu doğrular ancak görüntülemez: komutlar ve çıktı, tüketicinin kayıt deposu için blocks.json içinde seçtiği anahtarı kullanır.

description

İsteğe bağlı. Bu kayıt deposunun içeriğini kısaca açıklar.

baseUrl

Gerekli. Blok dosyalarını indirmek için kullanılacak temel URL. Geçerli bir URL olmalıdır.

Dosyalar; temel URL, blok adı ve dosya yolu birleştirilerek getirilir: {baseUrl}/{block.name}/{file}.

Örneğin, baseUrl değeri https://raw.githubusercontent.com/acme/blocks/main/blocks olarak ayarlanmışsa ve tabs adlı blokta index.php dosyası varsa, CLI şunu getirir:

Kod
https://raw.githubusercontent.com/acme/blocks/main/blocks/tabs/index.php

Blok alanları

name

Gerekli. Bloğun klasör adı. CLI komutlarında kullanılan tanımlayıcıdır ve diskteki klasör adı olur.

title

İsteğe bağlı. list ve search çıktılarında gösterilen, insanlar için okunabilir ad.

description

İsteğe bağlı. search sonuçlarında gösterilen tek satırlık açıklama.

category

İsteğe bağlı. list çıktısını gruplandıran etiket.

type

İsteğe bağlı. blockstudio, create-block veya wordpress değerlerinden biri.

Bu alan yalnızca bilgilendirme amaçlıdır. CLI, blok türüne göre davranışını değiştirmez. Her zaman files içinde listelenen dosyaları indirip kopyalar.

dependencies

İsteğe bağlı. Bu blokla birlikte kurulması gereken, aynı kayıt deposundaki diğer blok adlarından oluşan bir dizi.

Kullanıcı bağımlılıkları olan bir blok eklediğinde CLI tüm bağımlılık ağacını çözümler ve her şeyi doğru sırayla kurar. Döngüsel bağımlılıklar tespit edilir ve reddedilir.

Bağımlılıklar aynı kayıt deposunda bulunmalıdır. Kayıt depoları arası bağımlılıklar desteklenmez.

files

Gerekli. Blok klasörüne göreli dosya yollarından oluşan bir dizi. En az bir dosya gereklidir.

Bunlar, CLI tarafından indirilip diske yazılan dosyaların tam listesidir. Yollarda alt dizinler bulunabilir:

JSON
{
  "files": [
    "block.json",
    "index.php",
    "style.scss",
    "src/components/tabs.tsx",
    "src/styles/tabs.css"
  ]
}

Dosya çözümleme

CLI, bir bloğun manifestindeki her dosya için bir indirme URL oluşturur:

Kod
{baseUrl}/{block.name}/{file}

Şuraya yazar:

Kod
{directory}/{block.name}/{file}

Blok klasörünün içindeki dizin yapısı korunur. Bir dosya yolu alt dizinler içeriyorsa bunlar otomatik olarak oluşturulur.

Dosyalar her zaman registry.json içindeki baseUrl konumundan getirilir; blocks.json içindeki kayıt deposu URL konumuna göreli bir konumdan getirilmez.

Doğrulama

CLI, her getirme işleminde registry.json değerini bir Zod şemasına göre doğrular. Geçersiz kayıt depoları, doğrulamadan geçemeyen alanları belirten açık hata mesajları üretir.

Eksik zorunlu alanlar, boş blocks veya files dizileri, geçersiz URL’ler ve bilinmeyen type değerleri, herhangi bir dosya indirilmeden önce yakalanır.