İçeriğe geç

Kayıt Defteri Barındırma

Kayıt defteri bir registry.json dosyası ve HTTP üzerinden sunulan blok klasörlerinden oluşur. Özel bir sunucu gerekmez. Statik dosyaları sunabilen her şey iş görür.

Gerekenler

  1. Bloklarınızı listeleyen bir registry.json dosyası
  2. Manifestte belirtilen dosyaları içeren blok klasörleri
  3. Her ikisini de sunan bir web sunucusu veya barındırma hizmeti

Dizin yapısı

Tipik bir kayıt defteri deposu şöyle görünür:

Kod
my-registry/
  registry.json
  blocks/
    hero/
      block.json
      index.php
      style.scss
    tabs/
      block.json
      index.php
      style.scss
    tab-item/
      block.json
      index.php

registry.json, blocks/ dizinini baseUrl olarak gösterir:

JSON
{
  "name": "my-registry",
  "baseUrl": "https://example.com/blocks",
  "blocks": [
    {
      "name": "hero",
      "title": "Hero",
      "files": ["block.json", "index.php", "style.scss"]
    }
  ]
}

Gereksinimler

Barındırma hizmeti, URL üzerinden doğrudan dosya erişimini desteklemelidir. CLI, {baseUrl}/{block.name}/{file} üzerinden URL’ler oluşturarak dosyaları alır.

CLI’ın kendi oturum açma akışı yoktur. Özel kayıt depoları için erişim denetimini barındırma katmanında yönetin (e.g özel GitHub depolarında belirteçlerle veya kimlik bilgilerini denetleyen bir sunucuda) ve tüketicilerin kimlik bilgilerini blocks.json içindeki nesne biçimi aracılığıyla özel başlıklar olarak göndermesini sağlayın.

Kayıt defterinizi test etme

Yayımlamadan önce basit bir HTTP sunucusu başlatarak yerel ortamda test edin:

Kabuk
cd my-registry
npx serve .

Ardından blocks.json‘inizi http://localhost:3000/registry.json‘e yönlendirin ve her şeyin çözümlendiğini doğrulamak için npx blockstudio list komutunu çalıştırın. list yalnızca registry.json dosyalarını alır. add özelliğini test etmek için test sırasında baseUrl değerini http://localhost:3000/blocks olarak ayarlayın; çünkü CLI, blok dosyalarını baseUrl‘ten indirir.