CLI

CLI — это консольная утилита в виде NPM пакета, которая обеспечивает весь жизненный цикл плагина: создание, отладка, проверка и публикация.

Доступные команды

Чтобы посмотреть встроенную справку, выполните команду weavix --help. Для справки по конкретной команде добавьте после нее флаг --help, например weavix submit --help.

Установка

npm install -g @weavix/cli 

Локальная разработка

1. Сначала включите в интерфейсе Трекера режим отладки плагинов

   Настройки - Эксперименты - Отладка плагинов
   

   При включении отладки браузер может запросить разрешение на доступ сайта к локальной сети. Разрешите доступ: без него отладка не будет работать, так как конфиг и плагины загружаются с localhost.

2. Затем запустите режим отладки в папке плагина:

   weavix debug
   

3. Откройте в интерфейсе Трекера используемую в плагине точку интеграции.

4. Вносите изменения в код интерфейса плагина — они сразу применяются в интерфейсе.

Публикация плагина

Публикация выполняется в следующем порядке:

1. Получите токен для CLI:

   weavix login
   

2. Перед публикацией убедитесь, что в проекте есть обязательные файлы для каталога:

   • public/logo.svg
   • marketplace/header-image.jpg
   • marketplace/index.md

3. Запустите полный процесс публикации:

   weavix submit
   

   Команда сама выполнит регистрацию плагина при необходимости, загрузку дистрибутива и отправку версии на модерацию.

   Если CLI сообщает, что установленная версия больше не поддерживается, обновите его:

   weavix upgrade
   

   Если команда недоступна, переустановите последнюю версию: npm i -g @weavix/cli@latest.

   Если плагин еще не опубликован, его можно сразу сделать публичным и отправить версию на модерацию Яндекса:

   weavix submit --public
   

   CLI зарегистрирует плагин, переключит его видимость на PUBLIC и отправит версию на модерацию. Если плагин уже публичный, отправляйте новые версии командой weavix submit без флага --public. Публичный плагин нельзя снова сделать доступным только своей организации.

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

   weavix make-public
   

   Команда создаст заявку на публикацию последней версии, одобренной организацией. CLI попросит подтвердить необратимое изменение видимости. Чтобы пропустить подтверждение, используйте флаг --yes; при запуске без терминала этот флаг обязателен.

   Пока заявка находится на модерации, отправлять новые версии нельзя. Проверить статус заявки и комментарий модератора можно командой:

   weavix info
   

   Перед использованием команд публичной публикации ознакомьтесь с требованиями к карточке плагина и проверкой на секреты.

4. После отправки на модерацию проверяйте статус публикации:

   weavix list
   

   Чтобы посмотреть замечания модератора к версии плагина и последнюю заявку на публикацию, выполните команду:

   weavix info
   

   Для заявки команда покажет идентификатор и статус заявки, идентификатор версии, даты подачи и решения, а также комментарий модератора. В выводе weavix list не отображаются комментарии модератора и данные заявки.

Отзыв версии с модерации

Отозвать можно только версию со статусом IN_REVIEW. Выполните команду:

weavix withdraw

CLI возьмет значения id и version из файла manifest.json текущего проекта. Чтобы отозвать другую версию, укажите идентификатор плагина и номер версии:

weavix withdraw <plugin-id> <version>

Чтобы отозвать активную заявку на публикацию плагина в публичном каталоге, выполните команду:

weavix withdraw --publication

CLI возьмет идентификатор плагина из manifest.json. Чтобы передать идентификатор другого плагина, выполните команду:

weavix withdraw --publication <plugin-id>

После отзыва заявки снова можно отправлять версии.

Редактирование манифеста

Команда manifest изменяет поля файла manifest.json. Путь до поля указывается в точечной нотации, например author.name.