Awesome GitHub RepositoriesCoverage Threshold Enforcement

Compodoc est un générateur de documentation API TypeScript, un générateur de site statique et un visualiseur d'architecture de projet. Il analyse le code source et les commentaires JSDoc pour créer des sites de référence technique consultables, des catalogues API et des pages HTML autonomes. Le projet se distingue par l'analyse des instructions d'importation pour produire des graphes de dépendances et des cartes de modules illustrant les relations structurelles au sein d'une base de code. Il inclut un support spécialisé pour la visualisation de projets Angular, de flux de travail NestJS et de composants web Stencil, et peut intégrer des démos fonctionnelles directement dans les pages de documentation. Le système fonctionne également comme un analyseur de couverture de documentation, fournissant des rapports et imposant des seuils de couverture minimaux au sein des pipelines d'intégration continue pour faire échouer les builds si les niveaux de documentation sont insuffisants. Les capacités supplémentaires incluent l'intégration Markdown, l'exportation de données multi-format vers JSON ou Markdown, et un serveur de développement local avec surveillance du système de fichiers pour des reconstructions automatiques. Les utilisateurs peuvent personnaliser la sortie via des fichiers de configuration, des styles CSS personnalisés et le filtrage de visibilité des éléments pour exclure des symboles spécifiques ou des balises internes du site final.