Donutgramплагины
На этой страницеПодготовка к разработке

Подготовка окружения

Подготовьте инструменты для разработки первого плагина.

Подготовка к разработке

Понадобятся редактор кода, Python 3.11 или новее и Donutgram с поддержкой плагинов. Node.js нужен только для локальных mock-тестов или выбранного вами сборщика JavaScript.

Инструменты

Откройте терминал в каталоге Donutgram/DGPluginSDK исходного проекта Donutgram. Команды этого справочника выполняются из него.

python --version
python tools/dgplugin.py --help

Если команда python не найдена в Windows, попробуйте установленный Python Launcher:

py -3 tools/dgplugin.py --help

Файлы для разработки

Папка Содержимое
tools Создание, проверка и упаковка плагинов
types TypeScript-описание доступного JavaScript API
schemas JSON Schema манифеста и нативных страниц
examples Восемь готовых проектов
tests JSON-фикстуры для примеров

Создать заготовку

python tools/dgplugin.py create my-plugin --id dev.example.my-plugin

Команда создаёт новую папку с manifest.json и main.js. Она не перезаписывает существующую папку.

Подсказки в редакторе

Подключите types/index.d.ts к проекту редактора. Устанавливаемый пакет должен содержать обычный JavaScript: TypeScript сначала нужно преобразовать в .js.

{
  "compilerOptions": {
    "allowJs": true,
    "checkJs": true,
    "noEmit": true,
    "target": "ES2020",
    "module": "ESNext"
  },
  "include": ["types/index.d.ts", "my-plugin/**/*.js"]
}

Проверить клиент

Откройте раздел «Плагины» в настройках Donutgram и включите общий переключатель. Если все плагины выключены, их индивидуальные переключатели недоступны. Настройки, отправка файла и удаление остаются доступны.