CLI
CLI — это консольная утилита в виде NPM пакета, которая обеспечивает весь жизненный цикл плагина: создание, отладка, проверка и публикация.
Доступные команды
| Ключ запуска | Описание |
|---|---|
| create | Создать плагин из шаблона |
| build | Сборка плагина |
| login | Войти в аккаунт (проставить токен в CLI) |
| logout | Выйти из аккаунта |
| whoami | Посмотреть имя текущего пользователя |
| submit | Опубликовать плагин |
| list | Посмотреть список своих зарегистрированных плагинов |
| debug | Отладка плагина |
| lint | Проверить плагин |
| up | Миграция плагина на новую версию инструментов |
| feedback | Написать в поддержку |
| help | Вывести список всех команд плагина |
Установка
npm install -g @weavix/cli
Локальная разработка
-
Сначала включите в интерфейсе Трекера режим отладки плагинов
Настройки - Эксперименты - Отладка плагиновПри включении отладки браузер может запросить разрешение на доступ сайта к локальной сети. Разрешите доступ: без него отладка не будет работать, так как конфиг и плагины загружаются с
localhost. -
Затем запустите режим отладки в папке плагина:
weavix debug -
Откройте в интерфейсе Трекера используемую в плагине точку интеграции.
-
Вносите изменения в код интерфейса плагина — они сразу применяются в интерфейсе.
Публикация плагина
Публикация выполняется в следующем порядке:
-
Получите токен для CLI:
weavix login -
Перед публикацией убедитесь, что в проекте есть обязательные файлы для каталога:
public/logo.svgmarketplace/header-image.jpgmarketplace/index.md
-
Запустите полный процесс публикации:
weavix submitКоманда сама выполнит регистрацию плагина при необходимости, загрузку дистрибутива и отправку версии на модерацию.
-
После отправки на модерацию проверяйте статус публикации:
weavix list