CLI

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

@weavix/cli на npmjs.com

Для установки выполните команду:

npm install -g @weavix/cli

Наличие шаблона для определенного сервиса в CLI не гарантирует, что плагин можно встроить в этот сервис: шаблон лишь позволяет создать проект и запустить его локально. Будут ли доступны слоты в самом сервисе, зависит от версии релиза и его настроек.

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

Команда Описание
create Создать плагин из шаблона
up Обновить плагин со старой версии шаблона
build Собрать плагин
build-docs Собрать справку плагина с помощью Diplodoc
debug Запустить локальную отладку плагина
lint Запустить проверки TypeScript и ESLint
version Показать или изменить версию плагина в manifest.json
manifest Изменить поля манифеста manifest.json
login Войти в аккаунт
logout Удалить сохраненные данные авторизации
doctor Проверить проект, авторизацию и конфигурацию
submit Зарегистрировать плагин, загрузить дистрибутив и отправить на модерацию
list Посмотреть список своих зарегистрированных плагинов
info Посмотреть подробную информацию о плагине
withdraw Отозвать отправленную версию с модерации
help Вывести справку по командам CLI

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

  1. Запустите режим отладки в папке плагина:
weavix debug
  1. Откройте сервис, в котором будете проверять плагин:
  • для Трекера, Вики и Форм откройте интерфейс сервиса — параметр slotPluginsConfigUrl не нужен;
  • для Календаря, Диска и Почты откройте URL, который напечатал CLI. URL соответствует сервису из manifest.json и может содержать slotPluginsConfigUrl=http://localhost:5173/config.json.
  1. При включении отладки браузер может запросить разрешение на доступ сайта к локальной сети. Разрешите доступ: без него конфиг и плагины не загрузятся с localhost.

  2. Откройте сервис и найдите место встраивания плагина в интерфейс сервиса.

  3. Вносите изменения в код плагина src/App.tsx — изменения видны сразу, без перезапусков.

Браузер Safari не поддерживает режим отладки, используйте другой браузер.

Если отладка не работает, обратитесь к администратору вашей организации и попросите разрешить отладку плагинов. Как разрешить отладку

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

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

Команда Описание
manifest set <path> <value> Установить значение поля манифеста по пути в точечной нотации, например author.name
manifest add <path> <value> Добавить элемент в массив пути в точечной нотации. Если массив отсутствует, CLI создаст его
manifest remove <path> <value> Удалить подходящий элемент из массива по пути в точечной нотации
manifest unset <path> Полностью удалить поле в пути в точечной нотации
manifest edit Выбрать и изменить поле манифеста в интерактивном режиме

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

Чтобы опубликовать плагин, сделайте следующее:

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

    weavix login
    
  2. Запустите публикацию:

    weavix submit
    

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

  3. Проверьте статус публикации:

    weavix list
    

Подробнее о публикации плагина

Следующая