البدء
المتطلبات الأساسية
- Node.js الإصدار 18 أو أحدث
- قالب أو إضافة WordPress تريد تثبيت الكتل فيها
حزمة blockstudio على npm بالإصدار 0.0.1. هذا الإصدار مؤقت: لا يتضمن سوى أمر add يطبع Adding block: <name> ثم ينتهي دون جلب أي شيء، ويرفض init وlist وsearch وremove و--yes و--dry-run بوصفها خيارات غير معروفة. تصف الأوامر في هذه الصفحات سجل CLI الموجود في مستودع Blockstudio (packages/registry).
تهيئة مشروعك
شغّل init في جذر القالب أو الإضافة:
npx blockstudio init
يرشدك CLI خلال إعداد تفاعلي:
- دليل الكتل: مكان تثبيت الكتل (الافتراضي:
blockstudio) - السجلات: أضف عنوان URL لسجل واحد أو أكثر مع تحديد الاسم
ينشئ هذا ملفًا باسم blocks.json:
{
"$schema": "https://blockstudio.dev/schema/blocks.json",
"directory": "blockstudio",
"registries": {
"ui": "https://blocks.example.com/registry.json"
}
}
يمكنك أيضًا تخطي المطالبات التفاعلية:
npx blockstudio init --yes
ينشئ هذا ملف blocks.json بالقيم الافتراضية. ويمكنك تعديله يدويًا لاحقًا.
إضافة كتلة
npx blockstudio add ui/tabs
التنسيق هو namespace/block، حيث تطابق namespace مفتاحًا في إعدادات registries لديك.
يقوم CLI بما يلي:
- يجلب السجل
- يعثر على الكتلة
- يحل أي اعتمادات (e.g. تعتمد
tabsعلىtab-item) - ينزّل كل الملفات
- يكتبها في دليل الكتل لديك
إذا كانت الكتلة موجودة في سجل واحد فقط، يمكنك تخطي مساحة الاسم:
npx blockstudio add tabs
إذا كانت موجودة في عدة سجلات، يطلب منك CLI الاختيار في الطرفية. ومن دون طرفية، يتوقف مع خطأ يسرد السجلات المطابقة، ويختار --yes أول سجل حسب ترتيب blocks.json.
إضافة كتل متعددة
npx blockstudio add ui/tabs ui/hero ui/accordion
تُثبّت كل الكتل في تشغيل واحد.
المعاينة قبل التثبيت
npx blockstudio add ui/tabs --dry-run
يعرض هذا ما سيتم تثبيته دون كتابة أي ملفات.
استعراض الكتل المتاحة
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero
يعرض list كل الكتل من جميع السجلات (أو من سجل محدد). ويجري search مطابقة جزئية غير حساسة لحالة الأحرف على أسماء الكتل وعناوينها وأوصافها.
إزالة كتلة
npx blockstudio remove tabs
يحذف هذا مجلد الكتلة. في الوضع التفاعلي، يُطلب منك التأكيد. مرّر --yes لتخطي المطالبة.
التكامل المستمر والأتمتة
init وadd وremove تقبل --yes لتخطي المطالبات التفاعلية.
list وsearch لا تعرضان مطالبات مطلقًا وترفضان --yes بوصفه خيارًا غير معروف.
عندما لا يكون stdin طرفية (مثل مشغّلات CI أو الإدخال المُمرر عبر الأنابيب)، يعود CLI إلى
الوضع غير التفاعلي: يستبدل init ملف blocks.json موجودًا، ويتوقف add
مع ظهور خطأ إذا كان مجلد الكتلة موجودًا بالفعل أو كان اسم الكتلة ملتبسًا، ويحذف remove دون طلب تأكيد.
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes