ReadAware

Publier un plugin

Le dépôt public des plugins héberge les paquets du marché et accepte les changements par pull request. Utilisez ses instructions de contribution et son validateur actuels pour préparer une soumission.

Correspondre à l'application que vous prenez en charge

Le catalogue de développement peut être en avance sur la dernière application publiée. Le fichier types/host-capabilities.json du dépôt décrit cette version, et son validateur rejette les plages requires que la version ne peut pas satisfaire. Un package qui nécessite une nouvelle capacité doit attendre une version d'hôte compatible ; modifier uniquement minAppVersion ne crée pas l'API manquante.

Utilisez l'explorateur de capacités pour inspecter les méthodes et les versions, puis déclarez le plus petit ensemble compatible que vous avez réellement testé.

Rendre le paquet révisable

Validez manifest.json, le code source lisible, le main.js autonome compilé et les ressources d’exécution requises. Faites correspondre le nom du dossier à l’ID du manifeste. Ne chargez pas de code exécutable distant et ne dépendez pas de fichiers situés hors du paquet.

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

Vérifier le comportement et l’autorité

  • Expliquez la fonctionnalité, ses points d’entrée et la raison de chaque permission.
  • Déclarez les autorisations exactes des réglages et les origines réseau requises. Expliquez quelles données sont envoyées aux services externes.
  • Testez la portée du livre, les permissions absentes, l’annulation, la désactivation/réactivation et l’interface réelle de bureau.
  • Gardez l’activation déclarative et les migrations limitées au stockage.
  • Vérifiez la conservation des données privées, les quotas et le nettoyage des ressources actives.
  • Pour les mises à jour, exercez une installation existante avec des données réalistes, notamment une migration échouée et sa récupération.

L’aperçu local du manifeste aide à repérer les erreurs de compatibilité et d’autorité. Il ne remplace ni le validateur du dépôt, ni les tests de bureau, ni la révision.

Construire et soumettre

Exécutez les vérifications du dépôt public depuis sa racine ; bun run check correspond à ce que la CI exécute sur votre pull request :

bash
bun install
bun run build
bun run check

Ajoutez l'entrée correspondante dans le registre selon le schéma et l'ordre actuels du dépôt. Ouvrez une pull request décrivant le comportement final, les versions testées de l'application et des capacités, les données privées, les services externes et les modifications de permissions. Incluez des étapes de vérification reproductibles.

Mises à jour

Augmentez la version du paquet dans le manifeste et le registre. Ne modifiez schemaVersion qu’en cas de changement du schéma de données privées, avec la migration dans le même paquet. Toute demande d’autorité supplémentaire doit être clairement expliquée et offrir un chemin de refus utilisable.

La signature, l’identité de l’éditeur, l’intégrité du paquet, la provenance de la révision et la révocation sont des sujets distincts. Indiquez les contrôles qui s’appliquent réellement au paquet ; l’isolation du Worker ne garantit pas à elle seule qu’un code arbitraire est sûr.

Créer un plugin · Référence de l’API