CLI

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

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

Ключ запуска Описание
create Создать плагин из шаблона
build Сборка плагина
login Войти в аккаунт (проставить токен в CLI)
logout Выйти из аккаунта
whoami Посмотреть имя текущего пользователя
submit Опубликовать плагин
list Посмотреть список своих зарегистрированных плагинов
debug Отладка плагина
lint Проверить плагин
up Миграция плагина на новую версию инструментов
feedback Написать в поддержку
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
    

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

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

    weavix list
    
Следующая