مخطط registry.json
المخطط الكامل
JSON
{
"$schema": "https://blockstudio.dev/schema/registry.json",
"name": "my-registry",
"description": "A collection of WordPress blocks.",
"baseUrl": "https://example.com/blocks",
"blocks": [
{
"name": "hero",
"title": "Hero",
"description": "Full-width hero section with heading and CTA.",
"category": "layout",
"type": "blockstudio",
"dependencies": ["button"],
"files": [
"block.json",
"index.php",
"style.scss"
]
}
]
}
الحقول العليا
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
$schema |
string |
لا | JSON مخطط URL للتحقق في المحرر. |
name |
string |
نعم | معرّف السجل. يجب ألا يكون فارغًا. |
description |
string |
لا | وصف موجز للسجل. |
baseUrl |
string |
نعم | عنوان URL أساسي لتنزيل ملفات الكتل. يجب أن يكون URL صالحًا. |
blocks |
BlockEntry[] |
نعم | مصفوفة بالكتل المتاحة. يجب أن تحتوي على إدخال واحد على الأقل. |
حقول إدخال الكتلة
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
name |
string |
نعم | اسم مجلد الكتلة ومعرّف CLI. يجب ألا يكون فارغًا. |
title |
string |
لا | اسم عرض واضح للمستخدم. |
description |
string |
لا | وصف من سطر واحد لنتائج البحث. |
category |
string |
لا | تسمية التجميع في ناتج القائمة. |
type |
"blockstudio" | "create-block" | "wordpress" |
لا | نوع الكتلة. للمعلومات فقط ولا يؤثر في سلوك CLI. |
dependencies |
string[] |
لا | أسماء الكتل في السجل نفسه التي يجب تثبيتها مع هذه الكتلة. |
files |
string[] |
نعم | مسارات الملفات النسبية إلى مجلد الكتلة. يلزم ملف واحد على الأقل. |
تحديد مسارات الملفات
يُنزل كل ملف من:
الكود
{baseUrl}/{block.name}/{file}
ويُكتب إلى:
الكود
{directory}/{block.name}/{file}
تُنشأ المجلدات الفرعية في مسارات الملفات تلقائيًا.
قواعد التحقق
- يجب ألا يكون
nameفارغًا على مستوى السجل والكتلة. - يجب أن يكون
baseUrlURL صالحًا. - يجب أن يحتوي
blocksعلى إدخال واحد على الأقل. - يجب أن يحتوي
filesلكل كتلة على إدخال واحد على الأقل. - يجب أن تكون
type، إن قُدّمت، إحدى القيم الثلاث المسموح بها. - يجب أن تكون
dependencies، إن قُدّمت، مصفوفة من السلاسل. ويجب أن يوجد كل اعتماد في السجل نفسه، وإلا فسيصدر CLI خطأً عند حلّه.