Cobertura de documentación de código
Por qué reemplazamos doc-coverage
Section titled “Por qué reemplazamos doc-coverage”doc-coverage escanea un src/ genérico y mezcla helpers internos con APIs
públicas. En este repositorio, las APIs públicas viven en entrypoints como
main.ts y (cuando aplica) index.ts o public-api.ts. Lo reemplazamos por
una verificación basada en ts-morph que se enfoca en símbolos exportados desde
esos entrypoints.
Qué se considera API pública
Section titled “Qué se considera API pública”La métrica solo cuenta declaraciones exportadas desde:
libs/**/src/index.tslibs/**/src/public-api.tspackages/**/src/index.tsapps/**/src/main.ts
Solo se cuentan estos tipos de declaraciones:
- funciones
- clases
- interfaces
- tipos
- enums
Ejecutar en local
Section titled “Ejecutar en local”npm run docs:coveragenpm run docs:checkCómo corregir fallos
Section titled “Cómo corregir fallos”Cuando la cobertura está por debajo del umbral, el script lista las
declaraciones sin documentación con file:line. Agrega una descripción
corta de JSDoc al export:
/** * Crea una nueva orden para el usuario autenticado. */export async function createOrderHandler(...) { ... }