Donutgramплагины
На этой страницеФайлы проекта

Структура проекта

Какие файлы входят в пакет и как организовать исходники.

Файлы проекта

Маленькому плагину достаточно двух файлов. Когда логики становится больше, разделяйте чистые функции и обработчики по модулям.

hello/
├── manifest.json
├── main.js
├── modules/
│   ├── greeting.js
│   └── strings.js
└── assets/
    ├── icon.png
    └── preview.webp

manifest.json

Идентификация, описание, версия, разрешения, схема настроек и точка входа. Этот файл проверяется до выполнения JavaScript. Полный список полей — в манифесте.

main.js

Начинается с const _plugin = "donutgram"; и экспортирует результат definePlugin. Регистрируйте команды и события внутри activate, а освобождайте собственные ресурсы в deactivate.

modules

Локальные JavaScript-модули, которые импортирует плагин. Имя папки не фиксировано. Импорты должны оставаться внутри проверенного пакета.

import { greeting } from "./modules/greeting.js";

assets

Локальные изображения PNG, JPEG или WebP. Поле icon манифеста ссылается на изображение внутри assets/. Для изображения на странице используйте api.assets.image.

Что не упаковывать

Не включайте node_modules, .git, исходники TypeScript, PSD, видео и другие неподдерживаемые ресурсы. Ключи, приватные конфигурации и журналы разработки также не должны попадать в архив.

Фикстуры локальных тестов удобно хранить рядом с проектом, вне упаковываемой папки. CLI не является универсальным ZIP-упаковщиком: он проверяет все включённые файлы.