Crear una librería Angular con angular-cli y ng-packagr

7
2715

Índice de contenidos


1. Entorno

Este tutorial está escrito usando el siguiente entorno:

  • Hardware: Slimbook Pro 13.3″ (Intel Core i7, 32GB RAM)
  • Sistema Operativo: LUbuntu 16.04
  • Visual Studio Code 1.16.1
  • @angular/cli 1.6.0
  • @angular 5.0.1


2. Introducción

Seguro que a estas alturas ya estáis cansados de escucharme decir que una de las grandezas de Angular es que es altamente reutilizable a través de sus módulos y que podemos encapsularlos en librerías para poder ser utilizadas en otros proyectos de Angular.

Mi consejo es que esta librería tenga el mínimo código de HTML y CSS posible y que se centre en la lógica que quiera resolver y una interfaz “fea” de pruebas.

De esta forma podemos implementar una librería con toda la lógica perfectamente testeada y que podremos reutilizar en proyectos de naturaleza Angular como Ionic y con ciertas restricciones también en NativeScript.

Con esto marcamos la separación entre la lógica y la forma de presentar la solución haciendo que cada rol (desarrollador/arquitecto vs diseñador/ux) invierta el tiempo en lo que realmente es productivo.

Ya os digo yo que cuando tengo que tocar CSS y HTML para que la aplicación quede “bonita” me vuelvo altamente improductivo.


3. Vamos al lío

Existen generadores de Yeoman que facilitan la creación de librerías en Angular: uno de ellos es “generator-angular-library” de mattlewis92 y el otro más conocido es “generator-angular2-library” de jvandemo. Ambos pueden ser útiles pero para mí la forma más cómoda es seguir utilizando la misma herramienta que utilizamos para la implementación de aplicaciones con Angular CLI.

El caso es que a día de hoy no existe un soporte oficial del CLI para la creación de librerías; así que nos tenemos que apoyar en un proyecto llamado “ng-packagr” y seguir los siguientes pasos desde cero.

Para la creación de la librería simplemente creamos un nuevo proyecto con el comando ng.

Una vez creado el proyecto podemos abrirlo con el editor de texto y crear un módulo secundario como ya sabemos con la lógica que queramos compartir, en este caso, lo vamos a simplificar al máximo, porque el objetivo es crear una librería no importa tanto el contenido de la misma.

Vamos a crear un componente asociado al módulo:

Y un servicio también asociado al módulo:

Nota: Como ves no perdemos las ventajas de trabajar con Angular CLI pudiendo hacer uso de los comandos de generación.

Ahora editamos el fichero header.service.ts para añadir un método que devuelva el texto del header.

Este servicio lo instanciamos en el componente, para ello editamos el fichero header.component.ts y establecemos el valor en una propiedad del componente.

Nota importante: si estás usando una versión de Angular inferior a la 6 para tu librería es imprescindible que tanto el HTML como el CSS están definidos de manera “inline” como ves en el ejemplo de arriba. Si no verás que a la hora de cargar la librería en otra aplicación aparecerá un mensaje por consola indicando con un 404 que no encuentra el HTML o el CSS asociados al componente.

Y editamos el fichero header.module.ts para permitir a los usuarios de nuestra librería poder hacer uso del componente HeaderComponent, declarándolo en el array de “exports” y establecemos en el array de “providers” el servicio para poder hacer uso de él de forma interna. En caso de permitir hacer uso del servicio de forma externa tenemos que declarar la función forRoot(), como vemos en el siguiente código:

Nuestra librería tiene implementada toda la funcionalidad que queremos compartir, podemos hacer uso del componente en el fichero app.component.html, importarla en el módulo principal y arrancar la aplicación para verificarlo.

Llega el momento de querer compartir nuestra librería con el mundo,
o por lo menos con los desarrolladores de nuestra empresa. Para ello necesitamos incluir en nuestro proyecto la siguiente dependencia de desarrollo:

Esta librería necesita que creemos dos ficheros en la raíz del proyecto: el primero llamado “ng-package.json” donde indicamos el esquema que tiene que utilizar la librería y donde se encuentra el segundo de los ficheros:

El segundo fichero “public_api.ts” define todos los exports de nuestra librería y se utiliza para generar los .d.ts adecuados.

Ahora editamos el fichero package.json para poner la propiedad private a false, ya que se quiere publicar en algún repositorio de npm ya sea público o privado, y añadimos en la sección de scrips un “task” de npm para ejecutar la herramienta de empaquetado. Además todas las dependencias del proyecto las ponemos como peerDependencies para que sean tenidas en cuenta por el proyecto que vaya a utilizar nuestra librería:

Ahora simplemente ejecutamos:

Y si el proceso es correcto nos generará una carpeta dist con el contenido de nuestra librería listo para publicar y preparado para soportar AOT; además genera los ficheros d.ts del API, los bundles UMD para su ejecución con SystemJS y los ficheros en es5 necesarios para su ejecución en el navegador.

Ahora solo tenemos que entrar dentro de la carpeta dist y ejecutar “npm publish” con los permisos necesarios en el repositorio corporativo o público que tengamos configurado y la librería ya puede ser consumida por nuestros usuarios, simplemente ejecutando en sus proyectos:

Una vez que la librería está instalada ya podemos hacer uso de ella en nuestro proyecto, simplemente declarando el módulo creado en la librería en la sección imports de cualquier @NgModule de la aplicación que vaya a hacer uso de las funcionalidades de la librería.

import {HeaderModule} from ‘my-lib-poc’;


4. Conclusiones

Hasta que exista una solución más oficial por parte de Angular el uso de ng-packagr nos puede ayudar a crear librerías corporativas para reutilizar en nuestros desarrollos con este framework, de una manera muy limpia y cómoda.

Recordad que esta técnica y otras muchas más las encontraréis en la guía práctica de Angular y también ofrecemos cursos in-house y online.

Cualquier duda o sugerencia en la zona de comentarios.

Saludos.

7 Comentarios

  1. Hola buenas tardes, tengo una duda, luego de crear la libreria la quiero tener de manera local en mi maquina sin subirla a ningún repositorio, como puedo incluir la libreria dentro de mis proyectos locales?

    Saludos

    • Hola Kendall,

      En teoría podrías ejecutar dentro del proyecto que vaya a hacer uso de la librería:


      $> npm install --save /path/to/library

      Donde el path apunta a la carpeta que contenga el package.json de la librería (no del proyecto con el que has generado la librería). Digo en teoría porque yo me he encontrado con situaciones en las que haciéndolo de esta forma he tenido problemas de ejecución en el proyecto que hace uso de la librería, que haciéndolo a través de Nexus o a través del registro público de NPM no he tenido.

      Prueba y a ver si tienes suerte 🙂

      Saludos

  2. Hola,

    Gracias por el post, es muy completo.
    Tras haber hecho una librería me encuentro con que el interceptor de la aplicación que la utiliza no captura las peticiones correctamente.
    ¿Conocerías alguna solución al respecto? ¿Tendría que hacer un interceptor específico para la librería?

    Gracias de antemano.

    • Hola Elena,

      Sin conocer el contenido de la librería es complicado darte una respuesta clara… asumo que la librería contiene servicios de proxy (los que utilizan el servicio HttpClient) para recuperar información de un servidor.

      Para poder hacer uso de estos servicios desde la aplicación antes tienes que exponerlos implementando una función forRoot con la propiedad providers de este modo:


      @NgModule({
      imports: [
      CommonModule
      ],
      declarations: [HeaderComponent],
      exports: [HeaderComponent],
      providers: [HeaderService]
      })
      export class HeaderModule {
      public static forRoot(): ModuleWithProviders {
      return {
      ngModule: HeaderModule,
      providers: [
      HeaderService
      ]
      };
      }
      }

      Y dentro del módulo principal de la aplicación o donde vayas a hacer uso de la librería, en la propiedad imports poner HeaderModule.forRoot() de forma que esos providers se añaden al injector principal de tu aplicación. Nota: en caso de que estés utilizando la versión 6 de Angular, con el providerIn ya vienen declarados por defecto y esto no sería necesario.

      En el caso de librería que planteo (no se si es exactamente tu caso) lo normal suele ser tener el interceptor a nivel de librería y declarado de forma interna (sin estar en el forRoot()) de forma que la aplicación ni siquiera tenga que declarar el HttpClientModule; este podría ser un ejemplo:


      @NgModule({
      imports: [
      CommonModule,
      HttpClientModule
      ],
      declarations: [],
      providers: [
      TntLibProxyService,
      TntLibProxyServiceFake,
      {provide: HTTP_INTERCEPTORS, useClass: TntLibAuthInterceptor, multi: true},
      {provide: HTTP_INTERCEPTORS, useClass: TntLibErrorInterceptor, multi: true},
      ]
      })
      export class TntLibModule {
      public static forRoot(config: ConfigLib): ModuleWithProviders {
      return {
      ngModule: TntLibModule,
      providers: [
      {provide: 'config', useValue: config}
      ]
      };
      }
      }

      Espero que con esto te haya orientado en la solución.

      Saludos

  3. Hola, muy bueno tu post!!

    Soy nueva en Angular y me encuentro desarrollando una aplicación que será común para otras aplicaciones y por eso he llegado a este punto. Al grano

    Luego de ejecutar ‘npm install –save my-lib-poc’ como puedo consumirlo? Sorry si la pregunta es muy basica!

    • Hola Rebe,

      Una vez que la librería está instalada en el proyecto donde la vas a usar, lo que tienes que hacer es importar el módulo que has creado en la librería en algún @NgModule de tu proyecto dentro de la propiedad imports.

      Voy a añadir esta parte al tutorial con la esperanza de que quede más claro.

      Muchas gracias por el feedback!

  4. Saludos buen día, muy buena publicación.
    Mi consulta tengo un proyecto demasiado grande en angular. Ahora lo que necesito es transformar un módulo del ese proyecto en una librería, ese modulo tiene sub módulos, componentes, modelados, servicios etc., Para poderlo transformar en una librería con ng-packagr
    1 tendría que pasar a un nuevo proyecto el modulo?
    2 tengo que respetar alguna estructura de datos (como con Yeoman) o suficiente con que el proyecto sea funcional?
    3 Como comparto los enviroments estilos, etc entre una librería y el proyecto que lo consume?.

    Mi problema se centra en probar la librería, que haga lo que tenga que hacer, para solo asi publicarla. Entonces quiero tener claro que herramienta usar (yeoman, ng-packagr u otra)
    Gracias por tu ayuda.

Dejar respuesta

Please enter your comment!
Please enter your name here