CLI

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

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

Команда

Описание

create

Создать плагин из шаблона

up

Обновить плагин до актуальной версии шаблона

build

Собрать плагин

build-docs

Собрать документацию плагина

debug

Запустить локальную отладку плагина

lint

Проверить манифест, TypeScript, ESLint и стили

login

Войти в аккаунт и сохранить токен

logout

Выйти из аккаунта и удалить сохраненный токен

doctor

Проверить локальный проект, авторизацию и конфигурацию CLI

submit

Проверить, собрать и отправить плагин на модерацию

list

Посмотреть список своих плагинов и статусы модерации

info [plugin-id]

Посмотреть информацию о плагине. Если идентификатор не указан, CLI возьмет его из манифеста

withdraw [plugin-id] [version]

Отозвать отправленную на модерацию версию. Если аргументы не указаны, CLI возьмет их из манифеста

Чтобы посмотреть встроенную справку, выполните команду 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

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

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

    weavix list

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

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

weavix withdraw

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

weavix withdraw <plugin-id> <version>
Предыдущая
Инструменты разработки
Следующая
SDK Core