Cómo crear, probar y publicar un paquete de NPM con TypeScript

Cómo crear, probar y publicar un paquete de NPM con TypeScript

Si eres desarrollador Node.js y quieres compartir utilidades o crear librerías reutilizables, publicar un paquete NPM con TypeScript es una excelente opción. En este artículo revisamos paso a paso cómo crear, probar y publicar un paquete llamado string-manipulate, junto con buenas prácticas para que tu paquete sea usable por otros proyectos y equipos.

1. Crear un nuevo proyecto NPM

Crea la carpeta y genera el package.json inicial con los comandos: mkdir string-manipulate cd string-manipulate npm init -y

2. Añadir TypeScript al proyecto

Instala TypeScript y los tipos de Node de desarrollo: npm install typescript --save-dev npm install @types/node --save-dev Inicializa TypeScript: npx tsc --init y configura el tsconfig para emitir declaraciones y compilar a CommonJS, por ejemplo indicando target ES2017, module CommonJS, declaration true, outDir dist, strict true e incluyendo la carpeta src.

3. Añadir el código fuente

Crea la estructura y el archivo principal: mkdir src y añade las funciones principales en src/index.ts como reverse y capitalize implementadas con TypeScript para que se generen las tipificaciones al compilar.

4. Añadir tests

Es recomendable probar tu paquete. Usa Jest con soporte TypeScript: npm install --save-dev jest ts-jest @types/jest e inicializa la configuración con npx ts-jest config:init. Escribe tests en una carpeta tests que verifiquen el comportamiento de reverse y capitalize y ejecútalos con el script test.

5. Compilar el proyecto

Añade los scripts en package.json para build y test, por ejemplo build ejecuta tsc y test ejecuta jest. Compila con npm run build para generar la carpeta dist con los artefactos JavaScript y los archivos .d.ts con las definiciones de tipo.

6. Preparar package.json para publicar

Actualiza los campos relevantes como name string-manipulate, version 1.0.0, main dist/index.js, types dist/index.d.ts y files con dist para asegurarte de que se publiquen solamente los archivos compilados. El campo types facilita que usuarios TypeScript obtengan autocompletado y verificación de tipos al instalar tu paquete.

7. Probar el paquete localmente

Puedes usar npm link para probar el paquete localmente sin publicar: en la carpeta del paquete ejecuta npm link y luego en otro proyecto instala el enlace con npm link string-manipulate. Cuando compiles de nuevo con npm run build los cambios estarán disponibles gracias al enlace simbólico.

8. Iniciar sesión en NPM

Antes de publicar haz login en el registro con npm login y sigue las indicaciones para usuario, contraseña y email.

9. Publicar el paquete

Construye una vez más con npm run build y publica con npm publish. Tu paquete estará disponible para que otros lo instalen con npm install string-manipulate.

Ejemplo de uso

Una vez instalado puedes importar las funciones y usarlas en tu aplicación para invertir cadenas o capitalizar la primera letra, aprovechando las definiciones de tipo generadas por TypeScript para una mejor experiencia de desarrollo.

Buenas prácticas y automatización

Considera añadir integración continua para ejecutar tests y publicar automáticamente versiones controladas. Podemos ayudarte a añadir GitHub Actions para auto publicacion, configurar semantic-release o crear una plantilla README con ejemplos y badges.

Sobre Q2BSTUDIO

En Q2BSTUDIO somos una empresa de desarrollo de software y aplicaciones a medida especializada en soluciones que incluyen inteligencia artificial, ciberseguridad y servicios cloud. Ofrecemos desarrollo de software a medida y aplicaciones multicloud integradas con AWS y Azure, además de servicios de inteligencia de negocio y visualización con power bi. Si necesitas desarrollar una solución personalizada o integrar agentes IA y otras soluciones de ia para empresas visita nuestra página de aplicaciones a medida en desarrollo de aplicaciones y software multiplataforma y conoce también nuestros servicios especializados en inteligencia artificial para empresas.

Palabras clave

aplicaciones a medida, software a medida, inteligencia artificial, ciberseguridad, servicios cloud aws, azure, servicios inteligencia de negocio, ia para empresas, agentes IA, power bi

Si quieres, desde Q2BSTUDIO podemos acompañarte en todo el proceso: desde crear la librería y automatizar su publicación hasta integrar el paquete en tu ecosistema de aplicaciones a medida y pipelines de CI CD. Pregúntanos y te proponemos la mejor opción para tu caso.