1 repositorio
Automated build failures triggered when documentation coverage falls below a set percentage.
Distinct from Documentation Coverage Analysis: Focuses on the enforcement action (failing the build) rather than the analysis (measuring the gap).
Explore 1 awesome GitHub repository matching part of an awesome list · Coverage Threshold Enforcement. Refine with filters or upvote what's useful.
Compodoc es un generador de documentación de API para TypeScript, generador de sitios estáticos y visualizador de arquitectura de proyectos. Analiza el código fuente y los comentarios JSDoc para crear sitios de referencia técnica, catálogos de API y páginas HTML independientes que se pueden buscar. El proyecto se distingue por analizar las sentencias de importación para producir grafos de dependencia y mapas de módulos que ilustran las relaciones estructurales dentro de una base de código. Incluye soporte especializado para visualizar proyectos Angular, flujos de trabajo NestJS y componentes web Stencil, y puede incrustar demos funcionales en vivo directamente en las páginas de documentación. El sistema también funciona como un analizador de cobertura de documentación, proporcionando informes y aplicando umbrales mínimos de cobertura dentro de pipelines de integración continua para fallar builds si los niveles de documentación son insuficientes. Las capacidades adicionales incluyen integración con markdown, exportación de datos en múltiples formatos a JSON o Markdown, y un servidor de desarrollo local con monitoreo del sistema de archivos para reconstrucciones automáticas. Los usuarios pueden personalizar la salida a través de archivos de configuración, estilos CSS personalizados y filtrado de visibilidad de elementos para excluir símbolos específicos o etiquetas internas del sitio final.
Automatically fails the build process when documentation coverage falls below a defined percentage threshold.