La création d’un plugin dans Discourse peut être très simple, une fois que vous connaissez quelques particularités. L’objectif de cet article est de créer un squelette de plugin et de vous familiariser avec les bases.
Votre environnement de développement
Assurez-vous d’avoir un environnement de développement de Discourse fonctionnant sur votre ordinateur. Je vous recommande d’utiliser le guide de configuration approprié et de revenir quand vous aurez terminé.
plugin.rb
Utilisez GitHub - discourse/discourse-plugin-skeleton: Template for Discourse plugins · GitHub pour créer un squelette de plugin Discourse complet dans votre répertoire plugins
Le squelette est désormais intégré au cœur de Discourse.
rake plugin:create[nom-du-plugin]créera un plugin en utilisant le squelette.
Au démarrage, Discourse cherche dans le répertoire plugins des sous-répertoires contenant un fichier plugin.rb. Le fichier plugin.rb a deux objectifs : c’est le manifeste de votre plugin avec les informations requises à son sujet, notamment : son nom, vos coordonnées et une description. Le second objectif est d’initialiser tout code Ruby nécessaire au fonctionnement de votre plugin.
Dans notre cas, nous n’ajouterons aucun code Ruby, mais nous avons tout de même besoin du fichier plugin.rb. Créons le répertoire basic-plugin avec le fichier plugin.rb à l’intérieur, contenant le code suivant :
basic-plugin/plugin.rb
# name: basic-plugin
# about: Un plugin très simple pour démontrer le fonctionnement des plugins
# version: 0.0.1
# authors: Awesome Plugin Developer
# url: https://github.com/votreutilisateur/basic-plugin
Une fois ce fichier créé, vous devez redémarrer votre serveur local et le plugin devrait être chargé.
Un piège important !
Si vous êtes habitué au développement Rails classique, vous remarquerez peut-être que les plugins ne sont pas aussi conviviaux en matière de rechargement. En général, lorsque vous apportez des modifications à votre plugin, vous devez appuyer sur Ctrl+c pour arrêter le serveur, puis le relancer avec bin/dev.
Mes modifications n’ont pas été prises en compte ! 
Il arrive parfois que le cache ne soit pas entièrement vidé, surtout lorsque vous créez de nouveaux fichiers ou supprimez d’anciens fichiers. Pour contourner ce problème, supprimez votre dossier tmp et relancez Rails. Sur un Mac, vous pouvez le faire en une seule commande : rm -rf tmp; bin/dev.
Vérification que votre plugin a été chargé
Une fois que vous avez redémarré votre serveur local, visitez l’URL /admin/plugins (assurez-vous d’abord d’être connecté avec un compte administrateur, car seuls les administrateurs peuvent voir le registre des plugins).
Si tout a fonctionné, vous devriez voir votre plugin dans la liste :
Félicitations, vous venez de créer votre premier plugin !
Ajoutons du Javascript
Pour l’instant, votre plugin ne fait rien. Ajoutons un fichier javascript qui affichera une boîte d’alerte au chargement de Discourse. Cela sera très gênant pour tout utilisateur et n’est pas recommandé comme véritable plugin, mais cela montrera comment insérer du Javascript dans notre application en cours d’exécution.
Créez le fichier suivant :
plugins/basic-plugin/assets/javascripts/discourse/initializers/alert.js
export default {
name: "alert",
initialize() {
alert("Les boîtes d'alerte sont gênantes !");
},
};
Si vous redémarrez maintenant votre serveur local, vous devriez voir « Les boîtes d’alerte sont gênantes ! » apparaître à l’écran. (Si ce n’est pas le cas, consultez le titre « Mes modifications n’ont pas été prises en compte » ci-dessus).
Examinons comment cela a fonctionné :
-
Les fichiers Javascript placés dans
assets/javascripts/discourse/initializerssont exécutés automatiquement lorsque l’application Discourse se charge. -
Ce fichier particulier
exportun objet, qui possède unename(nom) et une fonctioninitialize. -
Le
namedoit être unique, je l’ai donc simplement appeléalert. -
La fonction
initialize()est appelée lorsque l’application se charge. Dans notre cas, elle se contente d’exécuter notre codealert().
Préchargement des données pour le frontend
Utilisez register_preloaded_data dans plugin.rb pour inclure des données dans la réponse HTML initiale sans demande supplémentaire :
after_initialize do
register_preloaded_data("visibility") do |guardian|
{ can_access: guardian.authenticated? }
end
end
Le cœur de Discourse préfixe la clé par les métadonnées # name: du plugin. Pour le basic-plugin ci-dessus, lisez la valeur analysée dans un initializer du frontend avec :
import PreloadStore from "discourse/lib/preload-store";
const visibility = PreloadStore.get("basic-plugin:visibility");
Le bloc s’exécute pour chaque chargement de page rendant la mise en page de l’application, reçoit le Guardian de la requête et renvoie une valeur sérialisable en JSON. Ces valeurs sont distinctes de la charge utile du site anonyme mise en cache. Renvoyez nil pour omettre une entrée ; false est inclus. Les blocs des plugins désactivés sont ignorés. Limitez la portée des données sensibles à l’utilisateur demandeur via le Guardian.
Vous êtes maintenant un développeur de plugins Discourse officiel !
Plus dans cette série
Partie 1 : Ce sujet
Partie 2 : Les Plugin Outlets
Partie 3 : Paramètres du site
Partie 4 : Configuration de Git
Partie 5 : Interfaces d’administration
Partie 6 : Tests d’acceptation
Partie 7 : Publiez votre plugin
Ce document est sous contrôle de version - suggérez des modifications sur GitHub.

