Aller au contenu
Vérifié

Le manifeste du plugin

Six fichiers qu'un plugin peut fournir, chacun un point d'entrée différent, et le manifeste qui enregistre lesquels existent.

Le manifeste d'un plugin n'est pas un fichier que vous écrivez. Il est calculé par la plateforme au moment où un plugin est envoyé : validate_plugin() cherche sur disque exactement six noms de fichier, enregistre ceux qui existent (et si chacun a été trouvé à la racine du paquet ou sous dist/), puis sauvegarde le résultat sous doc.manifest dans le document de catalogue du plugin. Tout ce qui vient ensuite, le chargeur du runtime, l'écran de consentement à l'installation, le bouton de configuration du tableau de bord, lit ce manifeste plutôt que de sonder lui-même le paquet.

Les six fichiers

Un plugin fournit ceux de ces fichiers dont son type a besoin. plugins/@xuda.io/xuda-ui-plugin-moment/src n'a que index.mjs et runtime.mjs ; plugins/@xuda.io/xuda-library-plugin-xlsx a index.mjs et server.mjs ; plugins/@xuda.io/xuda-dbs-plugin-couchdb a index.mjs et server.mjs.

Racine ou dist/

validate_plugin() cherche chaque fichier d'abord à la racine du paquet, puis à dist/<file>. L'un ou l'autre emplacement satisfait le manifeste : un plugin construit avec Vite (la plupart de ceux sous plugins/@xuda.io/) fournit sa source sous src/ et laisse sa construction écrire les fichiers du manifeste dans dist/.

Le CSS ne se charge que depuis dist

runtime.css (et tout autre CSS du manifeste) n'est pris en compte que si son .mjs correspondant a été trouvé sous dist/, jamais depuis la racine du paquet. Le runtime vérifie manifest[resource].dist && manifest[resource].css avant de récupérer la feuille de style : un plugin avec un runtime.mjs à la racine et un style.css à la racine passe la validation (exist: true pour les deux), mais le runtime ne charge jamais le CSS. Livrez via dist/ si le plugin a besoin que sa feuille de style se charge réellement.

À quoi sert le manifeste

  • Charger un plugin d'interface. Le runtime refuse purement et simplement d'exécuter un plugin d'interface si le manifeste ne montre pas à la fois runtime.mjs et index.mjs ; il importe alors index.mjs pour properties, résout la valeur de chaque propriété (y compris les liaisons d'expression xu-exp:) à partir des attributs de l'élément, importe runtime.mjs, et appelle fn.
  • L'écran de consentement à l'installation. La présence dans le manifeste se transforme directement en phrases que l'utilisateur lit avant d'installer : fournir server.mjs dit « Exécute son propre code sur les serveurs de Xuda, à l'intérieur de votre projet » ; fournir runtime.mjs dit « Exécute son propre code dans votre application publiée, dans le navigateur de tous ceux qui l'utilisent » ; studio.mjs et setup.mjs ont aussi leurs propres lignes.
  • Le bouton Configuration du tableau de bord. L'écran de configuration d'un plugin ne s'affiche que si manifest['index.mjs'].exist est vrai et que ce module n'est pas vide, ou si le plugin a une dépendance avec sa propre configuration.