mapea-create-plugin

Herramienta para el desarrollo de plugins en Mapea

Requisitos e instalación de dependencias

• Node.js (version >=8.x.x)

Instalación de la herramienta

Realizamos la instalación de forma global para disponer de la herramienta en cualquier parte de nuestro equipo:

$ npm install -g mapea-create-plugin

Creación de plugins

1. Creación de plugin base
Tarea que crea la estructura para un nuevo plugin:

$ mapea-create-plugin

Solicitará el nombre del plugin, así como la versión de Mapea sobre la que se desee trabajar. También nos preguntará si queremos que se instalen automáticamente las dependencias del plugin.

:point_right: Para la guía de desarrollo, supondremos que hemos proporcionado el nombre de 'miPlugin'

Creará la estructura de directorios y los ficheros necesarios para la construcción de un plugin dentro de una carpeta con el nombre 'miplugin' en el lugar donde se haya ejecutado la herramienta. Este plugin es autocontenido y ya contiene los scripts de pruebas y compilación, e incluye una funcionalidad básica de ejemplo 'Hola mundo'.

En este punto, deberemos desarrollar la funcionalidad específica de nuestro plugin. Para ello, la guía de desarrollo entra en detalle acerca de los métodos que lo forman y qué debe incluir cada uno. Si es necesaria la instalación de alguna dependencia (p.e. lodash), puede realizarse de forma habitual, ejecutando dentro del directorio del plugin el siguiente comando:

$ npm install --save lodash

El modificador --save o -S sirve para que, además de instalar la dependencia, la añada al fichero package.json, encargado de gestionar dichas dependencias.

Pruebas

Aunque en su fase final un plugin se compilará y generará un único fichero js, durante la fase de desarrollo el código fuente del mismo se organiza en varios ficheros. Para poder testear el plugin entraremos en la carpeta 'miplugin' y ejecutaremos:

npm start

Este comando levantará un entorno de desarrollo que recargará la compilación de webpack automáticamente por cada vez que actualicemos el código de 'miplugin'. El fichero html lo podemos encontrar en 'miplugin/test/dev.html', así como 'miplugin/test/index.js', donde escribiremos el código de pruebas para testear nuestro plugin. En el navegador accedemos a:

http://localhost:6123

Y se nos abrirá la página 'dev.html'.

La estructura del plugin creado contendrá una carpeta '/src/config' con dos ficheros de ejemplo que contienen una constante donde pueden definirse valores de configuración. El uso de esta configuración es opcional y alternativa a la parametrización del propio plugin. En caso de utilizarla, se puede lanzar la prueba contra uno de esos ficheros de configuración, para utilizar los valores que defina internamente:

npm start -- --env $id_config

Donde $id_config es el valor de la extensión del fichero previa al .js. Por ejemplo:

// para usar el fichero config.dev.js
npm start -- --env dev
// para usar el fichero config.pro.js
npm start -- --env pro

Lanzado así, desde cualquier parte de la lógica del plugin se podrá acceder al objeto de configuración definido, que por defecto se llama $nombrepluginconfig. El programador puede crear tantos ficheros de configuración como necesite.

2.- Check plugin
Tarea para validar código con ESLint:

$ npm run check

También se facilita un script de npm para arreglar la mayoría de los erorres de typing que se cometen mientras se desarrolla.

$ npm run fix

3.- Build plugin
Compila y minimiza los plugins creados. Aunque el plugin está compuesto por varios ficheros javascript y de estilo, para mejorar la eficiencia en su uso, la versión final de los plugins se compila y comprime, generando un único fichero css y un único fichero js:

$  npm run build

Se generará en la carpeta 'build/miplugin' los ficheros css y js comprimidos finales.

Si se han usado para el desarrollo ficheros de configuración opcionales alternativos a la parametrización del plugin tal como se ha descrito con anterioridad, se debe especificar el fichero a utilizar para la compilación:

$  npm run build -- --env $id_config

En caso de que queramos testear en modo producción solo tendremos que hacer:

npm run test-build

Esto levantará un http-server que consumirá los recursos generados en build, simulando un servidor den producción. El código adcional que queramos ejecutar, tendremos que escribirlo en 'prod.html' en la carpeta 'src/tests'.

:point_right: Importante haber hecho antes npm run build o no tendremos creada la compilación del plugin, que es donde apunta