Crear un plugin en Discourse puede ser muy sencillo una vez que aprendes algunos trucos. El objetivo de esta publicación es crear un plugin básico y presentarte los fundamentos.
Tu entorno de desarrollo
Asegúrate de tener un entorno de desarrollo de Discourse funcionando en tu computadora. Te recomiendo utilizar la guía de configuración adecuada y volver cuando hayas terminado.
plugin.rb
Usa GitHub - discourse/discourse-plugin-skeleton: Template for Discourse plugins · GitHub para crear un esqueleto completo de plugin de Discourse en tu directorio de plugins
Ahora el esqueleto viene incluido en el núcleo de Discourse,
rake plugin:create[nombre-del-plugin]creará un plugin utilizando el esqueleto
Cuando Discourse se inicia, busca en el directorio plugins subdirectorios que contengan un archivo plugin.rb. El archivo plugin.rb tiene dos propósitos: es el manifiesto de tu plugin con la información requerida sobre tu plugin, incluyendo: su nombre, información de contacto y una descripción. El segundo propósito es inicializar cualquier código ruby necesario para ejecutar tu plugin.
En nuestro caso, no añadiremos ningún código ruby pero aún necesitamos el plugin.rb. Creemos el directorio basic-plugin con el archivo plugin.rb dentro, con el siguiente contenido:
basic-plugin/plugin.rb
# name: basic-plugin
# about: A super simple plugin to demonstrate how plugins work
# version: 0.0.1
# authors: Awesome Plugin Developer
# url: https://github.com/yourusername/basic-plugin
Una vez que hayas creado este archivo, deberías reiniciar tu servidor local y el plugin debería cargarse.
¡Un detalle importante!
Si estás acostumbrado al desarrollo habitual con rails, es posible que notes que los plugins no son tan cómodos cuando se trata de recargar. En general, cuando hagas cambios en tu plugin, deberías pulsar Ctrl+c para detener el servidor y luego ejecutarlo de nuevo usando bin/dev.
¡Mis cambios no se aplicaron! 
A veces la caché no se limpia completamente, especialmente cuando creas nuevos archivos o eliminas antiguos. Para resolver este problema, elimina tu carpeta tmp y reinicia rails de nuevo. En un Mac puedes hacerlo con un solo comando: rm -rf tmp; bin/dev.
Comprobando que tu plugin se ha cargado
Una vez que hayas reiniciado tu servidor local, visita la url /admin/plugins (asegúrate de estar iniciado sesión como una cuenta de administrador primero, ya que solo los administradores pueden ver el registro de plugins).
Si todo funcionó correctamente, deberías ver tu plugin en la lista:
¡Enhorabuena, acabas de crear tu primer plugin!
Añadamos algo de Javascript
Por ahora tu plugin no hace nada. Añadamos un archivo javascript que mostrará una ventana emergente de alerta cuando Discourse se cargue. Esto será muy molesto para cualquier usuario y no se recomienda como un plugin real, pero mostrará cómo insertar Javascript en nuestra aplicación en ejecución.
Crea el siguiente archivo:
plugins/basic-plugin/assets/javascripts/discourse/initializers/alert.js
export default {
name: "alert",
initialize() {
alert("alert boxes are annoying!");
},
};
Ahora, si reinicias tu servidor local, deberías ver que aparece «alert boxes are annoying!» en la pantalla. (Si no lo viste, consulta el encabezado «Mis cambios no se aplicaron» más arriba).
Vamos a analizar cómo funcionó esto:
-
Los archivos Javascript colocados en
assets/javascripts/discourse/initializersse ejecutan automáticamente cuando la aplicación Discourse se carga. -
Este archivo específico
exports un objeto, que tiene unanamey una funcióninitialize. -
El
namedebe ser único, así que simplemente lo llaméalert. -
La función
initialize()se llama cuando la aplicación se carga. En nuestro caso, lo único que hace es ejecutar nuestro códigoalert().
Precarga de datos para el frontend
Usa register_preloaded_data en plugin.rb para incluir datos en la respuesta HTML inicial sin una solicitud adicional:
after_initialize do
register_preloaded_data("visibility") do |guardian|
{ can_access: guardian.authenticated? }
end
end
Core añade un prefijo a la clave con el metadato # name: del plugin. Para el basic-plugin anterior, lee el valor analizado en un initializer del frontend con:
import PreloadStore from "discourse/lib/preload-store";
const visibility = PreloadStore.get("basic-plugin:visibility");
El bloque se ejecuta para cada carga de página que renderiza el diseño de la aplicación, recibe el Guardian de la solicitud y devuelve un valor serializable en JSON. Estos valores son independientes del payload del sitio anónimo en caché. Devuelve nil para omitir una entrada; false sí se incluye. Los bloques de plugins deshabilitados se omiten. Restringe los datos sensibles al usuario que realiza la solicitud a través del Guardian.
¡Ya eres un desarrollador oficial de plugins de Discourse!
Más en la serie
Parte 1: Este tema
Parte 2: Plugin Outlets
Parte 3: Site Settings
Parte 4: Configuración de git
Parte 5: Interfaz de administración
Parte 6: Acceptance tests
Parte 7: Publica tu plugin
Este documento está controlado por versiones: sugiere cambios en github.

