Skip to content

Cobertura de documentación de código

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.

La métrica solo cuenta declaraciones exportadas desde:

  • libs/**/src/index.ts
  • libs/**/src/public-api.ts
  • packages/**/src/index.ts
  • apps/**/src/main.ts

Solo se cuentan estos tipos de declaraciones:

  • funciones
  • clases
  • interfaces
  • tipos
  • enums
Terminal window
npm run docs:coverage
npm run docs:check

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(...) { ... }