Първи стъпки
Предварителни изисквания
- 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, за да пропуснете подканата.
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