ReadAware

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

Публичный репозиторий плагинов содержит пакеты маркетплейса и принимает изменения через pull request. При подготовке заявки используйте его текущие инструкции по участию и валидатор.

Соответствуйте приложению, которое вы поддерживаете

Каталог разработки может опережать последнюю выпущенную версию приложения. Файл types/host-capabilities.json в репозитории описывает этот релиз, а его валидатор отклоняет диапазоны в requires, которые этот релиз не может удовлетворить. Пакету, которому нужна новая возможность, придётся дождаться совместимого релиза хоста; изменение только minAppVersion не создаст отсутствующий API.

Используйте Capabilities Explorer, чтобы изучить методы и версии, а затем объявите минимальный совместимый набор, который вы действительно протестировали.

Сделайте пакет проверяемым

Зафиксируйте manifest.json, читаемый исходный код, собранный автономный main.js и необходимые ресурсы выполнения. Имя папки должно совпадать с ID в манифесте. Не загружайте удаленный исполняемый код и не зависите от файлов вне пакета.

tree
plugins/my-plugin/
  manifest.json
  main.js
  package.json
  src/main.ts
  src/main.test.ts
  assets/

Проверьте поведение и полномочия

  • Объясните функцию, ее точки входа и почему требуется каждое разрешение.
  • Укажите точные разрешения Settings и необходимые сетевые источники. Объясните, какие данные отправляются внешним сервисам.
  • Протестируйте область книги, отсутствующие разрешения, отмену, отключение/повторное включение и фактический пользовательский интерфейс настольного приложения.
  • Держите активацию декларативной, а миграции — только для хранения.
  • Проверьте хранение приватных данных, квоты и очистку активных ресурсов.
  • Для обновлений протестируйте существующую установку с реалистичными данными, включая неудачную миграцию и восстановление.

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

Сборка и отправка

Запустите проверки публичного репозитория из его корня; bun run check — именно это запускает CI для вашего pull request:

bash
bun install
bun run build
bun run check

Добавьте соответствующую запись в реестр согласно текущей схеме и порядку сортировки репозитория. Откройте pull request с описанием итогового поведения, проверенных версий приложения и возможностей, приватных данных, внешних сервисов и изменений разрешений. Включите воспроизводимые шаги проверки.

Обновления

Увеличьте версию пакета в манифесте и реестре. Изменяйте schemaVersion только при изменении схемы приватных данных, с миграцией в том же пакете. Запрос на расширение полномочий требует четкого объяснения и рабочего пути отказа.

Подпись, идентичность издателя, целостность пакета, происхождение проверки и отзыв — это отдельные вопросы распространения. Укажите контрольные меры, которые фактически применяются к пакету; изоляция Worker сама по себе не является гарантией от произвольного кода.

Создать плагин · Справочник API