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":"versionExtractor.test.js","sourceRoot":"","sources":["../../../src/parsers/extractors/versionExtractor.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAGzD,SAAS,OAAO,CAAC,OAAe;IAC9B,OAAO;QACL,IAAI,EAAE,cAAc;QACpB,YAAY,EAAE,uBAAuB;QACrC,OAAO;QACP,MAAM,EAAE,UAAU;QAClB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;QAC1B,UAAU,EAAE,EAAE;KACf,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,SAAS,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAEzC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,GAAG,GAAG,OAAO,CAAC,4CAA4C,CAAC,CAAC;QAClE,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5E,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,YAAY,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,GAAG,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;QACtC,MAAM,GAAG,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,EAAE,YAAY,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QACtE,MAAM,GAAG,GAAG,OAAO,CAAC,oCAAoC,CAAC,CAAC;QAC1D,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,GAAG,GAAG,OAAO,CAAC,4BAA4B,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACpC,MAAM,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC;QACjC,CAAC,eAAe,EAAE,YAAY,EAAE,IAAI,CAAC;QACrC,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC;QACzB,CAAC,aAAa,EAAE,OAAO,EAAE,OAAO,CAAC;KAClC,CAAC,CAAC,mCAAmC,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE;QAC/D,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC;QAC/C,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,32 @@
1
+ import type { BaseExtractor, BaseValidator, DocFreshnessConfig, Document, ValidationResults } from '../types.js';
2
+ /**
3
+ * Plugin interface for extending doc-freshness functionality
4
+ */
5
+ export declare class Plugin {
6
+ name: string;
7
+ constructor(name: string);
8
+ /**
9
+ * Called when the plugin is registered
10
+ */
11
+ initialize(_config: DocFreshnessConfig): Promise<void>;
12
+ /**
13
+ * Return custom extractors
14
+ */
15
+ getExtractors(): BaseExtractor[];
16
+ /**
17
+ * Return custom validators
18
+ */
19
+ getValidators(): Record<string, BaseValidator>;
20
+ /**
21
+ * Return custom reporters
22
+ */
23
+ getReporters(): Record<string, unknown>;
24
+ /**
25
+ * Called before validation starts
26
+ */
27
+ beforeValidation(_documents: Document[]): Promise<void>;
28
+ /**
29
+ * Called after validation completes
30
+ */
31
+ afterValidation(_results: ValidationResults): Promise<void>;
32
+ }
@@ -0,0 +1,40 @@
1
+ /**
2
+ * Plugin interface for extending doc-freshness functionality
3
+ */
4
+ export class Plugin {
5
+ name;
6
+ constructor(name) {
7
+ this.name = name;
8
+ }
9
+ /**
10
+ * Called when the plugin is registered
11
+ */
12
+ async initialize(_config) { }
13
+ /**
14
+ * Return custom extractors
15
+ */
16
+ getExtractors() {
17
+ return [];
18
+ }
19
+ /**
20
+ * Return custom validators
21
+ */
22
+ getValidators() {
23
+ return {};
24
+ }
25
+ /**
26
+ * Return custom reporters
27
+ */
28
+ getReporters() {
29
+ return {};
30
+ }
31
+ /**
32
+ * Called before validation starts
33
+ */
34
+ async beforeValidation(_documents) { }
35
+ /**
36
+ * Called after validation completes
37
+ */
38
+ async afterValidation(_results) { }
39
+ }
40
+ //# sourceMappingURL=plugin.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugins/plugin.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,MAAM;IACjB,IAAI,CAAS;IAEb,YAAY,IAAY;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CAAC,OAA2B,IAAkB,CAAC;IAE/D;;OAEG;IACH,aAAa;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,gBAAgB,CAAC,UAAsB,IAAkB,CAAC;IAEhE;;OAEG;IACH,KAAK,CAAC,eAAe,CAAC,QAA2B,IAAkB,CAAC;CACrE"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,23 @@
1
+ import { Plugin } from './plugin.js';
2
+ describe('Plugin', () => {
3
+ it('has a name', () => {
4
+ const plugin = new Plugin('test-plugin');
5
+ expect(plugin.name).toBe('test-plugin');
6
+ });
7
+ it('returns empty arrays/objects from default methods', () => {
8
+ const plugin = new Plugin('test');
9
+ expect(plugin.getExtractors()).toEqual([]);
10
+ expect(plugin.getValidators()).toEqual({});
11
+ expect(plugin.getReporters()).toEqual({});
12
+ });
13
+ it('lifecycle hooks resolve without error', async () => {
14
+ const plugin = new Plugin('test');
15
+ await expect(plugin.initialize({})).resolves.not.toThrow();
16
+ await expect(plugin.beforeValidation([])).resolves.not.toThrow();
17
+ await expect(plugin.afterValidation({
18
+ documents: [],
19
+ summary: { total: 0, valid: 0, errors: 0, warnings: 0, skipped: 0 },
20
+ })).resolves.not.toThrow();
21
+ });
22
+ });
23
+ //# sourceMappingURL=plugin.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.test.js","sourceRoot":"","sources":["../../src/plugins/plugin.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE;QACpB,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC;QACzC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACrD,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC;QAClC,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAC3D,MAAM,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACjE,MAAM,MAAM,CACV,MAAM,CAAC,eAAe,CAAC;YACrB,SAAS,EAAE,EAAE;YACb,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,CACH,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,15 @@
1
+ import type { ProjectScores, ValidationResults } from '../types.js';
2
+ /**
3
+ * Console reporter for terminal output
4
+ */
5
+ export declare class ConsoleReporter {
6
+ generate(results: ValidationResults): void;
7
+ /**
8
+ * Generate with freshness scores
9
+ */
10
+ generateWithScores(results: ValidationResults, freshnessScores: ProjectScores | null): void;
11
+ /**
12
+ * Generate vector mismatch report
13
+ */
14
+ private generateVectorMismatches;
15
+ }
@@ -0,0 +1,73 @@
1
+ /**
2
+ * Console reporter for terminal output
3
+ */
4
+ export class ConsoleReporter {
5
+ generate(results) {
6
+ const { summary, documents } = results;
7
+ console.log('\n📚 Documentation Freshness Report\n');
8
+ console.log('━'.repeat(50));
9
+ console.log(`\n📊 Summary:`);
10
+ console.log(` Total references checked: ${summary.total}`);
11
+ console.log(` ✅ Valid: ${summary.valid}`);
12
+ console.log(` ❌ Errors: ${summary.errors}`);
13
+ console.log(` ⚠️ Warnings: ${summary.warnings}`);
14
+ console.log(` ⏭️ Skipped: ${summary.skipped}`);
15
+ if (documents.length === 0) {
16
+ console.log('\n✨ All documentation is up to date!\n');
17
+ return;
18
+ }
19
+ console.log('\n📋 Issues by Document:\n');
20
+ for (const doc of documents) {
21
+ console.log(`\n📄 ${doc.path}`);
22
+ console.log('─'.repeat(40));
23
+ for (const issue of doc.issues) {
24
+ const icon = issue.severity === 'error' ? '❌' : '⚠️';
25
+ const ref = issue.reference;
26
+ console.log(` ${icon} Line ${ref.lineNumber}: ${issue.message}`);
27
+ if (issue.suggestion) {
28
+ console.log(` 💡 ${issue.suggestion}`);
29
+ }
30
+ }
31
+ }
32
+ console.log('\n');
33
+ }
34
+ /**
35
+ * Generate with freshness scores
36
+ */
37
+ generateWithScores(results, freshnessScores) {
38
+ this.generate(results);
39
+ if (freshnessScores) {
40
+ console.log('📊 Freshness Scores:\n');
41
+ console.log(` Project Score: ${freshnessScores.projectScore}/100 (Grade: ${freshnessScores.projectGrade})\n`);
42
+ console.log(' By Document:');
43
+ for (const doc of freshnessScores.documents) {
44
+ const grade = doc.grade;
45
+ const icon = grade === 'A' ? '🟢' : grade === 'B' ? '🟡' : grade === 'C' ? '🟠' : '🔴';
46
+ console.log(` ${icon} ${doc.document}: ${doc.totalScore}/100 (${grade})`);
47
+ }
48
+ console.log('');
49
+ }
50
+ // Show vector mismatches if present
51
+ if (results.vectorMismatches && results.vectorMismatches.length > 0) {
52
+ this.generateVectorMismatches(results.vectorMismatches);
53
+ }
54
+ }
55
+ /**
56
+ * Generate vector mismatch report
57
+ */
58
+ generateVectorMismatches(mismatches) {
59
+ console.log('🔍 Semantic Analysis (Vector Search):\n');
60
+ console.log(` Found ${mismatches.length} potential documentation-code mismatches:\n`);
61
+ for (const mismatch of mismatches) {
62
+ console.log(` ⚠️ ${mismatch.docPath}`);
63
+ console.log(` Section: "${mismatch.docSection}"`);
64
+ console.log(` Similarity: ${(mismatch.bestMatchScore * 100).toFixed(1)}%`);
65
+ if (mismatch.bestMatch) {
66
+ console.log(` Best match: ${mismatch.bestMatch.path} (${mismatch.bestMatch.symbol})`);
67
+ }
68
+ console.log(` 💡 ${mismatch.suggestion}`);
69
+ console.log('');
70
+ }
71
+ }
72
+ }
73
+ //# sourceMappingURL=consoleReporter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consoleReporter.js","sourceRoot":"","sources":["../../src/reporters/consoleReporter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,OAAO,eAAe;IAC1B,QAAQ,CAAC,OAA0B;QACjC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;QAEvC,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;QACrD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;QAE5B,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;QAC7B,OAAO,CAAC,GAAG,CAAC,gCAAgC,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAC7D,OAAO,CAAC,GAAG,CAAC,eAAe,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;QAC5C,OAAO,CAAC,GAAG,CAAC,gBAAgB,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;QAC9C,OAAO,CAAC,GAAG,CAAC,oBAAoB,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;QACpD,OAAO,CAAC,GAAG,CAAC,mBAAmB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QAElD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,wCAAwC,CAAC,CAAC;YACtD,OAAO;QACT,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;QAE1C,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;YAC5B,OAAO,CAAC,GAAG,CAAC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YAChC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC;YAE5B,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;gBAC/B,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;gBACrD,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC;gBAC5B,OAAO,CAAC,GAAG,CAAC,KAAK,IAAI,SAAS,GAAG,CAAC,UAAU,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBAClE,IAAI,KAAK,CAAC,UAAU,EAAE,CAAC;oBACrB,OAAO,CAAC,GAAG,CAAC,WAAW,KAAK,CAAC,UAAU,EAAE,CAAC,CAAC;gBAC7C,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,OAA0B,EAAE,eAAqC;QAClF,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEvB,IAAI,eAAe,EAAE,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;YACtC,OAAO,CAAC,GAAG,CAAC,qBAAqB,eAAe,CAAC,YAAY,gBAAgB,eAAe,CAAC,YAAY,KAAK,CAAC,CAAC;YAEhH,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YAC/B,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,SAAS,EAAE,CAAC;gBAC5C,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC;gBACxB,MAAM,IAAI,GAAG,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;gBACvF,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,IAAI,GAAG,CAAC,QAAQ,KAAK,GAAG,CAAC,UAAU,SAAS,KAAK,GAAG,CAAC,CAAC;YAC9E,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClB,CAAC;QAED,oCAAoC;QACpC,IAAI,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpE,IAAI,CAAC,wBAAwB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAC1D,CAAC;IACH,CAAC;IAED;;OAEG;IACK,wBAAwB,CAAC,UAA4B;QAC3D,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;QACvD,OAAO,CAAC,GAAG,CAAC,YAAY,UAAU,CAAC,MAAM,6CAA6C,CAAC,CAAC;QAExF,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,CAAC,UAAU,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;YAC1C,OAAO,CAAC,GAAG,CAAC,mBAAmB,QAAQ,CAAC,UAAU,GAAG,CAAC,CAAC;YACvD,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAChF,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;gBACvB,OAAO,CAAC,GAAG,CAAC,qBAAqB,QAAQ,CAAC,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;YAC7F,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,YAAY,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;YAC/C,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;CACF"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,155 @@
1
+ import { ConsoleReporter } from './consoleReporter.js';
2
+ import { captureConsoleLog } from '../test-utils/console.js';
3
+ describe('ConsoleReporter', () => {
4
+ const reporter = new ConsoleReporter();
5
+ const cleanResults = {
6
+ documents: [],
7
+ summary: { total: 5, valid: 5, errors: 0, warnings: 0, skipped: 0 },
8
+ };
9
+ const resultsWithIssues = {
10
+ documents: [
11
+ {
12
+ path: 'docs/api.md',
13
+ issues: [
14
+ {
15
+ reference: { type: 'file-path', value: 'missing.ts', lineNumber: 10, raw: 'missing.ts', sourceFile: 'api.md' },
16
+ valid: false,
17
+ severity: 'error',
18
+ message: 'File not found: missing.ts',
19
+ suggestion: 'Did you mean: missing.tsx?',
20
+ },
21
+ {
22
+ reference: { type: 'external-url', value: 'https://old.com', lineNumber: 20, raw: 'https://old.com', sourceFile: 'api.md' },
23
+ valid: false,
24
+ severity: 'warning',
25
+ message: 'URL returned 404',
26
+ },
27
+ ],
28
+ },
29
+ ],
30
+ summary: { total: 5, valid: 3, errors: 1, warnings: 1, skipped: 0 },
31
+ };
32
+ it('generate() logs summary and "up to date" for clean results', () => {
33
+ const spy = captureConsoleLog();
34
+ reporter.generate(cleanResults);
35
+ const output = spy.mock.calls.flat().join('\n');
36
+ expect(output).toContain('Valid: 5');
37
+ expect(output).toContain('up to date');
38
+ });
39
+ it('generate() logs issues with error and warning icons', () => {
40
+ const spy = captureConsoleLog();
41
+ reporter.generate(resultsWithIssues);
42
+ const output = spy.mock.calls.flat().join('\n');
43
+ expect(output).toContain('File not found');
44
+ expect(output).toContain('missing.tsx');
45
+ expect(output).toContain('URL returned 404');
46
+ expect(output).toContain('Line 10');
47
+ expect(output).toContain('Line 20');
48
+ });
49
+ it('generateWithScores() includes freshness scores', () => {
50
+ const spy = captureConsoleLog();
51
+ const scores = {
52
+ projectScore: 85,
53
+ projectGrade: 'B',
54
+ documents: [
55
+ {
56
+ document: 'docs/api.md',
57
+ totalScore: 85,
58
+ factors: { referenceValidity: 100, gitTimeDelta: 75, codeChangeFrequency: 75, symbolCoverage: 80 },
59
+ grade: 'B',
60
+ },
61
+ ],
62
+ summary: { total: 1, gradeA: 0, gradeB: 1, gradeC: 0, gradeD: 0, gradeF: 0 },
63
+ };
64
+ reporter.generateWithScores(cleanResults, scores);
65
+ const output = spy.mock.calls.flat().join('\n');
66
+ expect(output).toContain('85/100');
67
+ expect(output).toContain('Grade: B');
68
+ });
69
+ it('generateWithScores() with null scores skips scores section', () => {
70
+ const spy = captureConsoleLog();
71
+ reporter.generateWithScores(cleanResults, null);
72
+ const output = spy.mock.calls.flat().join('\n');
73
+ expect(output).not.toContain('Freshness Scores');
74
+ });
75
+ it('generateWithScores() shows all grade icons', () => {
76
+ const spy = captureConsoleLog();
77
+ const scores = {
78
+ projectScore: 70,
79
+ projectGrade: 'C',
80
+ documents: [
81
+ {
82
+ document: 'a.md',
83
+ totalScore: 95,
84
+ factors: { referenceValidity: 100, gitTimeDelta: 90, codeChangeFrequency: 90, symbolCoverage: 90 },
85
+ grade: 'A',
86
+ },
87
+ {
88
+ document: 'b.md',
89
+ totalScore: 85,
90
+ factors: { referenceValidity: 90, gitTimeDelta: 80, codeChangeFrequency: 80, symbolCoverage: 80 },
91
+ grade: 'B',
92
+ },
93
+ {
94
+ document: 'c.md',
95
+ totalScore: 75,
96
+ factors: { referenceValidity: 80, gitTimeDelta: 70, codeChangeFrequency: 70, symbolCoverage: 70 },
97
+ grade: 'C',
98
+ },
99
+ {
100
+ document: 'd.md',
101
+ totalScore: 50,
102
+ factors: { referenceValidity: 50, gitTimeDelta: 50, codeChangeFrequency: 50, symbolCoverage: 50 },
103
+ grade: 'F',
104
+ },
105
+ ],
106
+ summary: { total: 4, gradeA: 1, gradeB: 1, gradeC: 1, gradeD: 0, gradeF: 1 },
107
+ };
108
+ reporter.generateWithScores(cleanResults, scores);
109
+ const output = spy.mock.calls.flat().join('\n');
110
+ expect(output).toContain('🟢');
111
+ expect(output).toContain('🟡');
112
+ expect(output).toContain('🟠');
113
+ expect(output).toContain('🔴');
114
+ });
115
+ it('generateWithScores() shows vector mismatches when present', () => {
116
+ const spy = captureConsoleLog();
117
+ const mismatches = [
118
+ {
119
+ docPath: 'docs/api.md',
120
+ docSection: 'Auth API',
121
+ docText: 'This function handles auth',
122
+ bestMatchScore: 0.2,
123
+ bestMatch: { type: 'code', path: 'src/db.ts', symbol: 'dbConnect', text: 'DB connect' },
124
+ suggestion: 'Documentation may describe functionality not found in code',
125
+ },
126
+ ];
127
+ const results = { ...cleanResults, vectorMismatches: mismatches };
128
+ reporter.generateWithScores(results, null);
129
+ const output = spy.mock.calls.flat().join('\n');
130
+ expect(output).toContain('Semantic Analysis');
131
+ expect(output).toContain('docs/api.md');
132
+ expect(output).toContain('Auth API');
133
+ expect(output).toContain('src/db.ts');
134
+ expect(output).toContain('20.0%');
135
+ });
136
+ it('generateVectorMismatches handles mismatches without bestMatch', () => {
137
+ const spy = captureConsoleLog();
138
+ const mismatches = [
139
+ {
140
+ docPath: 'docs/guide.md',
141
+ docSection: 'Setup',
142
+ docText: 'Setup instructions',
143
+ bestMatchScore: 0,
144
+ bestMatch: null,
145
+ suggestion: 'No matching code found',
146
+ },
147
+ ];
148
+ const results = { ...cleanResults, vectorMismatches: mismatches };
149
+ reporter.generateWithScores(results, null);
150
+ const output = spy.mock.calls.flat().join('\n');
151
+ expect(output).toContain('docs/guide.md');
152
+ expect(output).not.toContain('Best match:');
153
+ });
154
+ });
155
+ //# sourceMappingURL=consoleReporter.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consoleReporter.test.js","sourceRoot":"","sources":["../../src/reporters/consoleReporter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAE7D,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,MAAM,QAAQ,GAAG,IAAI,eAAe,EAAE,CAAC;IAEvC,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,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;QAChC,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAChC,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,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,qDAAqD,EAAE,GAAG,EAAE;QAC7D,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;QAChC,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QACrC,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,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;QAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;QAChC,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,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACnC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;QAChC,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;QAChD,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;QAChC,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;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;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,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;QAChC,MAAM,UAAU,GAAqB;YACnC;gBACE,OAAO,EAAE,aAAa;gBACtB,UAAU,EAAE,UAAU;gBACtB,OAAO,EAAE,4BAA4B;gBACrC,cAAc,EAAE,GAAG;gBACnB,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,YAAY,EAAE;gBACvF,UAAU,EAAE,4DAA4D;aACzE;SACF,CAAC;QACF,MAAM,OAAO,GAAsB,EAAE,GAAG,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAC;QACrF,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAC9C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACvE,MAAM,GAAG,GAAG,iBAAiB,EAAE,CAAC;QAChC,MAAM,UAAU,GAAqB;YACnC;gBACE,OAAO,EAAE,eAAe;gBACxB,UAAU,EAAE,OAAO;gBACnB,OAAO,EAAE,oBAAoB;gBAC7B,cAAc,EAAE,CAAC;gBACjB,SAAS,EAAE,IAAI;gBACf,UAAU,EAAE,wBAAwB;aACrC;SACF,CAAC;QACF,MAAM,OAAO,GAAsB,EAAE,GAAG,YAAY,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAC;QACrF,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,12 @@
1
+ import type { ProjectScores, ValidationResults } from '../types.js';
2
+ import type { CodeDocGraph } from '../graph/codeDocGraph.js';
3
+ import type { GitChangeTracker } from '../git/changeTracker.js';
4
+ /**
5
+ * Enhanced reporter with DeepDocs-style output
6
+ */
7
+ export declare class EnhancedReporter {
8
+ /**
9
+ * Generate a DeepDocs-style scan report
10
+ */
11
+ generateScanReport(results: ValidationResults, graph: CodeDocGraph | null, gitTracker: GitChangeTracker | null, freshnessScores: ProjectScores | null): string;
12
+ }
@@ -0,0 +1,81 @@
1
+ /**
2
+ * Enhanced reporter with DeepDocs-style output
3
+ */
4
+ export class EnhancedReporter {
5
+ /**
6
+ * Generate a DeepDocs-style scan report
7
+ */
8
+ generateScanReport(results, graph, gitTracker, freshnessScores) {
9
+ let report = '';
10
+ report += '# 📚 Documentation Freshness Scan Report\n\n';
11
+ report += `**Generated:** ${new Date().toISOString()}\n\n`;
12
+ // Project Score
13
+ if (freshnessScores) {
14
+ report += `## 📊 Project Freshness Score: ${freshnessScores.projectScore}/100 `;
15
+ report += `(Grade: ${freshnessScores.projectGrade})\n\n`;
16
+ report += '| Grade | Count |\n|-------|-------|\n';
17
+ report += `| A (90-100) | ${freshnessScores.summary.gradeA} |\n`;
18
+ report += `| B (80-89) | ${freshnessScores.summary.gradeB} |\n`;
19
+ report += `| C (70-79) | ${freshnessScores.summary.gradeC} |\n`;
20
+ report += `| D (60-69) | ${freshnessScores.summary.gradeD} |\n`;
21
+ report += `| F (0-59) | ${freshnessScores.summary.gradeF} |\n\n`;
22
+ }
23
+ // Validation Summary
24
+ report += '## ✅ Validation Summary\n\n';
25
+ report += `- **Total References:** ${results.summary.total}\n`;
26
+ report += `- **Valid:** ${results.summary.valid}\n`;
27
+ report += `- **Errors:** ${results.summary.errors}\n`;
28
+ report += `- **Warnings:** ${results.summary.warnings}\n\n`;
29
+ // Affected Documents (DeepDocs-style)
30
+ if (results.documents.length > 0) {
31
+ report += '## 📋 Affected Documents\n\n';
32
+ for (const doc of results.documents) {
33
+ const score = freshnessScores?.documents.find((d) => d.document === doc.path);
34
+ const scoreStr = score ? ` (Score: ${score.totalScore}, Grade: ${score.grade})` : '';
35
+ report += `### 📄 \`${doc.path}\`${scoreStr}\n\n`;
36
+ // Show referenced code files
37
+ const codeFiles = graph?.getCodeReferencedByDoc(doc.path);
38
+ if (codeFiles && codeFiles.size > 0) {
39
+ report += '**Referenced Code Files:**\n';
40
+ for (const codeFile of codeFiles) {
41
+ const commitInfo = gitTracker?.getFileCommitInfo(codeFile);
42
+ const commitStr = commitInfo ? ` (last modified: ${new Date(commitInfo.timestamp).toLocaleDateString()})` : '';
43
+ report += `- \`${codeFile}\`${commitStr}\n`;
44
+ }
45
+ report += '\n';
46
+ }
47
+ // Issues table
48
+ report += '| Line | Type | Issue | Suggestion |\n';
49
+ report += '|------|------|-------|------------|\n';
50
+ for (const issue of doc.issues) {
51
+ const severity = issue.severity === 'error' ? '❌' : '⚠️';
52
+ const suggestion = issue.suggestion || '-';
53
+ const message = (issue.message || '').replace(/\|/g, '\\|');
54
+ report += `| ${issue.reference.lineNumber} | ${severity} ${issue.reference.type} | ${message} | ${suggestion} |\n`;
55
+ }
56
+ report += '\n';
57
+ }
58
+ }
59
+ // Code Change Impact (if git available)
60
+ if (gitTracker?.isGitRepo() && graph) {
61
+ try {
62
+ const recentChanges = gitTracker.getChangedFilesSince(Date.now() - 7 * 24 * 60 * 60 * 1000 // Last 7 days
63
+ );
64
+ const impactedDocs = gitTracker.getAffectedDocs(graph, recentChanges);
65
+ if (impactedDocs.length > 0) {
66
+ report += '## 🔄 Recent Code Changes Impacting Docs\n\n';
67
+ report += 'The following documents reference code that changed in the last 7 days:\n\n';
68
+ for (const docPath of impactedDocs) {
69
+ report += `- \`${docPath}\`\n`;
70
+ }
71
+ report += '\n';
72
+ }
73
+ }
74
+ catch {
75
+ // Git operations failed
76
+ }
77
+ }
78
+ return report;
79
+ }
80
+ }
81
+ //# sourceMappingURL=enhancedReporter.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enhancedReporter.js","sourceRoot":"","sources":["../../src/reporters/enhancedReporter.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC3B;;OAEG;IACH,kBAAkB,CAChB,OAA0B,EAC1B,KAA0B,EAC1B,UAAmC,EACnC,eAAqC;QAErC,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,MAAM,IAAI,8CAA8C,CAAC;QACzD,MAAM,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC;QAE3D,gBAAgB;QAChB,IAAI,eAAe,EAAE,CAAC;YACpB,MAAM,IAAI,kCAAkC,eAAe,CAAC,YAAY,OAAO,CAAC;YAChF,MAAM,IAAI,WAAW,eAAe,CAAC,YAAY,OAAO,CAAC;YAEzD,MAAM,IAAI,wCAAwC,CAAC;YACnD,MAAM,IAAI,kBAAkB,eAAe,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC;YACjE,MAAM,IAAI,kBAAkB,eAAe,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC;YACjE,MAAM,IAAI,kBAAkB,eAAe,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC;YACjE,MAAM,IAAI,kBAAkB,eAAe,CAAC,OAAO,CAAC,MAAM,MAAM,CAAC;YACjE,MAAM,IAAI,kBAAkB,eAAe,CAAC,OAAO,CAAC,MAAM,QAAQ,CAAC;QACrE,CAAC;QAED,qBAAqB;QACrB,MAAM,IAAI,6BAA6B,CAAC;QACxC,MAAM,IAAI,2BAA2B,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;QAC/D,MAAM,IAAI,gBAAgB,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;QACpD,MAAM,IAAI,iBAAiB,OAAO,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC;QACtD,MAAM,IAAI,mBAAmB,OAAO,CAAC,OAAO,CAAC,QAAQ,MAAM,CAAC;QAE5D,sCAAsC;QACtC,IAAI,OAAO,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,MAAM,IAAI,8BAA8B,CAAC;YAEzC,KAAK,MAAM,GAAG,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;gBACpC,MAAM,KAAK,GAAG,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC9E,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,YAAY,KAAK,CAAC,UAAU,YAAY,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;gBAErF,MAAM,IAAI,YAAY,GAAG,CAAC,IAAI,KAAK,QAAQ,MAAM,CAAC;gBAElD,6BAA6B;gBAC7B,MAAM,SAAS,GAAG,KAAK,EAAE,sBAAsB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC1D,IAAI,SAAS,IAAI,SAAS,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;oBACpC,MAAM,IAAI,8BAA8B,CAAC;oBACzC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;wBACjC,MAAM,UAAU,GAAG,UAAU,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;wBAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,oBAAoB,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC/G,MAAM,IAAI,OAAO,QAAQ,KAAK,SAAS,IAAI,CAAC;oBAC9C,CAAC;oBACD,MAAM,IAAI,IAAI,CAAC;gBACjB,CAAC;gBAED,eAAe;gBACf,MAAM,IAAI,wCAAwC,CAAC;gBACnD,MAAM,IAAI,wCAAwC,CAAC;gBAEnD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;oBACzD,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,IAAI,GAAG,CAAC;oBAC3C,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;oBAC5D,MAAM,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,UAAU,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,CAAC,IAAI,MAAM,OAAO,MAAM,UAAU,MAAM,CAAC;gBACrH,CAAC;gBAED,MAAM,IAAI,IAAI,CAAC;YACjB,CAAC;QACH,CAAC;QAED,wCAAwC;QACxC,IAAI,UAAU,EAAE,SAAS,EAAE,IAAI,KAAK,EAAE,CAAC;YACrC,IAAI,CAAC;gBACH,MAAM,aAAa,GAAG,UAAU,CAAC,oBAAoB,CACnD,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,cAAc;iBACpD,CAAC;gBAEF,MAAM,YAAY,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;gBAEtE,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC5B,MAAM,IAAI,8CAA8C,CAAC;oBACzD,MAAM,IAAI,6EAA6E,CAAC;oBAExF,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;wBACnC,MAAM,IAAI,OAAO,OAAO,MAAM,CAAC;oBACjC,CAAC;oBACD,MAAM,IAAI,IAAI,CAAC;gBACjB,CAAC;YACH,CAAC;YAAC,MAAM,CAAC;gBACP,wBAAwB;YAC1B,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,152 @@
1
+ import { EnhancedReporter } from './enhancedReporter.js';
2
+ import { CodeDocGraph } from '../graph/codeDocGraph.js';
3
+ describe('EnhancedReporter', () => {
4
+ const reporter = new EnhancedReporter();
5
+ const results = {
6
+ documents: [
7
+ {
8
+ path: 'docs/api.md',
9
+ issues: [
10
+ {
11
+ reference: { type: 'file-path', value: 'missing.ts', lineNumber: 5, raw: 'missing.ts', sourceFile: 'api.md' },
12
+ valid: false,
13
+ severity: 'error',
14
+ message: 'File not found',
15
+ suggestion: 'Did you mean missing.tsx?',
16
+ },
17
+ {
18
+ reference: { type: 'external-url', value: 'https://old.com', lineNumber: 12, raw: 'https://old.com', sourceFile: 'api.md' },
19
+ valid: false,
20
+ severity: 'warning',
21
+ message: 'URL returned 404',
22
+ },
23
+ ],
24
+ },
25
+ ],
26
+ summary: { total: 3, valid: 1, errors: 1, warnings: 1, skipped: 0 },
27
+ };
28
+ const emptyResults = {
29
+ documents: [],
30
+ summary: { total: 0, valid: 0, errors: 0, warnings: 0, skipped: 0 },
31
+ };
32
+ it('generates scan report with validation summary', () => {
33
+ const report = reporter.generateScanReport(results, null, null, null);
34
+ expect(report).toContain('Documentation Freshness Scan Report');
35
+ expect(report).toContain('Total References:** 3');
36
+ expect(report).toContain('Errors:** 1');
37
+ expect(report).toContain('Warnings:** 1');
38
+ });
39
+ it('includes freshness scores with grade table', () => {
40
+ const scores = {
41
+ projectScore: 80,
42
+ projectGrade: 'B',
43
+ documents: [
44
+ {
45
+ document: 'docs/api.md',
46
+ totalScore: 80,
47
+ factors: { referenceValidity: 80, gitTimeDelta: 80, codeChangeFrequency: 80, symbolCoverage: 80 },
48
+ grade: 'B',
49
+ },
50
+ ],
51
+ summary: { total: 1, gradeA: 0, gradeB: 1, gradeC: 0, gradeD: 0, gradeF: 0 },
52
+ };
53
+ const report = reporter.generateScanReport(results, null, null, scores);
54
+ expect(report).toContain('80/100');
55
+ expect(report).toContain('Grade: B');
56
+ expect(report).toContain('A (90-100)');
57
+ });
58
+ it('shows referenced code files from graph', () => {
59
+ const graph = new CodeDocGraph();
60
+ graph.addReference('docs/api.md', 'src/server.ts', {
61
+ type: 'file-path',
62
+ value: 'src/server.ts',
63
+ lineNumber: 1,
64
+ raw: 'src/server.ts',
65
+ sourceFile: 'api.md',
66
+ });
67
+ const report = reporter.generateScanReport(results, graph, null, null);
68
+ expect(report).toContain('src/server.ts');
69
+ expect(report).toContain('Referenced Code Files');
70
+ });
71
+ it('shows commit info for referenced code files', () => {
72
+ const graph = new CodeDocGraph();
73
+ graph.addReference('docs/api.md', 'src/server.ts', {
74
+ type: 'file-path',
75
+ value: 'src/server.ts',
76
+ lineNumber: 1,
77
+ raw: 'src/server.ts',
78
+ sourceFile: 'api.md',
79
+ });
80
+ const gitTracker = {
81
+ isGitRepo: () => true,
82
+ getFileCommitInfo: vi.fn().mockReturnValue({ hash: 'abc', timestamp: Date.now(), message: 'fix' }),
83
+ getChangedFilesSince: vi.fn().mockReturnValue([]),
84
+ getAffectedDocs: vi.fn().mockReturnValue([]),
85
+ };
86
+ const report = reporter.generateScanReport(results, graph, gitTracker, null);
87
+ expect(report).toContain('last modified');
88
+ });
89
+ it('shows document score inline when scores are provided', () => {
90
+ const scores = {
91
+ projectScore: 80,
92
+ projectGrade: 'B',
93
+ documents: [
94
+ {
95
+ document: 'docs/api.md',
96
+ totalScore: 80,
97
+ factors: { referenceValidity: 80, gitTimeDelta: 80, codeChangeFrequency: 80, symbolCoverage: 80 },
98
+ grade: 'B',
99
+ },
100
+ ],
101
+ summary: { total: 1, gradeA: 0, gradeB: 1, gradeC: 0, gradeD: 0, gradeF: 0 },
102
+ };
103
+ const report = reporter.generateScanReport(results, null, null, scores);
104
+ expect(report).toContain('Score: 80');
105
+ expect(report).toContain('Grade: B');
106
+ });
107
+ it('shows issues table with both error and warning severity, plus suggestions', () => {
108
+ const report = reporter.generateScanReport(results, null, null, null);
109
+ expect(report).toContain('❌');
110
+ expect(report).toContain('⚠️');
111
+ expect(report).toContain('File not found');
112
+ expect(report).toContain('missing.tsx');
113
+ expect(report).toContain('URL returned 404');
114
+ });
115
+ it('omits affected documents section when no documents have issues', () => {
116
+ const report = reporter.generateScanReport(emptyResults, null, null, null);
117
+ expect(report).not.toContain('Affected Documents');
118
+ });
119
+ it('shows recent code changes impacting docs when git is available', () => {
120
+ const graph = new CodeDocGraph();
121
+ graph.addReference('docs/api.md', 'src/server.ts', {
122
+ type: 'file-path',
123
+ value: 'src/server.ts',
124
+ lineNumber: 1,
125
+ raw: 'src/server.ts',
126
+ sourceFile: 'api.md',
127
+ });
128
+ const gitTracker = {
129
+ isGitRepo: () => true,
130
+ getFileCommitInfo: vi.fn().mockReturnValue(null),
131
+ getChangedFilesSince: vi.fn().mockReturnValue(['src/server.ts']),
132
+ getAffectedDocs: vi.fn().mockReturnValue(['docs/api.md']),
133
+ };
134
+ const report = reporter.generateScanReport(emptyResults, graph, gitTracker, null);
135
+ expect(report).toContain('Recent Code Changes');
136
+ expect(report).toContain('docs/api.md');
137
+ });
138
+ it('handles git operation errors gracefully', () => {
139
+ const graph = new CodeDocGraph();
140
+ const gitTracker = {
141
+ isGitRepo: () => true,
142
+ getFileCommitInfo: vi.fn(),
143
+ getChangedFilesSince: vi.fn().mockImplementation(() => {
144
+ throw new Error('git error');
145
+ }),
146
+ getAffectedDocs: vi.fn(),
147
+ };
148
+ const report = reporter.generateScanReport(emptyResults, graph, gitTracker, null);
149
+ expect(report).not.toContain('Recent Code Changes');
150
+ });
151
+ });
152
+ //# sourceMappingURL=enhancedReporter.test.js.map