? Escribir y publicar un código mínimo.

Para publicar una biblioteca en npm, necesitarás:

1. Una cuenta npm; puedes registrarte aquí.

2. Tu código como proyecto; es decir, tiene un package.json en su directorio de códigos, que tiene el nombre y la versión especificados. Tenga en cuenta que puede generar este archivo a través de:
   

npm init

1. Un index.js en tu proyecto. Recuerde, debe exportar su función para permitir que los usuarios la importen.

Nota: Si su secuencia de comandos no se llama index.js y no se encuentra en la raíz del proyecto, debe especificar la propiedad "principal" en package.json. Consulte esta respuesta para obtener más información.

Y si el nombre se tomó en npm, puede agregar un prefijo como @name-or-org/your-lib; eso es lo que hacen la mayoría de las bibliotecas hoy en día.

Puedes consultar mi ejemplo mínimo como referencia, pero creo que puedes escribir algo mejor que esto.

Finalmente, publíquelo con el comando CLI:

npm publish

Nota para las personas que configuran el nombre del paquete con un prefijo: DEBE ser su nombre de usuario de npm o el nombre de la organización que registró en npm. Por ejemplo, puedo usar @remi_guan como prefijo pero no otros.

Además, debe ejecutar npm Publish --access public, porque npm cree que desea publicar un paquete privado, que es una función paga.

Este resultado significa que ha sido exitoso. Sin embargo, si tuvo algún problema, puede buscar en Google para solucionarlo. Y así es como puedes usar tu propia biblioteca:

Si has estado siguiendo esta guía, prueba con tu propia biblioteca.

También descubrí que @backendbro tiene una guía mucho más detallada que esta, si deseas saber más.

Después de haber publicado su código, cuando desee actualizarlo, puede ejecutar npm Publish nuevamente. Sin embargo, antes de publicarlo, debe actualizar la propiedad de versión de package.json y cumplir con el control de versiones semántico.

¡Te sugiero que lo pruebes! ¿Puedes publicar la versión 1.0.1 o 1.1.0 de tu biblioteca y usarla en otro proyecto como el que acabo de hacer? ¿Puedes descubrir cómo actualizar la versión de tu biblioteca npm?

? Usar mecanografiado

Esta biblioteca que hemos creado hasta ahora no es moderna, carece de declaración de tipo, por lo que las personas que usan su biblioteca no pueden resaltarse al escribir. Además, la gente suele utilizar TypeScript con sintaxis ECMAScript. Para conocer la diferencia: Módulos Node.js: CommonJS vs. ECMAScript por Saisathish

Pero voy a omitir la configuración detallada de TypeScript en esta publicación. Hay muchos buenos tutoriales para aprender a inicializar un proyecto de TypeScript, como “Cómo desarrollar una biblioteca de TypeScript” de inapeace0.

Aún más, puedes usar un repositorio de plantillas de TypeScript como alexjoverm/typescript-library-starter que ya ha integrado muchas herramientas modernas, mejores prácticas, etc.

Solo voy a mencionar algunas notas importantes si estás publicando una biblioteca de TypeScript:

1. Compile antes de publicar. Si necesita publicarlo al público, las personas con el entorno Node.js más común solo pueden ejecutar archivos .js. Por lo tanto, debe compilar su código con tsc, rollup (o vite, que usa rollup) o webpack; cualquiera está bien.

Debe apuntar correctamente al archivo compilado utilizando las propiedades de módulo, principal o de entrada en package.json. Usar una plantilla y aprenderlas una por una es una buena opción. Nuevamente, alexjoverm/typescript-library-starter los especificó muy bien.

1. Incluir un archivo .d.ts. Por el mismo motivo, el usuario también necesita acceso a las firmas tipográficas.

Pero si estás seguro de que tu biblioteca se ejecutará en Deno, Bun o ts-node, puedes ignorar mis pautas anteriores porque admiten la ejecución de código TypeScript de forma nativa.

Intente seguir una guía para crear una biblioteca TypeScript y publicarla en npm. Sigue siendo fácil, como el primer ejemplo. Deberías probarlo con otro proyecto usando la sintaxis de importación y podrás ver sugerencias de escritura con un IDE.

Con TypeScript, puedo escribir mi biblioteca en esta sintaxis:

Y después de publicarlo, puedo instalarlo e importarlo, y ver las sugerencias de tipografía gracias a TypeScript.

✨ Versionado semántico

Hay un problema común pero un poco avanzado esperando ser resuelto: cada vez que actualizamos nuestro paquete, necesitamos editar el código de la versión.

Eso es molesto, especialmente si actualizas tu código con frecuencia.

Sin embargo, existen herramientas que te ayudarán.

• liberación semántica: Totalmente automática; puedes integrarlo en GitHub CI para actualizar automáticamente el código de la versión y publicarlo en npm cada vez que actualices tu código en GitHub.
• Release-it: también le ayuda a mejorar la versión, pero es fácil de usar (no es necesario tener conocimientos de CI); mientras tanto, no lo configuras como completamente automatizado.

Utilicé ChatGPT para generar este resumen comparando las dos herramientas. Para los programadores nuevos, les sugiero que prueben liberarlo, pero el lanzamiento semántico también es conveniente si saben cómo integrarlo con CI.

En esta publicación, te mostraré cómo usar Release-it. Bueno, después de haber realizado cambios en el proyecto, simplemente ejecuta esto en tu proyecto:

npx release-it

Y elige si es un cambio menor o un cambio importante, ¡y listo!

Resumen

¡Ahí lo tienes! Hemos analizado la publicación de una biblioteca npm simple, su actualización e incluso el uso de TypeScript para hacerla más moderna y robusta. Recuerda:

• Exporta tus funciones correctamente para que otros puedan usarlas.
• Actualice sus números de versión siguiendo el control de versiones semántico.
• Considere utilizar TypeScript para obtener una mejor seguridad tipográfica y experiencia de desarrollador.
• Automatiza tus lanzamientos con herramientas como release-it o semantic-release para ahorrar tiempo.

¡Probar! Publique su propia biblioteca, actualícela y vea cómo se siente contribuir al ecosistema npm. ¡Feliz codificación!