Початок роботи
Необхідні умови
- 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 залежить від
tab-itemуtabs) - Завантажує всі файли
- Записує їх у каталог блоків
Якщо блок є лише в одному реєстрі, простір імен можна не вказувати:
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, щоб пропустити запит.
CI та автоматизація
Команди 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