مخطط blocks.json
المخطط الكامل
JSON
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"public": "https://example.com/registry.json",
"private": {
"url": "https://private.example.com/registry.json",
"headers": {
"Authorization": "Bearer ${REGISTRY_TOKEN}"
}
}
}
}
الحقول
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
$schema |
string |
لا | JSON مخطط URL للتحقق في المحرر. |
directory |
string |
نعم | مسار نسبي من blocks.json حيث تُثبّت الكتل. يجب ألا يكون فارغًا. |
registries |
Record<string, string | RegistryRef> |
نعم | خريطة لأسماء مساحات الأسماء ومراجع السجلات. يمكن أن تكون فارغة. |
تنسيقات مراجع السجل
كل قيمة في registries إما سلسلة URL أو كائن:
سلسلة: عنوان URL صالح لملف registry.json.
كائن:
| الحقل | النوع | مطلوب | الوصف |
|---|---|---|---|
url |
string |
نعم | عنوان URL صالح لملف registry.json. |
headers |
Record<string, string> |
لا | ترويسات HTTP تُرسل مع كل طلب إلى هذا السجل. تدعم القيم استيفاء ${ENV_VAR}. |
قواعد التحقق
- يجب أن يكون
directoryسلسلة غير فارغة. - يجب أن يكون كل مفتاح في
registriesسلسلة غير فارغة. - يجب أن تكون قيم السجل النصية عناوين URL صالحة.
- يجب أن تحتوي قيم السجل الكائنية على حقل
urlصالح. - تُحل مراجع
${ENV_VAR}في الترويسات وقت التشغيل. وتؤدي المتغيرات المفقودة إلى خطأ يذكر اسم المتغير والترويسة. - يمكن أن يكون الكائن
registriesفارغًا. عندها يخرجaddبالرمزNo registries configured in blocks.json. Add a registry first.، ويطبعlistNo registries configured.، ويطبعsearchNo blocks matching "<query>".
اكتشاف ملف الإعدادات
يبحث CLI عن blocks.json بدءًا من دليل العمل الحالي، صعودًا عبر الأدلة الأصلية حتى 20 مستوى. ويُستخدم أول blocks.json يُعثر عليه.