Cómo agregar la medalla “dependencies” a tu repositorio

Este tutorial es la tercera parte de una serie de tutoriales que explican cómo crear un paquete NPM, con medallas y actualizaciones automáticas.

Hasta ahora hemos visto:

1. Cómo crear tu primer módulo NPM
2. Cómo agregar la medalla “build” a tu repositorio de Github

Ahora veremos cómo agregar la medalla🏅 de dependencies.

Medalla de dependencies 🏅

Esta medalla indica que las dependencias (módulos npm que importaste) estén actualizados.

Muchas veces pasa que el código va quedando obsoleto, con problemas de eficiencia o incluso de seguridad. Para evitar este problema, la comunidad Open Source va subiendo actualizaciones de librerías, para lo cual debemos estar atentos.

La mellada de dependencies hace precisamente eso: analiza que los packages que utiliza tu módulo estén actualizados y que no tengan problemas graves.

¿Cómo agregar la medalla de dependencies?

En este caso utilizaremos a David :

YOU DEPEND ON OTHER PROJECTS.
YOU WANT TO STAY UP TO DATE.
DAVID’S GOT YOUR BACK.

Paso 1: Agregar dependencias a nuestro proyecto

Bueno… lo primero que debemos hacer es agregar dependencias.

En este caso, agregaré a Piñericosas la librería lodash:

npm install --save lodash

Y actualizaré el código para usarla:

Puedes ver los cambios aquí.

Paso 2: Inicia sesión en david-dm

Puedes hacerlo con tu misma cuenta de Github:

Ahora verás lo siguiente:

Básicamente debes reemplazar username por tu nombre de usuario en Github (el mío es muZk) y repo por el nombre del repositorio (en mi caso pinericosas):

https://david-dm.org/muZk/pinericosas.svg

Y debemos agregar eso a nuestro README.me

Paso 3: Agregar badge a nuestro README.md

Para agregar la imagen, simplemente tienes que copiar y pegar algo similar a esto:

[![dependencies Status](https://david-dm.org/muZk/pinericosas/status.svg)](https://david-dm.org/muZk/pinericosas)

Reemplazando el username y el repositorio por tus valores.

Puedes ver el commit de ejemplo aquí.

PD: No olvides publicar los cambios de tu librería con npm publish

TLDR;

• Crear cuenta en David
• Obtener link de la imagen de dependencias. El formato es simple: https://david-dm.org/username/repo.svg (username → tu nombre de usuario de Github, repo → el nombre del repositorio)
• Actualizar README.md para incluir la imagen del badge (ver commit de ejemplo).

Palabras finales

Ahora sabes cómo agregarle una medalla de dependencies a tu proyecto ❤

Recuerda que esto es útil para ti y a los que usan tu módulo, ya que gracias a esto pueden saber qué tan actualizadas están las librerías que tu proyecto.

Si te has dado cuenta, hasta ahora las publicaciones a NPM han sido muy manuales:

1. Actualizar código.
2. Actualizar versión package.json(y procurar no equivocarte en los números de la versión 😂).
3. Subir código a Github (git push).
4. Subir código a NPM.

(Y eso que todavía no me he metido con los git tags).

¿Qué tal si pudieras hacer todo esto con un simple commit?

Yup… es posible👌.

El siguiente tutorial será el último de esta mini serie: “Cómo automatizar la publicación de tu módulo NPM.” 👍

Otras entradas de esta serie:

1. Cómo crear tu primer módulo NPM
2. Cómo agregar la medalla “build” a tu módulo NPM.
3. Cómo agregar la medalla “dependencies” a tu módulo NPM.
4. Cómo automatizar la publicación de tu módulo NPM.