Pular para o conteúdo
nexus-dialogs
GitHub npm

Versionamento e migrações

Esta página está disponível apenas em espanhol.

Cómo se numeran las versiones, cómo leer el CHANGELOG y qué hacer antes y después de actualizar. La política completa y lo que se soporta está en Soporte; aquí va la parte práctica.

#Cómo se numeran las versiones

Se sigue versionado semántico (mayor.menor.parche):

CambioEjemploQué esperar
Parche1.0.0 → 1.0.1Solo correcciones. Actualizar es seguro
Menor1.0.x → 1.1.0Solo agrega. (Hasta la 0.x, una menor podía romper)
Mayor1.x → 2.0Puede romper. Lo que se quite se avisó como obsoleto una versión menor antes

Qué cuenta como «romper» (quitar o renombrar una exportación pública, cambiar lo que devuelve una función, cambiar un valor por omisión que altera el resultado o subir el mínimo de un navegador) está en Soporte.

#Cómo leer el CHANGELOG

Cada versión del CHANGELOG se divide en apartados, siempre en este orden:

#Antes de actualizar

  1. Elige cómo fijar la versión. Desde la 1.0 puedes usar "nexus-dialogs": "^1.0.0": las versiones menores y los parches no rompen. Si prefieres que una instalación nueva nunca cambie sola, usa la versión exacta, sin ^ ni ~.
  2. Lee «Cambios que rompen» de cada versión entre la tuya y la nueva, no solo de la última.
  3. Busca en tu código lo que menciona cada cambio (el nombre de la función o la opción).
  4. Revisa los tipos: tsc marca las exportaciones quitadas o renombradas y las opciones que cambiaron de forma.
  5. Actualiza y corre tus pruebas. Si tienes pruebas de interfaz, los diálogos son <dialog> nativos con data-nexus-dialog, así que tus selectores no deberían cambiar.

#Qué se vigila para no romperte

#Migraciones conocidas

DesdeHaciaQué cambiaCómo migrar
0.5.x1.0.0Nada rompe: la 1.0.0 solo fija la API pública y el versionado semánticoActualiza y corre tus pruebas
0.4.x0.5.0strictHtml es true por omisión: el html en cadena se muestra como textoCon contenido propio, configure({ strictHtml: false }). Con contenido de fuera, configure({ sanitize: (h) => DOMPurify.sanitize(h) }). Los Node y los textos no cambian

Las migraciones nuevas se agregan aquí cuando salen. Para venir desde SweetAlert2 hay una guía aparte: Migrar de SweetAlert2.

#Cuando algo se va a quitar

Una función que se vaya a retirar sigue funcionando una versión menor completa, marcada como @deprecated en los tipos (tu editor la tacha) y listada en «Obsoleto» del CHANGELOG con su reemplazo. Solo se quita en la siguiente versión mayor. (En la 0.x el aviso podía durar menos, pero siempre aparecía en «Cambios que rompen».)

#Si la actualización te rompe algo

Vuelve a la versión anterior (npm install nexus-dialogs@1.0.0) y abre un issue con la versión de la que vienes, a la que vas y un caso mínimo. Si el cambio no estaba en «Cambios que rompen», es un error del CHANGELOG y se corrige.