İçeriğe geç

blocks.json

blocks.json temanızın veya eklentinizin kök dizininde bulunur. Blokların nereye kurulacağını ve hangi kayıt depolarında arama yapılacağını CLI bildirir.

Şema

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.example.com/registry.json",
    "starter": "https://raw.githubusercontent.com/acme/blocks/main/registry.json"
  }
}

Alanlar

$schema

İsteğe bağlı. Düzenleyici otomatik tamamlama ve doğrulama için JSON şemasını belirtir.

directory

Gerekli. Blokların kurulduğu blocks.json konumuna göreli yol.

Bu dizinin içinde her blok için ayrı bir alt klasör oluşturulur. directory değeri blockstudio ise ve hero eklerseniz, dosyalar blockstudio/hero/ konumuna yazılır.

registries

Gerekli. Ad alanı adlarını kayıt deposu başvurularına eşleyen bir nesne.

Anahtar, CLI komutlarında kullanılan ad alanıdır (npx blockstudio add ui/hero). Değer, bir URL dizesi veya url ve isteğe bağlı headers içeren bir nesnedir.

Dize biçimi (genel kayıt depoları):

JSON
{
  "registries": {
    "ui": "https://example.com/registry.json"
  }
}

Nesne biçimi (kimlik doğrulamalı kayıt depoları):

JSON
{
  "registries": {
    "private": {
      "url": "https://private.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Her iki biçim de aynı yapılandırmada birlikte kullanılabilir. İstediğiniz sayıda kayıt deposu yapılandırabilirsiniz. Ad alanı belirtilmeden blok eklendiğinde CLI bunların tümünde arama yapar.

Kimlik doğrulama

Kimlik doğrulama gerektiren kayıt depoları headers içeren nesne biçimini kullanır. CLI bu kayıt deposuna yapılan her istekte, hem registry.json getirme isteğinde hem de tek tek dosya indirmelerinde bu başlıkları gönderir.

Taşıyıcı belirteci

JSON
{
  "registries": {
    "private": {
      "url": "https://api.example.com/registry.json",
      "headers": {
        "Authorization": "Bearer ${REGISTRY_TOKEN}"
      }
    }
  }
}

Temel kimlik doğrulama

JSON
{
  "registries": {
    "private": {
      "url": "https://api.example.com/registry.json",
      "headers": {
        "Authorization": "Basic ${REGISTRY_CREDENTIALS}"
      }
    }
  }
}

Özel başlıklar

Herhangi bir başlık eklenebilir. Bu yöntem API anahtarları, kuruluş tanımlayıcıları veya kayıt deposu sunucunuzun beklediği diğer değerler için kullanılabilir:

JSON
{
  "registries": {
    "internal": {
      "url": "https://blocks.internal.company.com/registry.json",
      "headers": {
        "X-API-Key": "${BLOCKS_API_KEY}",
        "X-Org-ID": "acme"
      }
    }
  }
}

Ortam değişkenleri

Başlık değerleri, ortam değişkenlerini okumak için ${VAR_NAME} söz dizimini destekler. Bu sayede belirteçler sürüm denetimi dışında tutulur.

CLI ortam değişkenlerini çalışma zamanında çözümler. Başvurulan bir değişken tanımlanmamışsa CLI, eksik değişkenin ve kullanıldığı başlığın adını belirten bir hatayla çıkar.

Değişkeni kabuğunuzda veya CI ortamınızda tanımlayın. CLI yalnızca süreç ortamını okur; .env dosyalarını kendisi yüklemez:

Kabuk
export REGISTRY_TOKEN=ghp_abc123
npx blockstudio add private/hero

Statik başlık değerleri (${...} olmadan) olduğu gibi aktarılır.

Yapılandırma keşfi

CLI, geçerli çalışma dizininden başlayarak üst dizinlerde blocks.json arar. Böylece projenizin herhangi bir alt dizininden komut çalıştırabilirsiniz.

Kod
my-theme/
  blocks.json        <- found here
  blockstudio/
    hero/
  templates/
    page.php          <- running `npx blockstudio add` here still works

blocks.json bulunamazsa CLI, npx blockstudio init çalıştırmanızı söyler.

Örnek: iki kayıt depolu tema

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.mycompany.com/ui/registry.json",
    "internal": "https://blocks.mycompany.com/internal/registry.json"
  }
}

Örnek: özel dizin kullanan eklenti

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "src/blocks",
  "registries": {
    "starter": "https://raw.githubusercontent.com/acme/blocks/main/registry.json"
  }
}