Aller au contenu
Vérifié

Types de plugins

Six valeurs de plugin_type sont réellement utilisées aujourd'hui : ui, widget, library, dbs, framework et graphics.

Chaque plugin déclare un plugin_type quand il est envoyé. upload_plugin le compare à une liste fixe avant d'accepter quoi que ce soit : dbs, widget, graphics, library, platform, framework, util, ui. platform et util sont acceptés mais réservés ; les six types ci-dessous sont ceux que les plugins utilisent.

La liste des types du tableau de bord n'est pas non plus codée en dur

Le filtre de type de l'onglet Plugins est construit en lisant les valeurs distinctes de plugin_type des plugins réellement installés dans le projet, et non à partir d'une liste fixe. Les six types ci-dessous sont ce que cela produit en pratique.

Les six types

Convention de nommage

Le nom de dossier de chaque plugin de première partie encode son type : xuda-<kind>-plugin-<name> (par exemple xuda-ui-plugin-moment, xuda-dbs-plugin-couchdb). C'est une convention que suivent les plugins de première partie, pas une règle que la plateforme impose ; c'est le plugin_type à l'envoi qui décide réellement du type, et un plugin tiers peut nommer son paquet comme il l'entend.

Dépendre d'un autre plugin

Un plugin peut déclarer dependent_plugin_id, qui nomme un autre plugin dont il a besoin. install_plugin, save_plugin_setup et get_plugin_setup vérifient deux choses avant de faire quoi que ce soit pour un plugin dépendant : que le plugin nommé est déjà installé dans le projet, et que la liste authorized_plugins du plugin nommé inclut ce plugin. Un plugin pivot (par exemple un plugin framework ou dbs sur lequel d'autres plugins sont construits) accepte d'être une dépendance en listant les dépendants qu'il autorise ; rien ne s'installe contre lui en silence.