Crear un plugin en Discourse puede ser realmente 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 ejecutándose en tu computadora. Te recomiendo que uses la guía de configuración correspondiente y vuelvas 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
El esqueleto ahora está incluido en el núcleo de Discourse;
rake plugin:create[plugin-name]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 así 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: Un plugin súper simple para demostrar cómo funcionan los plugins
# version: 0.0.1
# authors: Awesome Plugin Developer
# url: https://github.com/yourusername/basic-plugin
Una vez que hayas creado este archivo, deberás reiniciar tu servidor local y el plugin debería cargarse.
¡Un detalle importante!
Si estás acostumbrado al desarrollo regular de Rails, podrías notar que los plugins no son tan amigables cuando se trata de recargar. En general, cuando hagas cambios en tu plugin, deberás presionar Ctrl+c para detener el servidor y luego ejecutarlo nuevamente usando bin/dev.
¡Mis cambios no se aplicaron! 
A veces la caché no se borra por completo, especialmente cuando creas nuevos archivos o eliminas archivos antiguos. Para solucionar este problema, elimina tu carpeta tmp y reinicia Rails. En un Mac puedes hacerlo con un solo comando: rm -rf tmp; bin/dev.
Verificar que tu plugin se cargó
Una vez que hayas reiniciado tu servidor local, visita la URL /admin/plugins (asegúrate de iniciar sesión como cuenta de administrador primero, ya que solo los administradores pueden ver el registro de plugins).
Si todo funcionó, deberías ver tu plugin en la lista:
¡Felicidades, 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 de alerta cuando Discourse se cargue. Esto será súper 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("¡Las ventanas de alerta son molestas!");
},
};
Ahora, si reinicias tu servidor local, deberías ver aparecer “¡Las ventanas de alerta son molestas!” en la pantalla. (Si no fue así, consulta el encabezado “¡Mis cambios no se aplicaron!” anterior).
Repasemos 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 en particular
exportaun objeto, que tiene unnamey 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, solo ejecuta nuestro códigoalert().
¡Ahora 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: git setup
Parte 5: Admin interfaces
Parte 6: Acceptance tests
Parte 7: Publish your plugin
Este documento está controlado por versiones - sugiere cambios en github.