Cómo Crear Tu Primer Paquete y publicarlo en NPM

Luis Fernando CS — Tue, 17 Dec 2024 22:40:38 +0000

Publicar nuestro propio paquete en NPM (Node Package Manager) es una excelente manera de compartir, aprender el código con la comunidad o facilitar la reutilización en nuestros propios proyectos. En esta guía, aprenderemos paso a paso cómo crear, configurar y publicar nuestro primer paquete en NPM.

1. ¿Qué es un paquete de NPM?

Un paquete de NPM es un módulo de JavaScript que puedes instalar y usar en proyectos Node.js. Puede ser tan simple como una función reutilizable o tan complejo como una librería completa.

2. Requisitos Previos

Antes de empezar, tenemos que asegurarnos de cumplir con los siguientes requisitos:

Node.js y NPM instalados: Descarga e instala desde Node.js.
Cuenta en NPM: Regístrate en npmjs.com.
Editor de código: Como VS Code, para escribir y organizar tu proyecto.

3. Configurar tu Proyecto

Paso 1: Crear una carpeta para tu paquete
Abre tu terminal y crea una carpeta:

mkdir mi-primer-paquete
cd mi-primer-paquete

Abrimos la carpeta en nuestro editor de código:

code .

Paso 2: Inicializar el proyecto
Ejecutamos el siguiente comando para crear un archivo package.json:

npm init

Responde las preguntas o usa npm init -y para aceptar los valores por defecto.

Revisa el archivo package.json generado. Debería verse algo así:

{
  "name": "mi-primer-paquete",
  "version": "1.0.0",
  "description": "Mi primer paquete publicado en NPM",
  "main": "index.js",
  "scripts": {},
  "keywords": ["npm", "paquete", "tutorial"],
  "author": "Tu Nombre",
  "license": "MIT"
}

Paso 3: Crear el archivo principal

Crea un archivo llamado index.js en la raíz del proyecto:

touch index.js
Añade una función simple como ejemplo:

function holaMundo() {
    return "¡Hola, mundo!";
}
module.exports = holaMundo;

4. Publicar el Paquete

Paso 1: Iniciar sesión en NPM
Ejecuta el siguiente comando en tu terminal y sigue las instrucciones para iniciar sesión:

npm login

Paso 2: Publicar el paquete
Ejecuta este comando para publicar tu paquete en NPM:

npm publish
¡Listo! Ahora tu paquete estará disponible públicamente en NPM.

5. Probar el Paquete

Para asegurarnos de que tu paquete funciona, pruébalo instalándolo en otro proyecto:

Crea una nueva carpeta para pruebas:

mkdir prueba-paquete
cd prueba-paquete

Inicializa un proyecto y luego instala el paquete:

npm init -y
npm install mi-primer-paquete

Usa el paquete en un archivo:

const holaMundo = require("mi-primer-paquete");

console.log(holaMundo()); // ¡Hola, mundo!

6. Actualizar un Paquete

Si necesitamos hacer cambios, simplemente actualiza el código, incrementa la versión en package.json (por ejemplo, cambia "version": "1.0.0" a "version": "1.0.1") y volvemos a publicarlo:

npm publish

Aprendiendo JavaScript

Luis Fernando CS — Sun, 22 Oct 2023 02:44:25 +0000

Hola, aqui Fernando y me puse la meta de documentar todo lo que aprendo relacionado con el desarrollo web, ya que es una de mis pasiones poder desarrollar y bueno no soy un experto de hecho servira mucho todo lo que escriba para repasar contenidos y aprender junto con ustedes sin más que decir estoy super ansioso de compartir 🧑🏽‍💻
console.log("hello world")

DEV Community: Luis Fernando CS