¿Qué es la cobertura de código?

La cobertura de código (o code coverage) es una métrica que nos indica qué porcentaje del código fuente ha sido ejecutado durante la ejecución de los tests. Esto ayuda a identificar partes del código que aún no han sido probadas. No se trata solo de cuántas pruebas tenemos, sino de qué tanto del código realmente están validando esas pruebas.

¿Qué mide exactamente --coverage?

Jest, al ejecutar los tests con --coverage, genera un informe detallado que incluye los siguientes indicadores:

Statements	Porcentaje de sentencias ejecutadas por los tests. Ej: asignaciones, expresiones.
Branches	Cobertura de estructuras condicionales como `if`, `switch`, operadores ternarios.
Functions	Qué porcentaje de funciones o métodos fueron invocados en los tests.
Lines	Qué porcentaje de líneas de código fueron ejecutadas.

Y ahora ¿ Cómo se usa --coverage en Jest?

O incluirlo en el archivo package.json como script:

Luego podrías ejecutar:

Veamos un Ejemplo de la respuesta usando este comando

acá vemos que usuariosController.js del 97.97% esto indica que casi todo el código fue probado por los test

también encontramos al frente un mensaje que nos dice que las líneas 110, 156 y 248 no están dentro del la cobertura, esto puede ser debido a mensajes que se salen de la cobertura un ejemplo seria el siguiente

muchos de estos mensajes son el resultado de una zona en los modelos como esta

.catch((error) => {
    return callback({state:false})
})

si vemos la línea 248 notamos que es un mensaje de error que saldrá cuando la base de datos retorne un inconveniente al momento de actualizar, por esta razón para llegar a este punto de cobertura tendríamos que inducir un error en la base de datos para que falle al actualizar

ten en cuenta que al usar --coverage esto genera también un informe en html donde puedes visualizar de forma interactiva una web con los resultados:

¿Dónde se genera el informe de cobertura?

Jest crea una carpeta llamada coverage/ en la raíz del proyecto. Dentro encontrarás:

lcov-report/index.html: un reporte visual en HTML muy fácil de interpretar.
Archivos .json y .lcov: útiles para integraciones con otras herramientas como SonarQube o CI/CD.

Puedes abrir el archivo index.html en tu navegador para ver el detalle por archivo y línea.