Crear y publicar un paquete NPM en 4 sencillos pasos

Escrito por Manuel Aguilar Rodriguez

3 de diciembre de 2019

La mayoría de nosotros que programamos en node.js hemos tenido esa inquietud pero ¿qué tan difícil es hacerlo?

Muchas veces realizamos funciones en node.js que necesitamos implementar en otros códigos que realizamos o creamos funciones geniales que queremos compartir con la comunidad o simplemente tenemos la curiosidad de como se hacen los paquetes, publicar nuestra función es sencillo y vamos a resumirlo en 4 pasos, primero veremos las herramientas que necesitamos:

Paso 1: Debemos tener una cuenta en npm si no es así, podemos crear una cuenta y registrarnos en: signup, allí se llenarán unos datos, posteriormente debemos autenticarnos en nuestra consola con el comando npm login e ingresar nuestras credenciales:

Podemos corroborar nuestra identidad usando el comando npm whoami:

Paso 2: Ahora crearemos nuestro paquete, para esto lo haremos de la misma forma que iniciamos nuestros proyectos, con el comando npm init, aquí tomaremos ciertas consideraciones al momento de crear nuestro paquete, podemos consultar la guía para nombrar el paquete: guía-nombre-paquetes.

Al completar los pasos se creará el archivo más importante de nuestro paquete, package.json, allí contiene la información esencial para que nuestro paquete funcione, contendrá algo como:

El nombre del paquete que cree es hello-world-package-m4nny, ese nombre será el que usaremos para poder instalarlo.

Paso 3: Agregaremos algo de código a nuestro proyecto en el archivo index.js, allí las funciones que agreguemos y que queremos que sean accesibles por cualquiera que use nuestro paquete tienen que ser exportables por ejemplo agregaremos una función que reciba una cadena y nos imprima el mensaje de hola y agregaremos otra función que realice la sumatoria de 0 hasta el número especificado:

funciones de nuestro paquete a publicar

Paso 4: Ahora publicaremos nuestro paquete con el comando npm publish, si el nuestro paquete se publicó adecuadamente podemos visualizarlo desde nuestra cuenta de npm y podremos hacer uso de él en nuestros otros proyectos con el comando npm install

Publicando nuestro paquete

¡Listo! Ahora probaremos nuestro paquete, para esto crearemos un proyecto, instalaremos nuestro paquete con el comando:

npm install hello-world-package-m4nny

Instalación del paquete a nuestro nuevo proyecto

Lo usaremos en nuestro nuevo proyecto implementandolo como cualquier paquete:

Implementamos nuestro paquete en el nuevo proyecto y llamamos las funciones

Ahora solo basta con ejecutar el código con el comando node index.js y listo todo funciona adecuadamente.

Resultado de la ejecución

El crear un paquete para compartirlo con el mundo es sencillo así que ahora a ¡publicar!.

Referencias:

npm

https://docs.npmjs.com/package-name-guidelines

https://docs.npmjs.com/about-package-readme-files


Crear y publicar un paquete NPM en 4 sencillos pasos was originally published in 200 Response on Medium, where people are continuing the conversation by highlighting and responding to this story.