Guía de desarrollo plugins

Guía de desarrollo de plugins

Requisitos e instalación de dependencias: Node.js (version >=8.x.x)

Existe una herramienta para crear la estructura base del plugin, se instala con el comando npm install -g api-cnig-create-plugin@latest .

Se tienen que tener en cuenta los requisitos de desarrollo sobre la fachada y la implementación.

Fachada e implementación

En el desarrollo son importantes los conceptos de fachada e implementación. Uno de los objetivos de la API es independizar en la medida de lo posible los desarrollos funcionales de las librerías de mapas en la que se apoyan (OpenLayers, leaflet, etc.), de modo que adaptar un desarrollo a una nueva librería de mapas implique rehacer la menor parte posible.

La API presenta una fachada común a todas las implementaciones con la que el desarrollador podrá realizar la mayoría de acciones. Bajo esta fachada están las distintas implementaciones que realizan las acciones concretas con las librerías en las que se basan.

Por tanto, a la hora de desarrollar un plugin es muy importante llevar a cabo en la fachada del mismo todas las operaciones independientes de la librería de mapas base, y dejar en la implementación las acciones que sí están ligadas a la librería base.

Estructura del proyecto/plugin

/
├── src 📁                  # Código fuente.
    ├── facade     # Fachada.
    ├── impl       # Implementación.
    ├── templates  # Plantilla handlebars.
    ├── api.json   # Definición del plugin por API-REST
    ├── index.json # Punto de entrada.
├── task 🌈                 # Crea el punto de entrada, index.js
├── test 📦                 # Código test.
├── webpack-config 🏗️       # Configuración de Webpack.
├── .eslintrc 👓            # Configuración del ESLint.
├── .gitignore 💾           # Archivos ignorados por Git.
├── LICENSE 📋              # Licencia.
└── ...

Ficheros destacados para la configuración de plugins Dentro de fachada podemos destacar:

1. Estilo

• Fichero css.
• Fichero css fuente.

2. Fuente Los ficheros miplugin.eot, miplugin.svg, miplugin.ttf, miplugin.woff y miplugin.woff2 que generan la fuente del plugin deben estar alojados en /facade/assets/fonts/.
3. Imágenes En caso de que el plugin necesite alojar imágenes se deben alojar en /facade/assets/images (por ejemplo para implementar la ayuda del plugin).
4. Idiomas

• i18n.

5. Código plugin/control

• Fichero js Plugin.
• Fichero js Control.
• Fichero js Control Implementación.

6. Plantillas

• Definición de plantillas.

7. Rest y metadatos

• Definición del REST y metadatos.

8. Documentación

• Definición del README.

Referencias
Por último destacar que, como complemento a esta guía, el desarrollador siempre tendrá de referencia el código fuente de los plugins ya desarrollados.