انتقل إلى المحتوى

استضافة سجل

السجل عبارة عن ملف registry.json ومجموعة من مجلدات الكتل المستضافة عبر HTTP. لا حاجة إلى خادم خاص؛ فأي خدمة تستضيف ملفات ثابتة تفي بالغرض.

ما تحتاج إليه

  1. ملف registry.json يسرد الكتل
  2. مجلدات الكتل التي تحتوي على الملفات المشار إليها في البيان
  3. خادم ويب أو خدمة استضافة تخدم كليهما

بنية المجلدات

يبدو مستودع السجل النموذجي هكذا:

الكود
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/ باعتباره baseUrl:

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

المتطلبات

يجب أن تدعم الاستضافة الوصول المباشر إلى الملفات عبر URL. يجلب CLI الملفات بإنشاء عناوين URL انطلاقًا من {baseUrl}/{block.name}/{file}.

لا يتضمن CLI آلية تسجيل دخول خاصة به. بالنسبة إلى السجلات الخاصة، عالج التحكم في الوصول على مستوى الاستضافة (e.g، ومستودعات GitHub الخاصة باستخدام الرموز، أو خادم يتحقق من بيانات الاعتماد)، واجعل المستهلكين يرسلون بيانات الاعتماد في ترويسات مخصصة عبر تنسيق الكائن في blocks.json.

اختبار السجل

قبل النشر، اختبر محليًا بتشغيل خادم HTTP بسيط:

سطر الأوامر
cd my-registry
npx serve .

بعد ذلك وجّه blocks.json إلى http://localhost:3000/registry.json وشغّل npx blockstudio list للتحقق من حلّ كل شيء. يجلب list فقط registry.json. لاختبار add، اضبط baseUrl على http://localhost:3000/blocks أثناء الاختبار، لأن CLI ينزّل ملفات الكتل من baseUrl.