Imagen de versionado semántico
👨💻 Comparto esta imagen sobre el versionado semántico.
Introducción
Bienvenida a NPM
Gestión de dependencias
Instalación de NPM
Instalación de NPM en MacOS
Instalación de NPM en Windows
Configuración de dependencias
Primeros pasos en NPM
Instalación de dependencias
Instalación de dependencias de versiones específicas
Comandos en NPM (Scripts)
Actualización de dependencias
Seguridad y solución de problemas
Eliminación de dependencias y Package lock
Creación y publicación de paquetes
Crear un paquete
Publicar un paquete
Versionado de paquetes y paquetes privados
Cierre
Sigue desarrollando en JavaScript
You don't have access to this class
Keep learning! Join and start boosting your career
If you already have an account,
Resources
Semantic versioning consists of the structure that we must follow to place a version to our package.
What is semantic versioning
Semantic versioning consists of three values:
- Major: the value that shows the version containing the major changes to the package.
- Minor: the value that shows the version that contains changes in functionality, but does not represent a significant change.
- Patch: the value showing the version that contains quick changes to fix security issues or bugs
Symbols ^ and ~ to update minor and patch versions
There are two symbols that accompany versioning are used to update the minor and patch versions of the package.
- Caret (^): Allows you to upgrade minor and patch versions.
- Tilde (~): Allows to update the patch versions.
For example, we have version 5.2.3:
- If you have carret
^5.2.3, it will update the minor and patch version, so you will have versions like^5.3.3,^5.4.3,^5.4.4, and so on. But not versions greater than6.0.0. - If you have the tilde
~5.2.3, it will update the patch version, so you will have versions like~5.2.4,~5.2.5,~5.2.6, and so on. But no versions higher than5.3.0.
Best practices in package versioning
It is recommended to remove these symbols and have the exact version (without symbols) to avoid versioning problems, especially with packages that are maintained by few people or are unreliable.
You should handle upgrades when appropriate and make sure that the new version will not conflict with the old one.
Making changes to the version of your NPM package
If you make changes to your code, you have to change the version of your package. You must use the following commands, depending on the version you want to change:
````bash
Upgrade a version path (1.0.0) -> (1.0.1)
$ npm version patch
Upgrade a minor version (1.0.0) -> (1.1.0)
$ npm version minor
Upgrades a major version (1.0.0) -> (2.0.0)
$ npm version major
Upgrades a specific version (1.0.0) -> (3.1.1)
$ npm version
Once you have updated the version of your package, you can run the npm publish command again to update it in the NPM repositories.
Private packages
To use private packages you need:
- A version equal to or higher than 2.7.0 of NPM.
- Have a paid user account or organization
In a private NPM package, only the owner and authorized contributors can participate. This way, you can still build the package with a combination of private code and public dependencies.
Updating your package in NPM with best practices
Your package should contain as much information as possible so that the user can install it, use it and even collaborate to fix possible bugs. Therefore, you need to have at least a README.md file and a remote repository (GitHub, GitLab, etc.) configured.
Once you have these requirements, you can upgrade your package to a new version, then release it again.
How to create a README.md file for your package
To create a README.md file you can use this base structure and adapt it to your project. You can view the code by clicking on the "Raw" button.
Contribution created by Andres Guano (Platzi Contributor).
Contributions 38
Questions 7
Sort by:
Si les da errores, puede ser porque no habían instalado previamente el comando con permisos de root, por ejemplo:
sudo npm install -g random-str-msg
Con eso debería resolver lo de instalar y ya al colocar el comando:
random-str-msg
deberían aparecerle las frases que al profe le aparecen en su consola.
“Me gustaría ver tus paquetes”
Si no les funciona el up main intenten con git push
Mi primer paquete NPM 📦
Construí un paquete que recibe un texto entre comillas despues del comando y lo regresa emarcado para darle énfasis
LINK 👉 frame-text
frame-text
█▀▀▀▀▀▀▀▀▀▀▀▀█
█ FRAME TEXT █
█▄▄▄▄▄▄▄▄▄▄▄▄█
This project frames the text to give it emphasis.
Install
npm install -g frame-text
Usage
frame-text "Hello"
=>
█▀▀▀▀▀▀▀█
█ Hello █
█▄▄▄▄▄▄▄█
Por aquí les dejo mis notas, espero les sean útiles.
Creando un paquete con el manejador de paquetes de node, npm, node package manager.
- Debemos verificar si ya existe algún paquete con el nombre que hemos pensado.
- El nombre del paquete debe ser el mismo que le pondremos al repositorio de gh.
- Clonamos el repositorio.
- Entramos a la carpeta que traímos de gh.
- npm init -y.
- "Hacemos cambios en el package-json según creamos conveniente.
- Creamos una carpeta src.
- Dentro de src creamos el index.js.
- En el index colocamos el código del paquete.
- Creamos una nueva carpeta llamada bin.
- Dentro creamos un global.js, este archivo va a funcionar del lado de node,
hará un import del module que acabamos de crear, luego ejecuta la acción que viene
dentro. - En el json agregamos un elemento llamado
bin; {
“nombre del paquete”: “./ubicacionFicticia”
},
“preferGlobal”: true - Ahora en la terminal, dentro de la carpeta del proyecto corremos el comando npm link, para crear un enlace simbolico, de esta manera lo probamos y verificamos si tenemos vulnerabilidades.
- Probamos el paquete instalandolo simuladamente con la ruta en done está dentro de nuestro equipo de la siguiente manera, npm install -g ./rutaDelPaquete.
- Así podremos probarlo. Si funciona podemos publicarlo.
- Cabe recalcar que todo esto debe estar siendo pusheado a github obviamente.
- iniciamos sesion en npm desde la terminal con el comando npm adduser.
- ejecutamos el comando de publish.
- Hecho esto ya el paquete está publicado, podemos verificar en npm, en el apartado de packages.
ACTUALIZAR EL PAQUETE Y VERSIONARLO.
20. 2.0.0, el primer número representa un cambio mayor, el segundo una versión menos y el tercero un parche al reparar algún error en una versión anterior.
21. Cambiamos la lógica del index.js si así lo queremos.
22. El readme debe estar muy bien explicado, con info de qué hace el paquete, como se instala, como se llama, etc.
23. Mandamos todo a github antes de hacer cualquier cambio.
24. versionamos el paquete de la siguiente manera: npm version 1.1.0. Obviamente aquí cambiamos a la versión que toque.
25. npm publish y con esto quedaría subida la nueva versión.
26. Revisamos los cambios en npm.
Los paquetes son divertidos. Comandos importantes:
- npm link
- npm install -g /ruta/del/paquete
- npm adduser
- npm publish
- npm version x.x.x
Los paquetes privados tienen costo.
⌛️ Archivos del Proyecto ⏳
Pasos 📌
- • Se recomienda tener buen estructurado el archivo
README.mdpara tener un mejor control de los cambios que se realizan al proyecto.
- • Si cambiamos elementos del paquete, bien sea en la lógica, en los datos, etc, lo recomendable es tener varias versiones de la publicación del paquete.
- • Una vez hecho un cambio, se debe actualizar a git con:
git add .
git commit -m “mensaje-del-cambio”
- • Luego se hace un cambio de versión ejecutado:
up main
- • Se agrega la nueva versión, por ejemplo si tenemos la versión
0.0.0se puede actualizar a:
npm version 1.1.0
- • Con
git statusse verifica si todo está correcto.
- • Se vuelve a publicar pero con la nueva versión:
npm publish
- • Se revisa en la página de npm para ver los cambios de la versión.
Yo hice un paquete que te cuenta historias cortas de terror 💀, selecione las mejores, chenlo está chido jaja 😄
Así se installa
npm i horror-stories
Así se ejecuta
tell-me
Comparto mis apuntes
El semántico (semantic versioning), es el sistema de versionado que mas se usa a nivel mundial. El mismo se representa de la siguinete manera: Nombre-del-proyecto Numero-de-versión --> Ej: NPM v 10.2.1.
El primer número de la version, representa cambios mayores, cambios muy importantes, de apariencia y todo eso. Que si estas usando la version 9.#.# de una herramienta y la misma ya esta en su version 10.#.#, podria haber muchos errores de compatibilidad si intentas manejarte de la misma manera con esta nueva actualización.
El segundo número de la version, representa cambios menores. Que si tienes la version 10.2.# de una herramienta y la misma va por la version 10.4.#, no deberias tener conflictos si intentas manejarte de la misma manera con esta nueva actualización.
El tercer número de la version, representa cambios pequeñitos. La correccion de algo que no funcionaba, la actualizacion o mejora de algun parche de seguridad, etc.
Aqui pueden visitar Mi paquete. Ha sido genial aprender como usar npm. La verdad lo venia usando pero como que adivinando, ahora tiene muchas más sentido cada cosa que hago con NPM 😄
“Así que me gustaría ver tus paquetes”
Lo malo de ser mexicano y sentir que todo lo que te dicen es un albur xD
# ✨🦄 Entusiasmo!
Pueden probar mi paquete para la generación de cadenas de texto random:
[randstrgen - npm](https://www.npmjs.com/package/randstrgen)
Ahí se encuentran todas las instrucciones para usarlo tanto en código como en cli n.n
Hola, cree este paquete, que es muy similar al del profe, solo que lanza frases motivacionales cuando estes en atascos o resolviendo bugs
<https://www.npmjs.com/package/manzo-paquete>
\## Install
```shnpm install -g manzo-paquete```
**VERSIONADO DE PAQUETES**
*El **versionado** de **paquetes** es una **práctica** **esencial** en la **gestión** de **proyectos** de **software**, que permite a los **desarrolladores** **rastrear** y **controlar** las **diferentes** **etapas** de **evolución** de un **paquete**. **Cada** **versión** de un **paquete** se **identifica** con un **número** **único** que **refleja** el **estado** y los **cambios** **realizados** en **comparación** con **versiones** **anteriores**. Este **sistema** de **versionado** **proporciona** **claridad** y **previsibilidad**, **ayudando** a **evitar** **conflictos** y **problemas** de **compatibilidad** al **integrar** **dependencias** en un **proyecto**. **Utilizar** un **esquema** de **versionado** bien **definido**, como el **versionado** **semántico**, **facilita** la **comunicación** **entre** los **desarrolladores** y **asegura** que las **actualizaciones** de **paquetes** se **realicen** de manera **controlada** y **segura**. En resumen, el **versionado** de **paquetes** es una **herramienta** **clave** para **mantener** la **integridad**, **estabilidad** y **evolución** **coherente** de los **proyectos** de **software**.*
<https://hackernoon.com/es/c%C3%B3mo-crear-y-publicar-su-primer-paquete-npm-privado>
npm version 2.1.0
npm WARN version This is a Git checkout, but the git command was not found. npm could not create a Git tag for this release!
v2.1.0
Mi paquete de npm:
gatfun
Excelente!
Cuando añadimos el siguiente código:
// https://github.com/userName/namePaquete#readme
"homepage": "https://github.com/Todointerconectado/random-str-msg-fnc#readme",
"bin": {
// "namePaquete": "./bin/global.js"
"random-str-msg-fnc": "./bin/global.js"
},
"preferGlobal": true,
"dependencies": {
"g": "^2.0.1",
"random-str-msg-fnc": "^1.1.1"
}
Ten en cuenta tu nombre de usuario de github y el nombre que le diste al paquete.
Les comparto mi primer paquete Aquí npm según el ejercicio del curso. Obviamente modifiqué y ahora muestra refranes en castellano de manera aleatoria. ¡Excelente curso!
https://www.npmjs.com/package/random-msg-message
En mi caso cree un paquete que permite crear cuentas de ethereum EIP55 compatibles, trabajado globalmente me las genera de forma aleatoria pero importando las funciones extras que cree me permiten importar desde la clave privada o generar wallets deterministicas usando un usuario y un password. Dejo para más adelante para implementar el bip39 y bip32. Acá les dejo el npm: https://www.npmjs.com/package/cryptocris_ethereum_wallet
Les recomiendo Verdaccio para crear sus paquetes privados de manera gratuita. Recién lo utilicé, es sencillo y poderoso 💪
Hola
Acá les dejo un package que permite convertir la collection de Postman a un archivo Markdown.
Dejo mi paquete que esta diseñado para entregar citas de libros aleatoriamente.
https://www.npmjs.com/package/random-str-quote
Hice que ChatGPT me generara 500 frases aleatorias en la estructura que estaba en el condigo aquí el repo
Descargen mi paquete de npm:
npm i randname-ag
Publico mi paquete y mi repositorio:
https://www.npmjs.com/package/sponquotes
https://github.com/LizzColDev/spon-quotes
El poder compartir paquetes que uno crea es algo genial, pero dentro de NPM existen muchos muy utiles para el desarrollo de cada dia.
Entre algunos de estos:
- Cambio imagenes a Webp
- Cambio de imagenes a Avif
Entre otros, esto con ayuda de algo que se llama gulp
Excelente clase!
Me siento que tengo el conocimiento de todo un profesional
Publiqué un paquete en el cual te genera frases inspiradoras con diferente color de fuente y diferente fondo cada que se ejecuta el comando.
Aquí la pagina del paquete en npmjs (https://www.npmjs.com/package/random-quote-colors)
Aquí el link del repositorio en Github (https://github.com/cristhian420/random-quote-colors)
Al momento de instalar el paquete de manera local con npm link, me genero un problema el cual no reconocía el script en la consola.
$ random-quote-colors
zsh: permission denied: random-quote-colors
$ sudo random-quote-colors
Password:
sudo: random-quote-colors: command not found
Usando el comando para desinstalar el paquete
$ npm uninstall random-quote-colors
Simplemente me aparecía el proceso pero seguía apareciendo en la lista de paquetes instalados, por lo que elimine desde la carpeta
/usr/local/lib/node_modules
De esta manera pude reinstalar el paquete de manera local, correr las pruebas y publicarlo en npmjs.
Les dejo mi paquete hecho con frases motivacionales.
https://www.npmjs.com/package/random-show-msg
Want to see more contributions, questions and answers from the community?