Перейти к содержимому

Начало работы

Предварительные требования

  • 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 проведет вас через интерактивную настройку:

  1. Каталог блоков: место для установки блоков (по умолчанию: blockstudio)
  2. Реестры: добавьте один или несколько реестров, указав их URL и имена

Будет создан файл blocks.json:

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:

  1. Загружает реестр
  2. Находит блок
  3. Разрешает все зависимости (e.g. tabs зависит от tab-item)
  4. Загружает все файлы
  5. Сохраняет их в каталог блоков

Если блок есть только в одном реестре, пространство имен можно не указывать:

Командная оболочка
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