Первый плагин за 5 минут

Перед началом разработки плагина убедитесь, что:

  • администратор организации разрешил отладку плагинов. Этот переключатель действует для всех пользователей организации. Как администратору разрешить отладку плагинов;
  • вы включили отладку в Трекере: Настройки → Эксперименты → Отладка плагинов. Этот переключатель включает отладку только для вашего аккаунта.

Без обоих настроек вы не сможете завершить разработку.

Коротко — что нужно сделать:
npm install -g @weavix/cli → weavix create → weavix debug → откройте Трекер.

Что мы создадим

За 5 минут вы создадите работающий плагин, который:

  • отображается в интерфейсе Трекера;
  • использует компоненты дизайн-системы Трекера;
  • готов для расширения под ваши задачи.

final.gif

Шаг 1: Установка

Этот шаг нужно выполнить один раз в начале разработки первого плагина.

  1. Установите Node.js версии 22.16.0 или выше. Чтобы проверить установленную версию, выполните команду: node -v.

    На macOS и Linux рекомендуем устанавливать Node.js через nvm: так глобальная установка пакетов работает без sudo, а версии Node.js проще переключать и обновлять. На Windows установите Node.js привычным способом или используйте менеджер версий для Windows.

  2. Установите CLI. Для этого в командной строке выполните команду:

    npm install -g @weavix/cli

Шаг 2: Создание плагина

В командной строке выполните команду:

weavix create

При выполнении команды ответьте на несколько вопросов:

  • Шаблон: выберите подходящий для вашего слота, например issue.action для действий с тикетом
  • ID плагина: задайте идентификатор, содержащий только строчные буквы, цифры и дефисы
  • Категория: выберите категорию для отображения плагина в каталоге. Полный список категорий — на странице Как подготовить плагин к публикации
  • Разрешения: выберите с помощью стрелок и клавиши «Пробел»
  • Автор/email: укажите ваши контактные данные

Затем выполните:

cd ваш-плагин-id
npm install

Шаг 3: Запуск и просмотр

Выполните команду:

weavix debug

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

debug-settings.png

Отладка в браузере Safari не поддерживается из-за ограничений браузера. Для отладки используйте другой браузер.

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

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

Найдите ваш плагин в интерфейсе — в месте, которое соответствует выбранному слоту. Готово.

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

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

  1. Перед отправкой плагина на публикацию подготовьте изображения, описание и справку.

  2. Получите токен, выполнив команду: weavix login.

  3. Запустите команду: weavix submit — команда сама зарегистрирует плагин при необходимости, загрузит дистрибутив и отправит версию на модерацию.

  4. После отправки отслеживайте статус командой weavix list.

Что дальше?

Редактирование

Откройте src/App.tsx — изменения видны сразу. Никаких перезапусков не нужно.

Что уже настроено

  • React + TypeScript
  • Gravity UI — компоненты дизайн-системы
  • Тема Яндекс 360 — ваш плагин будет выглядеть как часть Трекера
  • SDK — для работы с данными Трекера через trackerApi

Примеры кода

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

ИИ поможет

Все API типизированы — ИИ легко разберется. Вот пример работающего промпта, с помощью которого можно создать плагин:

Напиши плагин для импорта задач в Трекер из файла csv.
Для взаимодействия с Трекером используется пакет @weavix/tracker-plugin-sdk-react, в котором есть `trackerApi` — клиент публичного API Трекера.
Нужно, чтобы в плагине была форма, в которой есть поиск нужной очереди для импорта, выбор разделителя csv, сам файл csv.
Потом нужно, чтобы пользователь мог сопоставить поля из csv с полями задач.
Также нужно отобразить индикатор импорта и результат.
Плагину нужно указать в манифесте слот navigation, также не забудь добавить права на чтение очередей и полей, используй приложенную схему манифеста

Нужна помощь?

Предыдущая
О платформе плагинов
Следующая
Как устроена платформа плагинов