doc-freshness-checker 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (246) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +305 -0
  3. package/dist/cache/cacheManager.d.ts +42 -0
  4. package/dist/cache/cacheManager.js +138 -0
  5. package/dist/cache/cacheManager.js.map +1 -0
  6. package/dist/cache/cacheManager.test.d.ts +1 -0
  7. package/dist/cache/cacheManager.test.js +142 -0
  8. package/dist/cache/cacheManager.test.js.map +1 -0
  9. package/dist/cli.d.ts +32 -0
  10. package/dist/cli.js +137 -0
  11. package/dist/cli.js.map +1 -0
  12. package/dist/cli.test.d.ts +1 -0
  13. package/dist/cli.test.js +184 -0
  14. package/dist/cli.test.js.map +1 -0
  15. package/dist/config/defaults.d.ts +5 -0
  16. package/dist/config/defaults.js +135 -0
  17. package/dist/config/defaults.js.map +1 -0
  18. package/dist/config/defineConfig.d.ts +28 -0
  19. package/dist/config/defineConfig.js +30 -0
  20. package/dist/config/defineConfig.js.map +1 -0
  21. package/dist/config/defineConfig.test.d.ts +1 -0
  22. package/dist/config/defineConfig.test.js +10 -0
  23. package/dist/config/defineConfig.test.js.map +1 -0
  24. package/dist/config/loader.d.ts +7 -0
  25. package/dist/config/loader.js +250 -0
  26. package/dist/config/loader.js.map +1 -0
  27. package/dist/config/loader.test.d.ts +1 -0
  28. package/dist/config/loader.test.js +276 -0
  29. package/dist/config/loader.test.js.map +1 -0
  30. package/dist/git/changeTracker.d.ts +44 -0
  31. package/dist/git/changeTracker.js +149 -0
  32. package/dist/git/changeTracker.js.map +1 -0
  33. package/dist/git/changeTracker.test.d.ts +1 -0
  34. package/dist/git/changeTracker.test.js +184 -0
  35. package/dist/git/changeTracker.test.js.map +1 -0
  36. package/dist/graph/codeDocGraph.d.ts +43 -0
  37. package/dist/graph/codeDocGraph.js +103 -0
  38. package/dist/graph/codeDocGraph.js.map +1 -0
  39. package/dist/graph/codeDocGraph.test.d.ts +1 -0
  40. package/dist/graph/codeDocGraph.test.js +78 -0
  41. package/dist/graph/codeDocGraph.test.js.map +1 -0
  42. package/dist/graph/graphBuilder.d.ts +17 -0
  43. package/dist/graph/graphBuilder.js +76 -0
  44. package/dist/graph/graphBuilder.js.map +1 -0
  45. package/dist/graph/graphBuilder.test.d.ts +1 -0
  46. package/dist/graph/graphBuilder.test.js +87 -0
  47. package/dist/graph/graphBuilder.test.js.map +1 -0
  48. package/dist/index.d.ts +37 -0
  49. package/dist/index.js +37 -0
  50. package/dist/index.js.map +1 -0
  51. package/dist/parsers/documentParser.d.ts +22 -0
  52. package/dist/parsers/documentParser.js +76 -0
  53. package/dist/parsers/documentParser.js.map +1 -0
  54. package/dist/parsers/documentParser.test.d.ts +1 -0
  55. package/dist/parsers/documentParser.test.js +116 -0
  56. package/dist/parsers/documentParser.test.js.map +1 -0
  57. package/dist/parsers/extractors/baseExtractor.d.ts +19 -0
  58. package/dist/parsers/extractors/baseExtractor.js +33 -0
  59. package/dist/parsers/extractors/baseExtractor.js.map +1 -0
  60. package/dist/parsers/extractors/baseExtractor.test.d.ts +1 -0
  61. package/dist/parsers/extractors/baseExtractor.test.js +43 -0
  62. package/dist/parsers/extractors/baseExtractor.test.js.map +1 -0
  63. package/dist/parsers/extractors/codePatternExtractor.d.ts +13 -0
  64. package/dist/parsers/extractors/codePatternExtractor.js +108 -0
  65. package/dist/parsers/extractors/codePatternExtractor.js.map +1 -0
  66. package/dist/parsers/extractors/codePatternExtractor.test.d.ts +1 -0
  67. package/dist/parsers/extractors/codePatternExtractor.test.js +49 -0
  68. package/dist/parsers/extractors/codePatternExtractor.test.js.map +1 -0
  69. package/dist/parsers/extractors/dependencyExtractor.d.ts +12 -0
  70. package/dist/parsers/extractors/dependencyExtractor.js +92 -0
  71. package/dist/parsers/extractors/dependencyExtractor.js.map +1 -0
  72. package/dist/parsers/extractors/dependencyExtractor.test.d.ts +1 -0
  73. package/dist/parsers/extractors/dependencyExtractor.test.js +48 -0
  74. package/dist/parsers/extractors/dependencyExtractor.test.js.map +1 -0
  75. package/dist/parsers/extractors/directoryStructureExtractor.d.ts +34 -0
  76. package/dist/parsers/extractors/directoryStructureExtractor.js +168 -0
  77. package/dist/parsers/extractors/directoryStructureExtractor.js.map +1 -0
  78. package/dist/parsers/extractors/directoryStructureExtractor.test.d.ts +1 -0
  79. package/dist/parsers/extractors/directoryStructureExtractor.test.js +121 -0
  80. package/dist/parsers/extractors/directoryStructureExtractor.test.js.map +1 -0
  81. package/dist/parsers/extractors/externalUrlExtractor.d.ts +14 -0
  82. package/dist/parsers/extractors/externalUrlExtractor.js +53 -0
  83. package/dist/parsers/extractors/externalUrlExtractor.js.map +1 -0
  84. package/dist/parsers/extractors/externalUrlExtractor.test.d.ts +1 -0
  85. package/dist/parsers/extractors/externalUrlExtractor.test.js +85 -0
  86. package/dist/parsers/extractors/externalUrlExtractor.test.js.map +1 -0
  87. package/dist/parsers/extractors/filePathExtractor.d.ts +18 -0
  88. package/dist/parsers/extractors/filePathExtractor.js +72 -0
  89. package/dist/parsers/extractors/filePathExtractor.js.map +1 -0
  90. package/dist/parsers/extractors/filePathExtractor.test.d.ts +1 -0
  91. package/dist/parsers/extractors/filePathExtractor.test.js +73 -0
  92. package/dist/parsers/extractors/filePathExtractor.test.js.map +1 -0
  93. package/dist/parsers/extractors/versionExtractor.d.ts +11 -0
  94. package/dist/parsers/extractors/versionExtractor.js +74 -0
  95. package/dist/parsers/extractors/versionExtractor.js.map +1 -0
  96. package/dist/parsers/extractors/versionExtractor.test.d.ts +1 -0
  97. package/dist/parsers/extractors/versionExtractor.test.js +55 -0
  98. package/dist/parsers/extractors/versionExtractor.test.js.map +1 -0
  99. package/dist/plugins/plugin.d.ts +32 -0
  100. package/dist/plugins/plugin.js +40 -0
  101. package/dist/plugins/plugin.js.map +1 -0
  102. package/dist/plugins/plugin.test.d.ts +1 -0
  103. package/dist/plugins/plugin.test.js +23 -0
  104. package/dist/plugins/plugin.test.js.map +1 -0
  105. package/dist/reporters/consoleReporter.d.ts +15 -0
  106. package/dist/reporters/consoleReporter.js +73 -0
  107. package/dist/reporters/consoleReporter.js.map +1 -0
  108. package/dist/reporters/consoleReporter.test.d.ts +1 -0
  109. package/dist/reporters/consoleReporter.test.js +155 -0
  110. package/dist/reporters/consoleReporter.test.js.map +1 -0
  111. package/dist/reporters/enhancedReporter.d.ts +12 -0
  112. package/dist/reporters/enhancedReporter.js +81 -0
  113. package/dist/reporters/enhancedReporter.js.map +1 -0
  114. package/dist/reporters/enhancedReporter.test.d.ts +1 -0
  115. package/dist/reporters/enhancedReporter.test.js +152 -0
  116. package/dist/reporters/enhancedReporter.test.js.map +1 -0
  117. package/dist/reporters/jsonReporter.d.ts +11 -0
  118. package/dist/reporters/jsonReporter.js +20 -0
  119. package/dist/reporters/jsonReporter.js.map +1 -0
  120. package/dist/reporters/jsonReporter.test.d.ts +1 -0
  121. package/dist/reporters/jsonReporter.test.js +31 -0
  122. package/dist/reporters/jsonReporter.test.js.map +1 -0
  123. package/dist/reporters/markdownReporter.d.ts +11 -0
  124. package/dist/reporters/markdownReporter.js +55 -0
  125. package/dist/reporters/markdownReporter.js.map +1 -0
  126. package/dist/reporters/markdownReporter.test.d.ts +1 -0
  127. package/dist/reporters/markdownReporter.test.js +136 -0
  128. package/dist/reporters/markdownReporter.test.js.map +1 -0
  129. package/dist/runner.d.ts +9 -0
  130. package/dist/runner.js +265 -0
  131. package/dist/runner.js.map +1 -0
  132. package/dist/runner.test.d.ts +1 -0
  133. package/dist/runner.test.js +353 -0
  134. package/dist/runner.test.js.map +1 -0
  135. package/dist/scoring/freshnessScorer.d.ts +40 -0
  136. package/dist/scoring/freshnessScorer.js +170 -0
  137. package/dist/scoring/freshnessScorer.js.map +1 -0
  138. package/dist/scoring/freshnessScorer.test.d.ts +1 -0
  139. package/dist/scoring/freshnessScorer.test.js +397 -0
  140. package/dist/scoring/freshnessScorer.test.js.map +1 -0
  141. package/dist/semantic/vectorSearch.d.ts +84 -0
  142. package/dist/semantic/vectorSearch.js +484 -0
  143. package/dist/semantic/vectorSearch.js.map +1 -0
  144. package/dist/semantic/vectorSearch.test.d.ts +1 -0
  145. package/dist/semantic/vectorSearch.test.js +660 -0
  146. package/dist/semantic/vectorSearch.test.js.map +1 -0
  147. package/dist/setupTests.d.ts +4 -0
  148. package/dist/setupTests.js +11 -0
  149. package/dist/setupTests.js.map +1 -0
  150. package/dist/test-utils/console.d.ts +2 -0
  151. package/dist/test-utils/console.js +3 -0
  152. package/dist/test-utils/console.js.map +1 -0
  153. package/dist/test-utils/factories.d.ts +3 -0
  154. package/dist/test-utils/factories.js +25 -0
  155. package/dist/test-utils/factories.js.map +1 -0
  156. package/dist/test-utils/tempFiles.d.ts +1 -0
  157. package/dist/test-utils/tempFiles.js +12 -0
  158. package/dist/test-utils/tempFiles.js.map +1 -0
  159. package/dist/types.d.ts +304 -0
  160. package/dist/types.js +5 -0
  161. package/dist/types.js.map +1 -0
  162. package/dist/utils/boundedMap.d.ts +8 -0
  163. package/dist/utils/boundedMap.js +22 -0
  164. package/dist/utils/boundedMap.js.map +1 -0
  165. package/dist/utils/boundedMap.test.d.ts +1 -0
  166. package/dist/utils/boundedMap.test.js +57 -0
  167. package/dist/utils/boundedMap.test.js.map +1 -0
  168. package/dist/utils/illustrativePatterns.d.ts +28 -0
  169. package/dist/utils/illustrativePatterns.js +80 -0
  170. package/dist/utils/illustrativePatterns.js.map +1 -0
  171. package/dist/utils/illustrativePatterns.test.d.ts +1 -0
  172. package/dist/utils/illustrativePatterns.test.js +48 -0
  173. package/dist/utils/illustrativePatterns.test.js.map +1 -0
  174. package/dist/utils/incremental.d.ts +36 -0
  175. package/dist/utils/incremental.js +87 -0
  176. package/dist/utils/incremental.js.map +1 -0
  177. package/dist/utils/incremental.test.d.ts +1 -0
  178. package/dist/utils/incremental.test.js +84 -0
  179. package/dist/utils/incremental.test.js.map +1 -0
  180. package/dist/utils/parallel.d.ts +14 -0
  181. package/dist/utils/parallel.js +43 -0
  182. package/dist/utils/parallel.js.map +1 -0
  183. package/dist/utils/parallel.test.d.ts +1 -0
  184. package/dist/utils/parallel.test.js +48 -0
  185. package/dist/utils/parallel.test.js.map +1 -0
  186. package/dist/utils/pathSecurity.d.ts +12 -0
  187. package/dist/utils/pathSecurity.js +22 -0
  188. package/dist/utils/pathSecurity.js.map +1 -0
  189. package/dist/utils/pathSecurity.test.d.ts +1 -0
  190. package/dist/utils/pathSecurity.test.js +34 -0
  191. package/dist/utils/pathSecurity.test.js.map +1 -0
  192. package/dist/utils/similarity.d.ts +12 -0
  193. package/dist/utils/similarity.js +64 -0
  194. package/dist/utils/similarity.js.map +1 -0
  195. package/dist/utils/similarity.test.d.ts +1 -0
  196. package/dist/utils/similarity.test.js +49 -0
  197. package/dist/utils/similarity.test.js.map +1 -0
  198. package/dist/utils/validation.d.ts +13 -0
  199. package/dist/utils/validation.js +24 -0
  200. package/dist/utils/validation.js.map +1 -0
  201. package/dist/utils/validation.test.d.ts +1 -0
  202. package/dist/utils/validation.test.js +28 -0
  203. package/dist/utils/validation.test.js.map +1 -0
  204. package/dist/validators/codePatternValidator.d.ts +28 -0
  205. package/dist/validators/codePatternValidator.js +200 -0
  206. package/dist/validators/codePatternValidator.js.map +1 -0
  207. package/dist/validators/codePatternValidator.test.d.ts +1 -0
  208. package/dist/validators/codePatternValidator.test.js +86 -0
  209. package/dist/validators/codePatternValidator.test.js.map +1 -0
  210. package/dist/validators/dependencyValidator.d.ts +12 -0
  211. package/dist/validators/dependencyValidator.js +102 -0
  212. package/dist/validators/dependencyValidator.js.map +1 -0
  213. package/dist/validators/dependencyValidator.test.d.ts +1 -0
  214. package/dist/validators/dependencyValidator.test.js +179 -0
  215. package/dist/validators/dependencyValidator.test.js.map +1 -0
  216. package/dist/validators/directoryValidator.d.ts +30 -0
  217. package/dist/validators/directoryValidator.js +192 -0
  218. package/dist/validators/directoryValidator.js.map +1 -0
  219. package/dist/validators/directoryValidator.test.d.ts +1 -0
  220. package/dist/validators/directoryValidator.test.js +193 -0
  221. package/dist/validators/directoryValidator.test.js.map +1 -0
  222. package/dist/validators/fileValidator.d.ts +16 -0
  223. package/dist/validators/fileValidator.js +114 -0
  224. package/dist/validators/fileValidator.js.map +1 -0
  225. package/dist/validators/fileValidator.test.d.ts +1 -0
  226. package/dist/validators/fileValidator.test.js +108 -0
  227. package/dist/validators/fileValidator.test.js.map +1 -0
  228. package/dist/validators/urlValidator.d.ts +25 -0
  229. package/dist/validators/urlValidator.js +320 -0
  230. package/dist/validators/urlValidator.js.map +1 -0
  231. package/dist/validators/urlValidator.test.d.ts +1 -0
  232. package/dist/validators/urlValidator.test.js +252 -0
  233. package/dist/validators/urlValidator.test.js.map +1 -0
  234. package/dist/validators/validationEngine.d.ts +23 -0
  235. package/dist/validators/validationEngine.js +117 -0
  236. package/dist/validators/validationEngine.js.map +1 -0
  237. package/dist/validators/validationEngine.test.d.ts +1 -0
  238. package/dist/validators/validationEngine.test.js +82 -0
  239. package/dist/validators/validationEngine.test.js.map +1 -0
  240. package/dist/validators/versionValidator.d.ts +18 -0
  241. package/dist/validators/versionValidator.js +211 -0
  242. package/dist/validators/versionValidator.js.map +1 -0
  243. package/dist/validators/versionValidator.test.d.ts +1 -0
  244. package/dist/validators/versionValidator.test.js +308 -0
  245. package/dist/validators/versionValidator.test.js.map +1 -0
  246. package/package.json +98 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enhancedReporter.test.js","sourceRoot":"","sources":["../../src/reporters/enhancedReporter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAIxD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAExC,MAAM,OAAO,GAAsB;QACjC,SAAS,EAAE;YACT;gBACE,IAAI,EAAE,aAAa;gBACnB,MAAM,EAAE;oBACN;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE;wBAC7G,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,gBAAgB;wBACzB,UAAU,EAAE,2BAA2B;qBACxC;oBACD;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,QAAQ,EAAE;wBAC3H,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,SAAS;wBACnB,OAAO,EAAE,kBAAkB;qBAC5B;iBACF;aACF;SACF;QACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACpE,CAAC;IAEF,MAAM,YAAY,GAAsB;QACtC,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACpE,CAAC;IAEF,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC;QAChE,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,GAAG;YACjB,SAAS,EAAE;gBACT;oBACE,QAAQ,EAAE,aAAa;oBACvB,UAAU,EAAE,EAAE;oBACd,OAAO,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE;oBACjG,KAAK,EAAE,GAAG;iBACX;aACF;YACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;SAC7E,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;QACjC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,eAAe,EAAE;YACjD,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,eAAe;YACpB,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACvE,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;QACjC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,eAAe,EAAE;YACjD,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,eAAe;YACpB,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;QACH,MAAM,UAAU,GAAG;YACjB,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;YACrB,iBAAiB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAClG,oBAAoB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC;YACjD,eAAe,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,CAAC;SACd,CAAC;QAEjC,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAC7E,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,GAAG;YACjB,SAAS,EAAE;gBACT;oBACE,QAAQ,EAAE,aAAa;oBACvB,UAAU,EAAE,EAAE;oBACd,OAAO,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE;oBACjG,KAAK,EAAE,GAAG;iBACX;aACF;YACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;SAC7E,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACxE,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2EAA2E,EAAE,GAAG,EAAE;QACnF,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACtE,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3E,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;QACjC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,eAAe,EAAE;YACjD,IAAI,EAAE,WAAW;YACjB,KAAK,EAAE,eAAe;YACtB,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,eAAe;YACpB,UAAU,EAAE,QAAQ;SACrB,CAAC,CAAC;QACH,MAAM,UAAU,GAAG;YACjB,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;YACrB,iBAAiB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,IAAI,CAAC;YAChD,oBAAoB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,eAAe,CAAC,CAAC;YAChE,eAAe,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,aAAa,CAAC,CAAC;SAC3B,CAAC;QAEjC,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAClF,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;QACjC,MAAM,UAAU,GAAG;YACjB,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;YACrB,iBAAiB,EAAE,EAAE,CAAC,EAAE,EAAE;YAC1B,oBAAoB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,kBAAkB,CAAC,GAAG,EAAE;gBACpD,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;YAC/B,CAAC,CAAC;YACF,eAAe,EAAE,EAAE,CAAC,EAAE,EAAE;SACM,CAAC;QAEjC,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAClF,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,11 @@
1
+ import type { ProjectScores, ValidationResults } from '../types.js';
2
+ /**
3
+ * JSON reporter for machine-readable output
4
+ */
5
+ export declare class JsonReporter {
6
+ generate(results: ValidationResults): string;
7
+ /**
8
+ * Generate with freshness scores
9
+ */
10
+ generateWithScores(results: ValidationResults, freshnessScores: ProjectScores | null): string;
11
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * JSON reporter for machine-readable output
3
+ */
4
+ export class JsonReporter {
5
+ generate(results) {
6
+ return JSON.stringify(results, null, 2);
7
+ }
8
+ /**
9
+ * Generate with freshness scores
10
+ */
11
+ generateWithScores(results, freshnessScores) {
12
+ const output = {
13
+ ...results,
14
+ freshnessScores: freshnessScores || null,
15
+ generatedAt: new Date().toISOString(),
16
+ };
17
+ return JSON.stringify(output, null, 2);
18
+ }
19
+ }
20
+ //# sourceMappingURL=jsonReporter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jsonReporter.js","sourceRoot":"","sources":["../../src/reporters/jsonReporter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,YAAY;IACvB,QAAQ,CAAC,OAA0B;QACjC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,OAA0B,EAAE,eAAqC;QAClF,MAAM,MAAM,GAAG;YACb,GAAG,OAAO;YACV,eAAe,EAAE,eAAe,IAAI,IAAI;YACxC,WAAW,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;SACtC,CAAC;QACF,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACzC,CAAC;CACF"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,31 @@
1
+ import { JsonReporter } from './jsonReporter.js';
2
+ describe('JsonReporter', () => {
3
+ const reporter = new JsonReporter();
4
+ const results = {
5
+ documents: [],
6
+ summary: { total: 3, valid: 3, errors: 0, warnings: 0, skipped: 0 },
7
+ };
8
+ it('generate() returns valid JSON string', () => {
9
+ const output = reporter.generate(results);
10
+ const parsed = JSON.parse(output);
11
+ expect(parsed.summary.total).toBe(3);
12
+ });
13
+ it('generateWithScores() includes scores and timestamp', () => {
14
+ const output = reporter.generateWithScores(results, null);
15
+ const parsed = JSON.parse(output);
16
+ expect(parsed.freshnessScores).toBeNull();
17
+ expect(parsed.generatedAt).toBeDefined();
18
+ });
19
+ it('generateWithScores() includes scores object when provided', () => {
20
+ const scores = {
21
+ projectScore: 90,
22
+ projectGrade: 'A',
23
+ documents: [],
24
+ summary: { total: 0, gradeA: 0, gradeB: 0, gradeC: 0, gradeD: 0, gradeF: 0 },
25
+ };
26
+ const output = reporter.generateWithScores(results, scores);
27
+ const parsed = JSON.parse(output);
28
+ expect(parsed.freshnessScores.projectScore).toBe(90);
29
+ });
30
+ });
31
+ //# sourceMappingURL=jsonReporter.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"jsonReporter.test.js","sourceRoot":"","sources":["../../src/reporters/jsonReporter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGjD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;IACpC,MAAM,OAAO,GAAsB;QACjC,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACpE,CAAC;IAEF,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC1C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,MAAM,GAAG;YACb,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,GAAY;YAC1B,SAAS,EAAE,EAAE;YACb,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;SAC7E,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,11 @@
1
+ import type { ProjectScores, ValidationResults } from '../types.js';
2
+ /**
3
+ * Markdown reporter for documentation-friendly output
4
+ */
5
+ export declare class MarkdownReporter {
6
+ generate(results: ValidationResults): string;
7
+ /**
8
+ * Generate with freshness scores
9
+ */
10
+ generateWithScores(results: ValidationResults, freshnessScores: ProjectScores | null): string;
11
+ }
@@ -0,0 +1,55 @@
1
+ /**
2
+ * Markdown reporter for documentation-friendly output
3
+ */
4
+ export class MarkdownReporter {
5
+ generate(results) {
6
+ const { summary, documents } = results;
7
+ let md = '';
8
+ md += '# Documentation Freshness Report\n\n';
9
+ md += `Generated: ${new Date().toISOString()}\n\n`;
10
+ md += '## Summary\n\n';
11
+ md += '| Metric | Count |\n';
12
+ md += '|--------|-------|\n';
13
+ md += `| Total Checked | ${summary.total} |\n`;
14
+ md += `| ✅ Valid | ${summary.valid} |\n`;
15
+ md += `| ❌ Errors | ${summary.errors} |\n`;
16
+ md += `| ⚠️ Warnings | ${summary.warnings} |\n`;
17
+ md += `| ⏭️ Skipped | ${summary.skipped} |\n\n`;
18
+ if (documents.length === 0) {
19
+ md += '✨ **All documentation is up to date!**\n';
20
+ return md;
21
+ }
22
+ md += '## Issues\n\n';
23
+ for (const doc of documents) {
24
+ md += `### 📄 \`${doc.path}\`\n\n`;
25
+ md += '| Line | Severity | Issue | Suggestion |\n';
26
+ md += '|------|----------|-------|------------|\n';
27
+ for (const issue of doc.issues) {
28
+ const severity = issue.severity === 'error' ? '❌ Error' : '⚠️ Warning';
29
+ const suggestion = issue.suggestion || '-';
30
+ const message = (issue.message || '').replace(/\|/g, '\\|');
31
+ md += `| ${issue.reference.lineNumber} | ${severity} | ${message} | ${suggestion} |\n`;
32
+ }
33
+ md += '\n';
34
+ }
35
+ return md;
36
+ }
37
+ /**
38
+ * Generate with freshness scores
39
+ */
40
+ generateWithScores(results, freshnessScores) {
41
+ let md = this.generate(results);
42
+ if (freshnessScores) {
43
+ md += '## Freshness Scores\n\n';
44
+ md += `**Project Score:** ${freshnessScores.projectScore}/100 (Grade: ${freshnessScores.projectGrade})\n\n`;
45
+ md += '| Document | Score | Grade |\n';
46
+ md += '|----------|-------|-------|\n';
47
+ for (const doc of freshnessScores.documents) {
48
+ md += `| \`${doc.document}\` | ${doc.totalScore}/100 | ${doc.grade} |\n`;
49
+ }
50
+ md += '\n';
51
+ }
52
+ return md;
53
+ }
54
+ }
55
+ //# sourceMappingURL=markdownReporter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdownReporter.js","sourceRoot":"","sources":["../../src/reporters/markdownReporter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC3B,QAAQ,CAAC,OAA0B;QACjC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QACvC,IAAI,EAAE,GAAG,EAAE,CAAC;QAEZ,EAAE,IAAI,sCAAsC,CAAC;QAC7C,EAAE,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC;QAEnD,EAAE,IAAI,gBAAgB,CAAC;QACvB,EAAE,IAAI,sBAAsB,CAAC;QAC7B,EAAE,IAAI,sBAAsB,CAAC;QAC7B,EAAE,IAAI,qBAAqB,OAAO,CAAC,KAAK,MAAM,CAAC;QAC/C,EAAE,IAAI,eAAe,OAAO,CAAC,KAAK,MAAM,CAAC;QACzC,EAAE,IAAI,gBAAgB,OAAO,CAAC,MAAM,MAAM,CAAC;QAC3C,EAAE,IAAI,mBAAmB,OAAO,CAAC,QAAQ,MAAM,CAAC;QAChD,EAAE,IAAI,kBAAkB,OAAO,CAAC,OAAO,QAAQ,CAAC;QAEhD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,EAAE,IAAI,0CAA0C,CAAC;YACjD,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,EAAE,IAAI,eAAe,CAAC;QAEtB,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,EAAE,IAAI,YAAY,GAAG,CAAC,IAAI,QAAQ,CAAC;YACnC,EAAE,IAAI,4CAA4C,CAAC;YACnD,EAAE,IAAI,4CAA4C,CAAC;YAEnD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC;gBACvE,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,GAAG,CAAC;gBAC3C,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBAC5D,EAAE,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,UAAU,MAAM,QAAQ,MAAM,OAAO,MAAM,UAAU,MAAM,CAAC;YACzF,CAAC;YAED,EAAE,IAAI,IAAI,CAAC;QACb,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,OAA0B,EAAE,eAAqC;QAClF,IAAI,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,eAAe,EAAE,CAAC;YACpB,EAAE,IAAI,yBAAyB,CAAC;YAChC,EAAE,IAAI,sBAAsB,eAAe,CAAC,YAAY,gBAAgB,eAAe,CAAC,YAAY,OAAO,CAAC;YAE5G,EAAE,IAAI,gCAAgC,CAAC;YACvC,EAAE,IAAI,gCAAgC,CAAC;YAEvC,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,SAAS,EAAE,CAAC;gBAC5C,EAAE,IAAI,OAAO,GAAG,CAAC,QAAQ,QAAQ,GAAG,CAAC,UAAU,UAAU,GAAG,CAAC,KAAK,MAAM,CAAC;YAC3E,CAAC;YAED,EAAE,IAAI,IAAI,CAAC;QACb,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CACF"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,136 @@
1
+ import { MarkdownReporter } from './markdownReporter.js';
2
+ describe('MarkdownReporter', () => {
3
+ const reporter = new MarkdownReporter();
4
+ const cleanResults = {
5
+ documents: [],
6
+ summary: { total: 2, valid: 2, errors: 0, warnings: 0, skipped: 0 },
7
+ };
8
+ const resultsWithIssues = {
9
+ documents: [
10
+ {
11
+ path: 'docs/api.md',
12
+ issues: [
13
+ {
14
+ reference: { type: 'file-path', value: 'missing.ts', lineNumber: 10, raw: 'missing.ts', sourceFile: 'api.md' },
15
+ valid: false,
16
+ severity: 'error',
17
+ message: 'File not found: missing.ts',
18
+ suggestion: 'Did you mean: missing.tsx?',
19
+ },
20
+ {
21
+ reference: { type: 'external-url', value: 'https://old.com', lineNumber: 20, raw: 'https://old.com', sourceFile: 'api.md' },
22
+ valid: false,
23
+ severity: 'warning',
24
+ message: 'URL returned 404',
25
+ },
26
+ ],
27
+ },
28
+ ],
29
+ summary: { total: 2, valid: 0, errors: 1, warnings: 1, skipped: 0 },
30
+ };
31
+ it('generates markdown with summary table', () => {
32
+ const md = reporter.generate(cleanResults);
33
+ expect(md).toContain('# Documentation Freshness Report');
34
+ expect(md).toContain('Total Checked | 2');
35
+ expect(md).toContain('up to date');
36
+ });
37
+ it('generates issues table with error and warning severities', () => {
38
+ const md = reporter.generate(resultsWithIssues);
39
+ expect(md).toContain('## Issues');
40
+ expect(md).toContain('docs/api.md');
41
+ expect(md).toContain('❌ Error');
42
+ expect(md).toContain('⚠️ Warning');
43
+ expect(md).toContain('File not found');
44
+ expect(md).toContain('missing.tsx');
45
+ expect(md).toContain('URL returned 404');
46
+ });
47
+ it('escapes pipe characters in messages', () => {
48
+ const results = {
49
+ documents: [
50
+ {
51
+ path: 'doc.md',
52
+ issues: [
53
+ {
54
+ reference: { type: 'file-path', value: 'x', lineNumber: 1, raw: 'x', sourceFile: 'doc.md' },
55
+ valid: false,
56
+ severity: 'error',
57
+ message: 'Path with | pipe',
58
+ },
59
+ ],
60
+ },
61
+ ],
62
+ summary: { total: 1, valid: 0, errors: 1, warnings: 0, skipped: 0 },
63
+ };
64
+ expect(reporter.generate(results)).toContain('Path with \\| pipe');
65
+ });
66
+ it('uses "-" for missing suggestions', () => {
67
+ const results = {
68
+ documents: [
69
+ {
70
+ path: 'doc.md',
71
+ issues: [
72
+ {
73
+ reference: { type: 'file-path', value: 'x', lineNumber: 1, raw: 'x', sourceFile: 'doc.md' },
74
+ valid: false,
75
+ severity: 'error',
76
+ message: 'Not found',
77
+ },
78
+ ],
79
+ },
80
+ ],
81
+ summary: { total: 1, valid: 0, errors: 1, warnings: 0, skipped: 0 },
82
+ };
83
+ const md = reporter.generate(results);
84
+ expect(md).toMatch(/Not found \| -/);
85
+ });
86
+ it('generateWithScores includes freshness section', () => {
87
+ const scores = {
88
+ projectScore: 92,
89
+ projectGrade: 'A',
90
+ documents: [
91
+ {
92
+ document: 'docs/api.md',
93
+ totalScore: 92,
94
+ factors: { referenceValidity: 100, gitTimeDelta: 90, codeChangeFrequency: 80, symbolCoverage: 90 },
95
+ grade: 'A',
96
+ },
97
+ ],
98
+ summary: { total: 1, gradeA: 1, gradeB: 0, gradeC: 0, gradeD: 0, gradeF: 0 },
99
+ };
100
+ const md = reporter.generateWithScores(cleanResults, scores);
101
+ expect(md).toContain('## Freshness Scores');
102
+ expect(md).toContain('92/100');
103
+ expect(md).toContain('Grade: A');
104
+ });
105
+ it('generateWithScores with null scores omits section', () => {
106
+ const md = reporter.generateWithScores(cleanResults, null);
107
+ expect(md).not.toContain('Freshness Scores');
108
+ });
109
+ it('generates per-document score table', () => {
110
+ const scores = {
111
+ projectScore: 85,
112
+ projectGrade: 'B',
113
+ documents: [
114
+ {
115
+ document: 'a.md',
116
+ totalScore: 90,
117
+ factors: { referenceValidity: 100, gitTimeDelta: 80, codeChangeFrequency: 80, symbolCoverage: 90 },
118
+ grade: 'A',
119
+ },
120
+ {
121
+ document: 'b.md',
122
+ totalScore: 70,
123
+ factors: { referenceValidity: 70, gitTimeDelta: 70, codeChangeFrequency: 70, symbolCoverage: 70 },
124
+ grade: 'C',
125
+ },
126
+ ],
127
+ summary: { total: 2, gradeA: 1, gradeB: 0, gradeC: 1, gradeD: 0, gradeF: 0 },
128
+ };
129
+ const md = reporter.generateWithScores(cleanResults, scores);
130
+ expect(md).toContain('a.md');
131
+ expect(md).toContain('90/100');
132
+ expect(md).toContain('b.md');
133
+ expect(md).toContain('70/100');
134
+ });
135
+ });
136
+ //# sourceMappingURL=markdownReporter.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdownReporter.test.js","sourceRoot":"","sources":["../../src/reporters/markdownReporter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAExC,MAAM,YAAY,GAAsB;QACtC,SAAS,EAAE,EAAE;QACb,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACpE,CAAC;IAEF,MAAM,iBAAiB,GAAsB;QAC3C,SAAS,EAAE;YACT;gBACE,IAAI,EAAE,aAAa;gBACnB,MAAM,EAAE;oBACN;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE;wBAC9G,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,4BAA4B;wBACrC,UAAU,EAAE,4BAA4B;qBACzC;oBACD;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,QAAQ,EAAE;wBAC3H,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,SAAS;wBACnB,OAAO,EAAE,kBAAkB;qBAC5B;iBACF;aACF;SACF;QACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KACpE,CAAC;IAEF,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC3C,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QACzD,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAC1C,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;QAClE,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QAChD,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QAClC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAChC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACnC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACvC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,OAAO,GAAsB;YACjC,SAAS,EAAE;gBACT;oBACE,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE;wBACN;4BACE,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE;4BAC3F,KAAK,EAAE,KAAK;4BACZ,QAAQ,EAAE,OAAO;4BACjB,OAAO,EAAE,kBAAkB;yBAC5B;qBACF;iBACF;aACF;YACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;SACpE,CAAC;QACF,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC1C,MAAM,OAAO,GAAsB;YACjC,SAAS,EAAE;gBACT;oBACE,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE;wBACN;4BACE,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,QAAQ,EAAE;4BAC3F,KAAK,EAAE,KAAK;4BACZ,QAAQ,EAAE,OAAO;4BACjB,OAAO,EAAE,WAAW;yBACrB;qBACF;iBACF;aACF;YACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;SACpE,CAAC;QACF,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,GAAG;YACjB,SAAS,EAAE;gBACT;oBACE,QAAQ,EAAE,aAAa;oBACvB,UAAU,EAAE,EAAE;oBACd,OAAO,EAAE,EAAE,iBAAiB,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE;oBAClG,KAAK,EAAE,GAAG;iBACX;aACF;YACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;SAC7E,CAAC;QACF,MAAM,EAAE,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;QAC5C,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/B,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,EAAE,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAC3D,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,GAAG;YACjB,SAAS,EAAE;gBACT;oBACE,QAAQ,EAAE,MAAM;oBAChB,UAAU,EAAE,EAAE;oBACd,OAAO,EAAE,EAAE,iBAAiB,EAAE,GAAG,EAAE,YAAY,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE;oBAClG,KAAK,EAAE,GAAG;iBACX;gBACD;oBACE,QAAQ,EAAE,MAAM;oBAChB,UAAU,EAAE,EAAE;oBACd,OAAO,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE;oBACjG,KAAK,EAAE,GAAG;iBACX;aACF;YACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;SAC7E,CAAC;QACF,MAAM,EAAE,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAC7D,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC/B,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAC7B,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,9 @@
1
+ import type { DocFreshnessConfig, ValidationResults } from './types.js';
2
+ /**
3
+ * Main entry point - run with config object
4
+ */
5
+ export declare function run(config: DocFreshnessConfig): Promise<ValidationResults>;
6
+ /**
7
+ * Run with config file path
8
+ */
9
+ export declare function runWithConfig(configPath: string): Promise<ValidationResults>;
package/dist/runner.js ADDED
@@ -0,0 +1,265 @@
1
+ import fs from 'fs';
2
+ import path from 'path';
3
+ import { DocumentParser } from './parsers/documentParser.js';
4
+ import { FilePathExtractor } from './parsers/extractors/filePathExtractor.js';
5
+ import { VersionExtractor } from './parsers/extractors/versionExtractor.js';
6
+ import { DirectoryStructureExtractor } from './parsers/extractors/directoryStructureExtractor.js';
7
+ import { CodePatternExtractor } from './parsers/extractors/codePatternExtractor.js';
8
+ import { ExternalUrlExtractor } from './parsers/extractors/externalUrlExtractor.js';
9
+ import { DependencyExtractor } from './parsers/extractors/dependencyExtractor.js';
10
+ import { ValidationEngine } from './validators/validationEngine.js';
11
+ import { FileValidator } from './validators/fileValidator.js';
12
+ import { UrlValidator } from './validators/urlValidator.js';
13
+ import { VersionValidator } from './validators/versionValidator.js';
14
+ import { DirectoryValidator } from './validators/directoryValidator.js';
15
+ import { CodePatternValidator } from './validators/codePatternValidator.js';
16
+ import { DependencyValidator } from './validators/dependencyValidator.js';
17
+ import { ConsoleReporter } from './reporters/consoleReporter.js';
18
+ import { JsonReporter } from './reporters/jsonReporter.js';
19
+ import { MarkdownReporter } from './reporters/markdownReporter.js';
20
+ import { EnhancedReporter } from './reporters/enhancedReporter.js';
21
+ import { GraphBuilder } from './graph/graphBuilder.js';
22
+ import { GitChangeTracker } from './git/changeTracker.js';
23
+ import { CacheManager } from './cache/cacheManager.js';
24
+ import { FreshnessScorer } from './scoring/freshnessScorer.js';
25
+ import { IncrementalChecker } from './utils/incremental.js';
26
+ import { VectorSearch } from './semantic/vectorSearch.js';
27
+ import { loadConfig } from './config/loader.js';
28
+ /**
29
+ * Main entry point - run with config object
30
+ */
31
+ export async function run(config) {
32
+ // Show config file status in verbose mode
33
+ if (config.verbose) {
34
+ if (config._configFile) {
35
+ console.log(`Using config file: ${config._configFile}`);
36
+ }
37
+ else if (config._noConfigFile) {
38
+ console.log('No config file found, using defaults with auto-detection');
39
+ }
40
+ if (config.sourcePatterns) {
41
+ console.log(`Source patterns: ${config.sourcePatterns.join(', ')}`);
42
+ }
43
+ }
44
+ // Clear cache if requested
45
+ if (config.clearCache) {
46
+ const cacheManager = new CacheManager(config);
47
+ await cacheManager.clearCache();
48
+ if (config.verbose) {
49
+ console.log('Cache cleared.');
50
+ }
51
+ }
52
+ // Initialize components
53
+ const parser = new DocumentParser(config);
54
+ const validationEngine = new ValidationEngine(config);
55
+ // Register extractors
56
+ parser.registerExtractor(new FilePathExtractor());
57
+ parser.registerExtractor(new VersionExtractor(config));
58
+ parser.registerExtractor(new DirectoryStructureExtractor());
59
+ parser.registerExtractor(new CodePatternExtractor(config));
60
+ parser.registerExtractor(new ExternalUrlExtractor());
61
+ parser.registerExtractor(new DependencyExtractor(config));
62
+ // Register custom extractors
63
+ if (config.customExtractors) {
64
+ for (const extractor of config.customExtractors) {
65
+ parser.registerExtractor(extractor);
66
+ }
67
+ }
68
+ // Register validators
69
+ const codePatternValidator = new CodePatternValidator();
70
+ const urlValidator = new UrlValidator();
71
+ validationEngine.registerValidator('file-path', new FileValidator());
72
+ validationEngine.registerValidator('external-url', urlValidator);
73
+ validationEngine.registerValidator('version', new VersionValidator());
74
+ validationEngine.registerValidator('directory-structure', new DirectoryValidator());
75
+ validationEngine.registerValidator('code-pattern', codePatternValidator);
76
+ validationEngine.registerValidator('dependency', new DependencyValidator());
77
+ // Register custom validators
78
+ if (config.customValidators) {
79
+ for (const [type, validator] of Object.entries(config.customValidators)) {
80
+ validationEngine.registerValidator(type, validator);
81
+ }
82
+ }
83
+ // Load URL cache if available
84
+ if (config.cache?.enabled !== false) {
85
+ const cacheManager = new CacheManager(config);
86
+ const urlCache = await cacheManager.loadUrlCache();
87
+ urlValidator.loadCache(urlCache);
88
+ }
89
+ // Parse documents
90
+ if (config.verbose) {
91
+ console.log('Scanning documentation files...');
92
+ }
93
+ let documents = await parser.scanDocuments();
94
+ if (config.verbose) {
95
+ console.log(`Found ${documents.length} documentation files.`);
96
+ }
97
+ // Apply incremental checking if enabled
98
+ let incrementalChecker = null;
99
+ if (config.incremental?.enabled) {
100
+ incrementalChecker = new IncrementalChecker(config.cache?.dir || '.doc-freshness-cache');
101
+ const allDocs = documents;
102
+ documents = await incrementalChecker.filterChanged(documents);
103
+ if (config.verbose) {
104
+ const stats = incrementalChecker.getStats(allDocs.length, documents.length);
105
+ console.log(`Incremental mode: checking ${stats.changed} changed files, skipping ${stats.skipped} unchanged.`);
106
+ }
107
+ }
108
+ if (config.verbose) {
109
+ const totalRefs = documents.reduce((sum, doc) => sum + doc.references.length, 0);
110
+ console.log(`Extracted ${totalRefs} references.`);
111
+ }
112
+ // Validate references
113
+ if (config.verbose) {
114
+ console.log('Validating references...');
115
+ }
116
+ const results = await validationEngine.validate(documents);
117
+ // Save incremental state
118
+ if (incrementalChecker) {
119
+ await incrementalChecker.saveState();
120
+ }
121
+ // Build graph if enabled
122
+ let graph = null;
123
+ let gitTracker = null;
124
+ let freshnessScores = null;
125
+ if (config.graph?.enabled !== false) {
126
+ gitTracker = new GitChangeTracker(config);
127
+ // Build source code index for graph
128
+ await codePatternValidator.buildSourceIndex(config);
129
+ const codeIndex = codePatternValidator.getSourceIndex();
130
+ // Build graph
131
+ const graphBuilder = new GraphBuilder(config);
132
+ graph = await graphBuilder.buildGraph(documents, codeIndex);
133
+ if (gitTracker.isGitRepo()) {
134
+ graph.gitCommit = gitTracker.getCurrentCommit();
135
+ }
136
+ // Save graph cache
137
+ if (config.cache?.enabled !== false) {
138
+ const cacheManager = new CacheManager(config);
139
+ await cacheManager.saveGraph(graph);
140
+ await cacheManager.saveUrlCache(urlValidator.exportCache());
141
+ }
142
+ // Calculate freshness scores if enabled
143
+ if (config.freshnessScoring?.enabled) {
144
+ const scorer = new FreshnessScorer(config);
145
+ freshnessScores = scorer.calculateProjectScores(documents, results, gitTracker, graph);
146
+ }
147
+ }
148
+ // Run vector search if enabled
149
+ let vectorMismatches = null;
150
+ if (config.vectorSearch?.enabled) {
151
+ // Always show this message since embedding generation can take time
152
+ console.log('🔍 Running semantic analysis (this may take a moment on first run)...');
153
+ const vectorSearch = new VectorSearch(config);
154
+ // Index documentation
155
+ if (config.verbose) {
156
+ console.log(' Indexing documentation sections...');
157
+ }
158
+ await vectorSearch.indexDocumentation(documents);
159
+ // Ensure source index is built (may already be built if graph is enabled)
160
+ if (!codePatternValidator.getSourceIndex()) {
161
+ if (config.verbose) {
162
+ console.log(' Building source code index...');
163
+ }
164
+ await codePatternValidator.buildSourceIndex(config);
165
+ }
166
+ // Index code comments from source files
167
+ const sourceFiles = codePatternValidator.getSourceFiles();
168
+ if (sourceFiles && sourceFiles.size > 0) {
169
+ if (config.verbose) {
170
+ console.log(` Indexing code comments from ${sourceFiles.size} source files...`);
171
+ }
172
+ const codeFiles = Array.from(sourceFiles.entries()).map(([filePath, data]) => ({
173
+ path: filePath,
174
+ content: data.content,
175
+ language: data.language,
176
+ }));
177
+ await vectorSearch.indexCodeComments(codeFiles);
178
+ }
179
+ // Find mismatches
180
+ if (config.verbose) {
181
+ console.log(' Finding semantic mismatches...');
182
+ }
183
+ vectorMismatches = await vectorSearch.findMismatches();
184
+ const stats = vectorSearch.getCacheStats();
185
+ console.log(` ✓ Analyzed ${stats.indexedDocSections} doc sections and ${stats.indexedCodeComments} code comments`);
186
+ if (config.verbose) {
187
+ console.log(` Found ${vectorMismatches.length} potential semantic mismatches.`);
188
+ }
189
+ // Add vector mismatches to results
190
+ if (vectorMismatches.length > 0) {
191
+ results.vectorMismatches = vectorMismatches;
192
+ }
193
+ }
194
+ // Generate reports
195
+ await generateReports(results, config, graph, gitTracker, freshnessScores, vectorMismatches);
196
+ return results;
197
+ }
198
+ /**
199
+ * Run with config file path
200
+ */
201
+ export async function runWithConfig(configPath) {
202
+ const config = await loadConfig(configPath);
203
+ return run(config);
204
+ }
205
+ /**
206
+ * Generate reports based on configuration
207
+ */
208
+ async function generateReports(results, config, graph, gitTracker, freshnessScores, _vectorMismatches) {
209
+ const reporters = config.reporters || ['console'];
210
+ const emitOutput = async (output, reportName) => {
211
+ if (config.outputPath) {
212
+ await writeOutput(config.outputPath, output);
213
+ if (config.verbose) {
214
+ console.log(`${reportName} report written to ${config.outputPath}`);
215
+ }
216
+ return;
217
+ }
218
+ console.log(output);
219
+ };
220
+ for (const reporterType of reporters) {
221
+ switch (reporterType) {
222
+ case 'console': {
223
+ const reporter = new ConsoleReporter();
224
+ if (freshnessScores) {
225
+ reporter.generateWithScores(results, freshnessScores);
226
+ }
227
+ else {
228
+ reporter.generate(results);
229
+ }
230
+ break;
231
+ }
232
+ case 'json': {
233
+ const reporter = new JsonReporter();
234
+ const output = freshnessScores ? reporter.generateWithScores(results, freshnessScores) : reporter.generate(results);
235
+ await emitOutput(output, 'JSON');
236
+ break;
237
+ }
238
+ case 'markdown': {
239
+ const reporter = new MarkdownReporter();
240
+ const output = freshnessScores ? reporter.generateWithScores(results, freshnessScores) : reporter.generate(results);
241
+ await emitOutput(output, 'Markdown');
242
+ break;
243
+ }
244
+ case 'enhanced': {
245
+ const reporter = new EnhancedReporter();
246
+ const output = reporter.generateScanReport(results, graph, gitTracker, freshnessScores);
247
+ await emitOutput(output, 'Enhanced');
248
+ break;
249
+ }
250
+ default:
251
+ if (config.verbose) {
252
+ console.warn(`Unknown reporter type: ${reporterType}`);
253
+ }
254
+ }
255
+ }
256
+ }
257
+ /**
258
+ * Write output to file, creating directory if needed
259
+ */
260
+ async function writeOutput(outputPath, content) {
261
+ const dir = path.dirname(outputPath);
262
+ await fs.promises.mkdir(dir, { recursive: true });
263
+ await fs.promises.writeFile(outputPath, content, 'utf-8');
264
+ }
265
+ //# sourceMappingURL=runner.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"runner.js","sourceRoot":"","sources":["../src/runner.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2CAA2C,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,0CAA0C,CAAC;AAC5E,OAAO,EAAE,2BAA2B,EAAE,MAAM,qDAAqD,CAAC;AAClG,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,8CAA8C,CAAC;AACpF,OAAO,EAAE,mBAAmB,EAAE,MAAM,6CAA6C,CAAC;AAClF,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,eAAe,EAAE,MAAM,gCAAgC,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAC;AACnE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAIhD;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,GAAG,CAAC,MAA0B;IAClD,0CAA0C;IAC1C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,sBAAsB,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAC1D,CAAC;aAAM,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;YAChC,OAAO,CAAC,GAAG,CAAC,0DAA0D,CAAC,CAAC;QAC1E,CAAC;QACD,IAAI,MAAM,CAAC,cAAc,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,CAAC,oBAAoB,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAED,2BAA2B;IAC3B,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QACtB,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,YAAY,CAAC,UAAU,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,wBAAwB;IACxB,MAAM,MAAM,GAAG,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,gBAAgB,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAEtD,sBAAsB;IACtB,MAAM,CAAC,iBAAiB,CAAC,IAAI,iBAAiB,EAAE,CAAC,CAAC;IAClD,MAAM,CAAC,iBAAiB,CAAC,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;IACvD,MAAM,CAAC,iBAAiB,CAAC,IAAI,2BAA2B,EAAE,CAAC,CAAC;IAC5D,MAAM,CAAC,iBAAiB,CAAC,IAAI,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,MAAM,CAAC,iBAAiB,CAAC,IAAI,oBAAoB,EAAE,CAAC,CAAC;IACrD,MAAM,CAAC,iBAAiB,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1D,6BAA6B;IAC7B,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC5B,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAChD,MAAM,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;IACH,CAAC;IAED,sBAAsB;IACtB,MAAM,oBAAoB,GAAG,IAAI,oBAAoB,EAAE,CAAC;IACxD,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;IAExC,gBAAgB,CAAC,iBAAiB,CAAC,WAAW,EAAE,IAAI,aAAa,EAAE,CAAC,CAAC;IACrE,gBAAgB,CAAC,iBAAiB,CAAC,cAAc,EAAE,YAAY,CAAC,CAAC;IACjE,gBAAgB,CAAC,iBAAiB,CAAC,SAAS,EAAE,IAAI,gBAAgB,EAAE,CAAC,CAAC;IACtE,gBAAgB,CAAC,iBAAiB,CAAC,qBAAqB,EAAE,IAAI,kBAAkB,EAAE,CAAC,CAAC;IACpF,gBAAgB,CAAC,iBAAiB,CAAC,cAAc,EAAE,oBAAoB,CAAC,CAAC;IACzE,gBAAgB,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,mBAAmB,EAAE,CAAC,CAAC;IAE5E,6BAA6B;IAC7B,IAAI,MAAM,CAAC,gBAAgB,EAAE,CAAC;QAC5B,KAAK,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACxE,gBAAgB,CAAC,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;IAED,8BAA8B;IAC9B,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,EAAE,CAAC;QACpC,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAC9C,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC,YAAY,EAAE,CAAC;QACnD,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,kBAAkB;IAClB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;IACjD,CAAC;IAED,IAAI,SAAS,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;IAE7C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC,SAAS,SAAS,CAAC,MAAM,uBAAuB,CAAC,CAAC;IAChE,CAAC;IAED,wCAAwC;IACxC,IAAI,kBAAkB,GAA8B,IAAI,CAAC;IACzD,IAAI,MAAM,CAAC,WAAW,EAAE,OAAO,EAAE,CAAC;QAChC,kBAAkB,GAAG,IAAI,kBAAkB,CAAC,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,sBAAsB,CAAC,CAAC;QACzF,MAAM,OAAO,GAAG,SAAS,CAAC;QAC1B,SAAS,GAAG,MAAM,kBAAkB,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;QAE9D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,MAAM,KAAK,GAAG,kBAAkB,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;YAC5E,OAAO,CAAC,GAAG,CAAC,8BAA8B,KAAK,CAAC,OAAO,4BAA4B,KAAK,CAAC,OAAO,aAAa,CAAC,CAAC;QACjH,CAAC;IACH,CAAC;IAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,aAAa,SAAS,cAAc,CAAC,CAAC;IACpD,CAAC;IAED,sBAAsB;IACtB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;IAC1C,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IAE3D,yBAAyB;IACzB,IAAI,kBAAkB,EAAE,CAAC;QACvB,MAAM,kBAAkB,CAAC,SAAS,EAAE,CAAC;IACvC,CAAC;IAED,yBAAyB;IACzB,IAAI,KAAK,GAAwB,IAAI,CAAC;IACtC,IAAI,UAAU,GAA4B,IAAI,CAAC;IAC/C,IAAI,eAAe,GAAyB,IAAI,CAAC;IAEjD,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,EAAE,CAAC;QACpC,UAAU,GAAG,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAE1C,oCAAoC;QACpC,MAAM,oBAAoB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACpD,MAAM,SAAS,GAAG,oBAAoB,CAAC,cAAc,EAAE,CAAC;QAExD,cAAc;QACd,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAC9C,KAAK,GAAG,MAAM,YAAY,CAAC,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE5D,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,CAAC;YAC3B,KAAK,CAAC,SAAS,GAAG,UAAU,CAAC,gBAAgB,EAAE,CAAC;QAClD,CAAC;QAED,mBAAmB;QACnB,IAAI,MAAM,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,EAAE,CAAC;YACpC,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;YAC9C,MAAM,YAAY,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACpC,MAAM,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;QAC9D,CAAC;QAED,wCAAwC;QACxC,IAAI,MAAM,CAAC,gBAAgB,EAAE,OAAO,EAAE,CAAC;YACrC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;YAC3C,eAAe,GAAG,MAAM,CAAC,sBAAsB,CAAC,SAAS,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED,+BAA+B;IAC/B,IAAI,gBAAgB,GAA4B,IAAI,CAAC;IACrD,IAAI,MAAM,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC;QACjC,oEAAoE;QACpE,OAAO,CAAC,GAAG,CAAC,uEAAuE,CAAC,CAAC;QAErF,MAAM,YAAY,GAAG,IAAI,YAAY,CAAC,MAAM,CAAC,CAAC;QAE9C,sBAAsB;QACtB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,YAAY,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC;QAEjD,0EAA0E;QAC1E,IAAI,CAAC,oBAAoB,CAAC,cAAc,EAAE,EAAE,CAAC;YAC3C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC;YACjD,CAAC;YACD,MAAM,oBAAoB,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QACtD,CAAC;QAED,wCAAwC;QACxC,MAAM,WAAW,GAAG,oBAAoB,CAAC,cAAc,EAAE,CAAC;QAC1D,IAAI,WAAW,IAAI,WAAW,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACxC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,CAAC,iCAAiC,WAAW,CAAC,IAAI,kBAAkB,CAAC,CAAC;YACnF,CAAC;YACD,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;gBAC7E,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;aACxB,CAAC,CAAC,CAAC;YACJ,MAAM,YAAY,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAClD,CAAC;QAED,kBAAkB;QAClB,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAClD,CAAC;QACD,gBAAgB,GAAG,MAAM,YAAY,CAAC,cAAc,EAAE,CAAC;QAEvD,MAAM,KAAK,GAAG,YAAY,CAAC,aAAa,EAAE,CAAC;QAC3C,OAAO,CAAC,GAAG,CAAC,gBAAgB,KAAK,CAAC,kBAAkB,qBAAqB,KAAK,CAAC,mBAAmB,gBAAgB,CAAC,CAAC;QAEpH,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,WAAW,gBAAgB,CAAC,MAAM,iCAAiC,CAAC,CAAC;QACnF,CAAC;QAED,mCAAmC;QACnC,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAC9C,CAAC;IACH,CAAC;IAED,mBAAmB;IACnB,MAAM,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,gBAAgB,CAAC,CAAC;IAE7F,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,UAAkB;IACpD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC;IAC5C,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAC5B,OAA0B,EAC1B,MAA0B,EAC1B,KAA0B,EAC1B,UAAmC,EACnC,eAAqC,EACrC,iBAA0C;IAE1C,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,CAAC;IAElD,MAAM,UAAU,GAAG,KAAK,EAAE,MAAc,EAAE,UAAkB,EAAiB,EAAE;QAC7E,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;YACtB,MAAM,WAAW,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;YAC7C,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,CAAC,GAAG,UAAU,sBAAsB,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC;YACtE,CAAC;YACD,OAAO;QACT,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC,CAAC;IAEF,KAAK,MAAM,YAAY,IAAI,SAAS,EAAE,CAAC;QACrC,QAAQ,YAAY,EAAE,CAAC;YACrB,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;gBACvC,IAAI,eAAe,EAAE,CAAC;oBACpB,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;gBACxD,CAAC;qBAAM,CAAC;oBACN,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBAC7B,CAAC;gBACD,MAAM;YACR,CAAC;YAED,KAAK,MAAM,CAAC,CAAC,CAAC;gBACZ,MAAM,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;gBACpC,MAAM,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpH,MAAM,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;gBACjC,MAAM;YACR,CAAC;YAED,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;gBACxC,MAAM,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;gBACpH,MAAM,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;gBACrC,MAAM;YACR,CAAC;YAED,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;gBACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC;gBACxF,MAAM,UAAU,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;gBACrC,MAAM;YACR,CAAC;YAED;gBACE,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACnB,OAAO,CAAC,IAAI,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;gBACzD,CAAC;QACL,CAAC;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,WAAW,CAAC,UAAkB,EAAE,OAAe;IAC5D,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrC,MAAM,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AAC5D,CAAC"}
@@ -0,0 +1 @@
1
+ export {};