doc-freshness-checker 2.0.23 → 2.2.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 (98) hide show
  1. package/README.md +19 -0
  2. package/dist/config/defaults.js +9 -3
  3. package/dist/config/defaults.js.map +1 -1
  4. package/dist/index.d.ts +6 -1
  5. package/dist/index.js +5 -0
  6. package/dist/index.js.map +1 -1
  7. package/dist/manifests/manifestInventory.d.ts +28 -0
  8. package/dist/manifests/manifestInventory.js +225 -0
  9. package/dist/manifests/manifestInventory.js.map +1 -0
  10. package/dist/manifests/manifestInventory.test.d.ts +1 -0
  11. package/dist/manifests/manifestInventory.test.js +176 -0
  12. package/dist/manifests/manifestInventory.test.js.map +1 -0
  13. package/dist/manifests/validatorConstructors.test.d.ts +1 -0
  14. package/dist/manifests/validatorConstructors.test.js +17 -0
  15. package/dist/manifests/validatorConstructors.test.js.map +1 -0
  16. package/dist/parsers/documentParser.d.ts +2 -3
  17. package/dist/parsers/documentParser.js.map +1 -1
  18. package/dist/parsers/extractorInterface.test.d.ts +1 -0
  19. package/dist/parsers/extractorInterface.test.js +34 -0
  20. package/dist/parsers/extractorInterface.test.js.map +1 -0
  21. package/dist/parsers/extractors/codeSnippetExtractor.js.map +1 -1
  22. package/dist/plugins/plugin.d.ts +5 -1
  23. package/dist/plugins/plugin.js +5 -1
  24. package/dist/plugins/plugin.js.map +1 -1
  25. package/dist/reporters/consoleReporter.d.ts +5 -11
  26. package/dist/reporters/consoleReporter.js +74 -76
  27. package/dist/reporters/consoleReporter.js.map +1 -1
  28. package/dist/reporters/consoleReporter.test.js +22 -27
  29. package/dist/reporters/consoleReporter.test.js.map +1 -1
  30. package/dist/reporters/enhancedReporter.d.ts +51 -7
  31. package/dist/reporters/enhancedReporter.js +128 -74
  32. package/dist/reporters/enhancedReporter.js.map +1 -1
  33. package/dist/reporters/enhancedReporter.test.js +110 -122
  34. package/dist/reporters/enhancedReporter.test.js.map +1 -1
  35. package/dist/reporters/jsonReporter.d.ts +6 -6
  36. package/dist/reporters/jsonReporter.js +24 -14
  37. package/dist/reporters/jsonReporter.js.map +1 -1
  38. package/dist/reporters/jsonReporter.test.js +26 -11
  39. package/dist/reporters/jsonReporter.test.js.map +1 -1
  40. package/dist/reporters/markdownIssueCells.d.ts +7 -0
  41. package/dist/reporters/markdownIssueCells.js +9 -0
  42. package/dist/reporters/markdownIssueCells.js.map +1 -0
  43. package/dist/reporters/markdownReporter.d.ts +2 -7
  44. package/dist/reporters/markdownReporter.js +57 -56
  45. package/dist/reporters/markdownReporter.js.map +1 -1
  46. package/dist/reporters/markdownReporter.test.js +104 -76
  47. package/dist/reporters/markdownReporter.test.js.map +1 -1
  48. package/dist/reporters/publicReporterApi.test.d.ts +1 -0
  49. package/dist/reporters/publicReporterApi.test.js +28 -0
  50. package/dist/reporters/publicReporterApi.test.js.map +1 -0
  51. package/dist/reporters/reportContext.d.ts +12 -0
  52. package/dist/reporters/reportContext.js +8 -0
  53. package/dist/reporters/reportContext.js.map +1 -0
  54. package/dist/reporters/reportContext.test.d.ts +1 -0
  55. package/dist/reporters/reportContext.test.js +30 -0
  56. package/dist/reporters/reportContext.test.js.map +1 -0
  57. package/dist/reporters/reporters.characterization.test.d.ts +1 -0
  58. package/dist/reporters/reporters.characterization.test.js +208 -0
  59. package/dist/reporters/reporters.characterization.test.js.map +1 -0
  60. package/dist/runner.js +67 -63
  61. package/dist/runner.js.map +1 -1
  62. package/dist/runner.test.js +444 -42
  63. package/dist/runner.test.js.map +1 -1
  64. package/dist/semantic/vectorSearch.js +2 -1
  65. package/dist/semantic/vectorSearch.js.map +1 -1
  66. package/dist/semantic/vectorSearch.test.js +2 -2
  67. package/dist/semantic/vectorSearch.test.js.map +1 -1
  68. package/dist/source/sourceIndex.d.ts +39 -0
  69. package/dist/source/sourceIndex.js +444 -0
  70. package/dist/source/sourceIndex.js.map +1 -0
  71. package/dist/source/sourceIndex.largeGlob.test.d.ts +1 -0
  72. package/dist/source/sourceIndex.largeGlob.test.js +29 -0
  73. package/dist/source/sourceIndex.largeGlob.test.js.map +1 -0
  74. package/dist/source/sourceIndex.test.d.ts +1 -0
  75. package/dist/source/sourceIndex.test.js +263 -0
  76. package/dist/source/sourceIndex.test.js.map +1 -0
  77. package/dist/source/sourceValidators.d.ts +7 -0
  78. package/dist/source/sourceValidators.js +8 -0
  79. package/dist/source/sourceValidators.js.map +1 -0
  80. package/dist/source/sourceValidators.test.d.ts +1 -0
  81. package/dist/source/sourceValidators.test.js +17 -0
  82. package/dist/source/sourceValidators.test.js.map +1 -0
  83. package/dist/types.d.ts +34 -2
  84. package/dist/validators/codePatternValidator.d.ts +5 -11
  85. package/dist/validators/codePatternValidator.js +17 -145
  86. package/dist/validators/codePatternValidator.js.map +1 -1
  87. package/dist/validators/codeSnippetValidator.d.ts +5 -18
  88. package/dist/validators/codeSnippetValidator.js +19 -312
  89. package/dist/validators/codeSnippetValidator.js.map +1 -1
  90. package/dist/validators/dependencyValidator.d.ts +0 -5
  91. package/dist/validators/dependencyValidator.js +7 -64
  92. package/dist/validators/dependencyValidator.js.map +1 -1
  93. package/dist/validators/versionValidator.d.ts +1 -10
  94. package/dist/validators/versionValidator.js +7 -157
  95. package/dist/validators/versionValidator.js.map +1 -1
  96. package/dist/validators/versionValidator.test.js +1 -101
  97. package/dist/validators/versionValidator.test.js.map +1 -1
  98. package/package.json +4 -4
@@ -1,21 +1,31 @@
1
- /**
2
- * JSON reporter for machine-readable output
3
- */
1
+ import { createReportContext, createTimestampedReportContext } from './reportContext.js';
2
+ function normalizeResults(results) {
3
+ return { ...results, summary: { ...results.summary, info: results.summary.info ?? 0 } };
4
+ }
5
+ export function createScoredJsonReportContext(results, freshnessScores) {
6
+ return createTimestampedReportContext(normalizeResults(results), freshnessScores);
7
+ }
8
+ export function renderJsonReport(report) {
9
+ const results = {
10
+ ...report.results,
11
+ summary: { ...report.results.summary, info: report.results.summary.info ?? 0 },
12
+ };
13
+ if (report.freshnessScores === undefined) {
14
+ return JSON.stringify(results, null, 2);
15
+ }
16
+ return JSON.stringify({
17
+ ...results,
18
+ freshnessScores: report.freshnessScores || null,
19
+ generatedAt: report.generatedAt,
20
+ }, null, 2);
21
+ }
22
+ /** JSON reporter for machine-readable output. */
4
23
  export class JsonReporter {
5
24
  generate(results) {
6
- return JSON.stringify({ ...results, summary: { ...results.summary, info: results.summary.info ?? 0 } }, null, 2);
25
+ return renderJsonReport(createReportContext(results));
7
26
  }
8
- /**
9
- * Generate with freshness scores
10
- */
11
27
  generateWithScores(results, freshnessScores) {
12
- const output = {
13
- ...results,
14
- summary: { ...results.summary, info: results.summary.info ?? 0 },
15
- freshnessScores: freshnessScores || null,
16
- generatedAt: new Date().toISOString(),
17
- };
18
- return JSON.stringify(output, null, 2);
28
+ return renderJsonReport(createScoredJsonReportContext(results, freshnessScores));
19
29
  }
20
30
  }
21
31
  //# sourceMappingURL=jsonReporter.js.map
@@ -1 +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,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACnH,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,OAA0B,EAAE,eAAqC;QAClF,MAAM,MAAM,GAAG;YACb,GAAG,OAAO;YACV,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE;YAChE,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"}
1
+ {"version":3,"file":"jsonReporter.js","sourceRoot":"","sources":["../../src/reporters/jsonReporter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,8BAA8B,EAAE,MAAM,oBAAoB,CAAC;AAIzF,SAAS,gBAAgB,CAAC,OAA0B;IAClD,OAAO,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;AAC1F,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,OAA0B,EAAE,eAAqC;IAC7G,OAAO,8BAA8B,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,eAAe,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,MAAqB;IACpD,MAAM,OAAO,GAAG;QACd,GAAG,MAAM,CAAC,OAAO;QACjB,OAAO,EAAE,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,EAAE;KAC/E,CAAC;IACF,IAAI,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;QACzC,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CACnB;QACE,GAAG,OAAO;QACV,eAAe,EAAE,MAAM,CAAC,eAAe,IAAI,IAAI;QAC/C,WAAW,EAAE,MAAM,CAAC,WAAW;KAChC,EACD,IAAI,EACJ,CAAC,CACF,CAAC;AACJ,CAAC;AAED,iDAAiD;AACjD,MAAM,OAAO,YAAY;IACvB,QAAQ,CAAC,OAA0B;QACjC,OAAO,gBAAgB,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,kBAAkB,CAAC,OAA0B,EAAE,eAAqC;QAClF,OAAO,gBAAgB,CAAC,6BAA6B,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;IACnF,CAAC;CACF"}
@@ -24,22 +24,37 @@ describe('JsonReporter', () => {
24
24
  expect(parsed.summary.info).toBe(1);
25
25
  expect(parsed.documents[0].issues[0].severity).toBe('info');
26
26
  });
27
- it('generateWithScores() includes scores and timestamp', () => {
28
- const output = reporter.generateWithScores(results, null);
29
- const parsed = JSON.parse(output);
30
- expect(parsed.freshnessScores).toBeNull();
31
- expect(parsed.generatedAt).toBeDefined();
32
- });
33
- it('generateWithScores() includes scores object when provided', () => {
27
+ it('preserves scored result fields captured before reading the clock', () => {
28
+ const extendedResults = { ...results, extra: 'before' };
34
29
  const scores = {
35
- projectScore: 90,
30
+ projectScore: 100,
36
31
  projectGrade: 'A',
37
32
  documents: [],
38
33
  summary: { total: 0, gradeA: 0, gradeB: 0, gradeC: 0, gradeD: 0, gradeF: 0 },
39
34
  };
40
- const output = reporter.generateWithScores(results, scores);
41
- const parsed = JSON.parse(output);
42
- expect(parsed.freshnessScores.projectScore).toBe(90);
35
+ const clock = vi.spyOn(Date.prototype, 'toISOString').mockImplementation(() => {
36
+ extendedResults.extra = 'after';
37
+ return '2025-01-02T03:04:05.678Z';
38
+ });
39
+ const output = JSON.parse(new JsonReporter().generateWithScores(extendedResults, scores));
40
+ expect(output.extra).toBe('before');
41
+ expect(output.freshnessScores).toEqual(scores);
42
+ expect(output.generatedAt).toBe('2025-01-02T03:04:05.678Z');
43
+ clock.mockRestore();
44
+ });
45
+ it('does not read the clock when scored result spreading fails', () => {
46
+ const proxiedResults = new Proxy(results, {
47
+ get(_target, property) {
48
+ if (property === 'documents') {
49
+ throw new Error('result getter failed');
50
+ }
51
+ return Reflect.get(results, property);
52
+ },
53
+ });
54
+ const clock = vi.spyOn(Date.prototype, 'toISOString');
55
+ expect(() => new JsonReporter().generateWithScores(proxiedResults, null)).toThrow('result getter failed');
56
+ expect(clock).not.toHaveBeenCalled();
57
+ clock.mockRestore();
43
58
  });
44
59
  it.each([
45
60
  ['generate', (legacyResults) => reporter.generate(legacyResults)],
@@ -1 +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;YACT;gBACE,IAAI,EAAE,WAAW;gBACjB,MAAM,EAAE;oBACN;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE;wBACnH,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,MAAM;wBAChB,OAAO,EAAE,mBAAmB;qBAC7B;iBACF;aACF;SACF;QACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KAC7E,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;QACrC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9D,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;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,UAAU,EAAE,CAAC,aAAgC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACpF,CAAC,oBAAoB,EAAE,CAAC,aAAgC,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;KAC/G,CAAC,CAAC,oDAAoD,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC3E,MAAM,aAAa,GAAsB;YACvC,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK;gBAC5B,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK;gBAC5B,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;gBAC9B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ;gBAClC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO;aACjC;SACF,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;QAEvC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"jsonReporter.test.js","sourceRoot":"","sources":["../../src/reporters/jsonReporter.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,QAAQ,GAAG,IAAI,YAAY,EAAE,CAAC;IACpC,MAAM,OAAO,GAAsB;QACjC,SAAS,EAAE;YACT;gBACE,IAAI,EAAE,WAAW;gBACjB,MAAM,EAAE;oBACN;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE;wBACnH,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,MAAM;wBAChB,OAAO,EAAE,mBAAmB;qBAC7B;iBACF;aACF;SACF;QACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KAC7E,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;QACrC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QAC1E,MAAM,eAAe,GAAG,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;QACxD,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,GAAG;YACjB,YAAY,EAAE,GAAG;YACjB,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,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;YAC5E,eAAe,CAAC,KAAK,GAAG,OAAO,CAAC;YAChC,OAAO,0BAA0B,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,YAAY,EAAE,CAAC,kBAAkB,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC,CAAC;QAE1F,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC/C,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC5D,KAAK,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,cAAc,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE;YACxC,GAAG,CAAC,OAAO,EAAE,QAAQ;gBACnB,IAAI,QAAQ,KAAK,WAAW,EAAE,CAAC;oBAC7B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;gBAC1C,CAAC;gBACD,OAAO,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;SACF,CAAC,CAAC;QACH,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAEtD,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,YAAY,EAAE,CAAC,kBAAkB,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAC1G,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACrC,KAAK,CAAC,WAAW,EAAE,CAAC;IACtB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,UAAU,EAAE,CAAC,aAAgC,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QACpF,CAAC,oBAAoB,EAAE,CAAC,aAAgC,EAAE,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;KAC/G,CAAC,CAAC,oDAAoD,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE;QAC3E,MAAM,aAAa,GAAsB;YACvC,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK;gBAC5B,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK;gBAC5B,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;gBAC9B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ;gBAClC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO;aACjC;SACF,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;QAEvC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1,7 @@
1
+ import type { ValidationResult } from '../types.js';
2
+ export declare function normalizeMarkdownIssueCells(issue: Pick<ValidationResult, 'message' | 'severity' | 'suggestion'>): {
3
+ readonly isError: boolean;
4
+ readonly isInfo: boolean;
5
+ readonly message: string;
6
+ readonly suggestion: string;
7
+ };
@@ -0,0 +1,9 @@
1
+ import { escapeMarkdownTableCell } from '../utils/escapeMarkdownTableCell.js';
2
+ export function normalizeMarkdownIssueCells(issue) {
3
+ const isError = issue.severity === 'error';
4
+ const isInfo = issue.severity === 'info';
5
+ const suggestion = escapeMarkdownTableCell(issue.suggestion || '-');
6
+ const message = escapeMarkdownTableCell(issue.message || '');
7
+ return { isError, isInfo, message, suggestion };
8
+ }
9
+ //# sourceMappingURL=markdownIssueCells.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"markdownIssueCells.js","sourceRoot":"","sources":["../../src/reporters/markdownIssueCells.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAE9E,MAAM,UAAU,2BAA2B,CAAC,KAAoE;IAM9G,MAAM,OAAO,GAAG,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC;IAC3C,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,KAAK,MAAM,CAAC;IACzC,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC;IACpE,MAAM,OAAO,GAAG,uBAAuB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;AAClD,CAAC"}
@@ -1,12 +1,7 @@
1
1
  import type { ProjectScores, ValidationResults } from '../types.js';
2
- /**
3
- * Markdown reporter for documentation-friendly output
4
- */
2
+ export declare function generateMarkdownReport(results: ValidationResults, freshnessScores?: ProjectScores | null | undefined): string;
3
+ /** Markdown reporter for documentation-friendly output. */
5
4
  export declare class MarkdownReporter {
6
5
  generate(results: ValidationResults): string;
7
- private generateValidationResults;
8
- /**
9
- * Generate with freshness scores
10
- */
11
6
  generateWithScores(results: ValidationResults, freshnessScores: ProjectScores | null): string;
12
7
  }
@@ -1,64 +1,65 @@
1
- import { escapeMarkdownTableCell } from '../utils/escapeMarkdownTableCell.js';
2
1
  import { formatVectorMismatches } from './formatVectorMismatches.js';
3
- /**
4
- * Markdown reporter for documentation-friendly output
5
- */
6
- export class MarkdownReporter {
7
- generate(results) {
8
- return this.generateValidationResults(results) + formatVectorMismatches(results.vectorMismatches);
2
+ import { normalizeMarkdownIssueCells } from './markdownIssueCells.js';
3
+ import { createTimestampedReportContext } from './reportContext.js';
4
+ function renderMarkdownBase(report) {
5
+ const { summary, documents, vectorMismatches } = report.results;
6
+ let markdown = '';
7
+ markdown += '# Documentation Freshness Report\n\n';
8
+ markdown += `Generated: ${report.generatedAt}\n\n`;
9
+ markdown += '## Summary\n\n';
10
+ markdown += '| Metric | Count |\n';
11
+ markdown += '|--------|-------|\n';
12
+ markdown += `| Total Checked | ${summary.total} |\n`;
13
+ markdown += `| ✅ Valid | ${summary.valid} |\n`;
14
+ markdown += `| ❌ Errors | ${summary.errors} |\n`;
15
+ markdown += `| ⚠️ Warnings | ${summary.warnings} |\n`;
16
+ markdown += `| ℹ️ Info | ${summary.info ?? 0} |\n`;
17
+ markdown += `| ⏭️ Skipped | ${summary.skipped} |\n\n`;
18
+ if (documents.length === 0) {
19
+ return vectorMismatches?.length ? markdown : `${markdown}✨ **All documentation is up to date!**\n`;
9
20
  }
10
- generateValidationResults(results) {
11
- const { summary, documents } = results;
12
- let md = '';
13
- md += '# Documentation Freshness Report\n\n';
14
- md += `Generated: ${new Date().toISOString()}\n\n`;
15
- md += '## Summary\n\n';
16
- md += '| Metric | Count |\n';
17
- md += '|--------|-------|\n';
18
- md += `| Total Checked | ${summary.total} |\n`;
19
- md += `| ✅ Valid | ${summary.valid} |\n`;
20
- md += `| ❌ Errors | ${summary.errors} |\n`;
21
- md += `| ⚠️ Warnings | ${summary.warnings} |\n`;
22
- md += `| ℹ️ Info | ${summary.info ?? 0} |\n`;
23
- md += `| ⏭️ Skipped | ${summary.skipped} |\n\n`;
24
- if (documents.length === 0) {
25
- if (!results.vectorMismatches?.length) {
26
- md += '✨ **All documentation is up to date!**\n';
27
- }
21
+ markdown += '## Issues\n\n';
22
+ for (const document of documents) {
23
+ markdown += `### 📄 \`${document.path}\`\n\n`;
24
+ markdown += '| Line | Severity | Issue | Suggestion |\n';
25
+ markdown += '|------|----------|-------|------------|\n';
26
+ for (const issue of document.issues) {
27
+ const { isError, isInfo, suggestion, message } = normalizeMarkdownIssueCells(issue);
28
+ const severity = isError ? '❌ Error' : isInfo ? 'ℹ️ Info' : '⚠️ Warning';
29
+ markdown += `| ${issue.reference.lineNumber} | ${severity} | ${message} | ${suggestion} |\n`;
28
30
  }
29
- else {
30
- md += '## Issues\n\n';
31
- for (const doc of documents) {
32
- md += `### 📄 \`${doc.path}\`\n\n`;
33
- md += '| Line | Severity | Issue | Suggestion |\n';
34
- md += '|------|----------|-------|------------|\n';
35
- for (const issue of doc.issues) {
36
- const severity = issue.severity === 'error' ? '❌ Error' : issue.severity === 'info' ? 'ℹ️ Info' : '⚠️ Warning';
37
- const suggestion = escapeMarkdownTableCell(issue.suggestion || '-');
38
- const message = escapeMarkdownTableCell(issue.message || '');
39
- md += `| ${issue.reference.lineNumber} | ${severity} | ${message} | ${suggestion} |\n`;
40
- }
41
- md += '\n';
42
- }
43
- }
44
- return md;
31
+ markdown += '\n';
32
+ }
33
+ return markdown;
34
+ }
35
+ function renderMarkdownScores(freshnessScores) {
36
+ let markdown = '## Freshness Scores\n\n';
37
+ markdown += `**Project Score:** ${freshnessScores.projectScore}/100 (Grade: ${freshnessScores.projectGrade})\n\n`;
38
+ markdown += '| Document | Score | Grade |\n';
39
+ markdown += '|----------|-------|-------|\n';
40
+ for (const document of freshnessScores.documents) {
41
+ markdown += `| \`${document.document}\` | ${document.totalScore}/100 | ${document.grade} |\n`;
42
+ }
43
+ return `${markdown}\n`;
44
+ }
45
+ function renderMarkdownReport(report) {
46
+ let markdown = renderMarkdownBase(report);
47
+ if (report.freshnessScores) {
48
+ markdown += renderMarkdownScores(report.freshnessScores);
49
+ }
50
+ const mismatches = report.results.vectorMismatches;
51
+ return markdown + formatVectorMismatches(mismatches ? [...mismatches] : undefined);
52
+ }
53
+ export function generateMarkdownReport(results, freshnessScores = undefined) {
54
+ return renderMarkdownReport(createTimestampedReportContext(results, freshnessScores));
55
+ }
56
+ /** Markdown reporter for documentation-friendly output. */
57
+ export class MarkdownReporter {
58
+ generate(results) {
59
+ return generateMarkdownReport(results);
45
60
  }
46
- /**
47
- * Generate with freshness scores
48
- */
49
61
  generateWithScores(results, freshnessScores) {
50
- let md = this.generateValidationResults(results);
51
- if (freshnessScores) {
52
- md += '## Freshness Scores\n\n';
53
- md += `**Project Score:** ${freshnessScores.projectScore}/100 (Grade: ${freshnessScores.projectGrade})\n\n`;
54
- md += '| Document | Score | Grade |\n';
55
- md += '|----------|-------|-------|\n';
56
- for (const doc of freshnessScores.documents) {
57
- md += `| \`${doc.document}\` | ${doc.totalScore}/100 | ${doc.grade} |\n`;
58
- }
59
- md += '\n';
60
- }
61
- return md + formatVectorMismatches(results.vectorMismatches);
62
+ return generateMarkdownReport(results, freshnessScores);
62
63
  }
63
64
  }
64
65
  //# sourceMappingURL=markdownReporter.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"markdownReporter.js","sourceRoot":"","sources":["../../src/reporters/markdownReporter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC3B,QAAQ,CAAC,OAA0B;QACjC,OAAO,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,GAAG,sBAAsB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACpG,CAAC;IAEO,yBAAyB,CAAC,OAA0B;QAC1D,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,eAAe,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC;QAC7C,EAAE,IAAI,kBAAkB,OAAO,CAAC,OAAO,QAAQ,CAAC;QAEhD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,MAAM,EAAE,CAAC;gBACtC,EAAE,IAAI,0CAA0C,CAAC;YACnD,CAAC;QACH,CAAC;aACI,CAAC;YACJ,EAAE,IAAI,eAAe,CAAC;YAEtB,KAAK,MAAM,GAAG,IAAI,SAAS,EAAE,CAAC;gBAC5B,EAAE,IAAI,YAAY,GAAG,CAAC,IAAI,QAAQ,CAAC;gBACnC,EAAE,IAAI,4CAA4C,CAAC;gBACnD,EAAE,IAAI,4CAA4C,CAAC;gBAEnD,KAAK,MAAM,KAAK,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;oBAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC;oBAC/G,MAAM,UAAU,GAAG,uBAAuB,CAAC,KAAK,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC;oBACpE,MAAM,OAAO,GAAG,uBAAuB,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;oBAC7D,EAAE,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,UAAU,MAAM,QAAQ,MAAM,OAAO,MAAM,UAAU,MAAM,CAAC;gBACzF,CAAC;gBAED,EAAE,IAAI,IAAI,CAAC;YACb,CAAC;QACH,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;IAED;;OAEG;IACH,kBAAkB,CAAC,OAA0B,EAAE,eAAqC;QAClF,IAAI,EAAE,GAAG,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAEjD,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,GAAG,sBAAsB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC/D,CAAC;CACF"}
1
+ {"version":3,"file":"markdownReporter.js","sourceRoot":"","sources":["../../src/reporters/markdownReporter.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,8BAA8B,EAAE,MAAM,oBAAoB,CAAC;AAIpE,SAAS,kBAAkB,CAAC,MAA6B;IACvD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,GAAG,MAAM,CAAC,OAAO,CAAC;IAChE,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,QAAQ,IAAI,sCAAsC,CAAC;IACnD,QAAQ,IAAI,cAAc,MAAM,CAAC,WAAW,MAAM,CAAC;IACnD,QAAQ,IAAI,gBAAgB,CAAC;IAC7B,QAAQ,IAAI,sBAAsB,CAAC;IACnC,QAAQ,IAAI,sBAAsB,CAAC;IACnC,QAAQ,IAAI,qBAAqB,OAAO,CAAC,KAAK,MAAM,CAAC;IACrD,QAAQ,IAAI,eAAe,OAAO,CAAC,KAAK,MAAM,CAAC;IAC/C,QAAQ,IAAI,gBAAgB,OAAO,CAAC,MAAM,MAAM,CAAC;IACjD,QAAQ,IAAI,mBAAmB,OAAO,CAAC,QAAQ,MAAM,CAAC;IACtD,QAAQ,IAAI,eAAe,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC;IACnD,QAAQ,IAAI,kBAAkB,OAAO,CAAC,OAAO,QAAQ,CAAC;IAEtD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,OAAO,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,QAAQ,0CAA0C,CAAC;IACrG,CAAC;IAED,QAAQ,IAAI,eAAe,CAAC;IAC5B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,QAAQ,IAAI,YAAY,QAAQ,CAAC,IAAI,QAAQ,CAAC;QAC9C,QAAQ,IAAI,4CAA4C,CAAC;QACzD,QAAQ,IAAI,4CAA4C,CAAC;QACzD,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;YACpC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,2BAA2B,CAAC,KAAK,CAAC,CAAC;YACpF,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC;YACzE,QAAQ,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,UAAU,MAAM,QAAQ,MAAM,OAAO,MAAM,UAAU,MAAM,CAAC;QAC/F,CAAC;QACD,QAAQ,IAAI,IAAI,CAAC;IACnB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,oBAAoB,CAAC,eAAsE;IAClG,IAAI,QAAQ,GAAG,yBAAyB,CAAC;IACzC,QAAQ,IAAI,sBAAsB,eAAe,CAAC,YAAY,gBAAgB,eAAe,CAAC,YAAY,OAAO,CAAC;IAClH,QAAQ,IAAI,gCAAgC,CAAC;IAC7C,QAAQ,IAAI,gCAAgC,CAAC;IAC7C,KAAK,MAAM,QAAQ,IAAI,eAAe,CAAC,SAAS,EAAE,CAAC;QACjD,QAAQ,IAAI,OAAO,QAAQ,CAAC,QAAQ,QAAQ,QAAQ,CAAC,UAAU,UAAU,QAAQ,CAAC,KAAK,MAAM,CAAC;IAChG,CAAC;IACD,OAAO,GAAG,QAAQ,IAAI,CAAC;AACzB,CAAC;AAED,SAAS,oBAAoB,CAAC,MAA6B;IACzD,IAAI,QAAQ,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,QAAQ,IAAI,oBAAoB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC3D,CAAC;IACD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC;IACnD,OAAO,QAAQ,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AACrF,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,OAA0B,EAAE,kBAAoD,SAAS;IAC9H,OAAO,oBAAoB,CAAC,8BAA8B,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,2DAA2D;AAC3D,MAAM,OAAO,gBAAgB;IAC3B,QAAQ,CAAC,OAA0B;QACjC,OAAO,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,kBAAkB,CAAC,OAA0B,EAAE,eAAqC;QAClF,OAAO,sBAAsB,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;IAC1D,CAAC;CACF"}
@@ -35,24 +35,24 @@ describe('MarkdownReporter', () => {
35
35
  summary: { total: 3, valid: 0, errors: 1, warnings: 1, info: 1, skipped: 0 },
36
36
  };
37
37
  it('generates markdown with summary table', () => {
38
- const md = reporter.generate(cleanResults);
39
- expect(md).toContain('# Documentation Freshness Report');
40
- expect(md).toContain('Total Checked | 2');
41
- expect(md).toContain('Info | 0');
42
- expect(md).toContain('up to date');
38
+ const markdown = reporter.generate(cleanResults);
39
+ expect(markdown).toContain('# Documentation Freshness Report');
40
+ expect(markdown).toContain('Total Checked | 2');
41
+ expect(markdown).toContain('Info | 0');
42
+ expect(markdown).toContain('up to date');
43
43
  });
44
44
  it('generates issues table with error, warning, and info severities', () => {
45
- const md = reporter.generate(resultsWithIssues);
46
- expect(md).toContain('## Issues');
47
- expect(md).toContain('docs/api.md');
48
- expect(md).toContain('❌ Error');
49
- expect(md).toContain('⚠️ Warning');
50
- expect(md).toContain('| 30 | ℹ️ Info |');
51
- expect(md).toContain('File not found');
52
- expect(md).toContain('missing.tsx');
53
- expect(md).toContain('URL returned 404');
45
+ const markdown = reporter.generate(resultsWithIssues);
46
+ expect(markdown).toContain('## Issues');
47
+ expect(markdown).toContain('docs/api.md');
48
+ expect(markdown).toContain('❌ Error');
49
+ expect(markdown).toContain('⚠️ Warning');
50
+ expect(markdown).toContain('| 30 | ℹ️ Info |');
51
+ expect(markdown).toContain('File not found');
52
+ expect(markdown).toContain('missing.tsx');
53
+ expect(markdown).toContain('URL returned 404');
54
54
  });
55
- it('escapes pipe characters in messages', () => {
55
+ it('escapes pipe characters and uses "-" for missing suggestions', () => {
56
56
  const results = {
57
57
  documents: [
58
58
  {
@@ -69,29 +69,9 @@ describe('MarkdownReporter', () => {
69
69
  ],
70
70
  summary: { total: 1, valid: 0, errors: 1, warnings: 0, skipped: 0 },
71
71
  };
72
- expect(reporter.generate(results)).toContain('Path with \\| pipe');
72
+ expect(reporter.generate(results)).toMatch(/Path with \\| pipe \| -/);
73
73
  });
74
- it('uses "-" for missing suggestions', () => {
75
- const results = {
76
- documents: [
77
- {
78
- path: 'doc.md',
79
- issues: [
80
- {
81
- reference: { type: 'file-path', value: 'x', lineNumber: 1, raw: 'x', sourceFile: 'doc.md' },
82
- valid: false,
83
- severity: 'error',
84
- message: 'Not found',
85
- },
86
- ],
87
- },
88
- ],
89
- summary: { total: 1, valid: 0, errors: 1, warnings: 0, skipped: 0 },
90
- };
91
- const md = reporter.generate(results);
92
- expect(md).toMatch(/Not found \| -/);
93
- });
94
- it('includes vector mismatches without a contradictory success message', () => {
74
+ it('includes vector mismatches once after scores without a success message', () => {
95
75
  const results = {
96
76
  ...cleanResults,
97
77
  vectorMismatches: [
@@ -105,21 +85,20 @@ describe('MarkdownReporter', () => {
105
85
  },
106
86
  ],
107
87
  };
108
- const md = reporter.generate(results);
109
- expect(md).toContain('Semantic Analysis');
110
- expect(md).toContain('src/vector.ts (search)');
111
- expect(md).not.toContain('up to date');
112
- expect(md.match(/docs\/vector-api\.md/g)).toHaveLength(1);
113
88
  const scores = {
114
89
  projectScore: 100,
115
90
  projectGrade: 'A',
116
91
  documents: [],
117
92
  summary: { total: 0, gradeA: 0, gradeB: 0, gradeC: 0, gradeD: 0, gradeF: 0 },
118
93
  };
119
- const scoredMd = reporter.generateWithScores(results, scores);
120
- expect(scoredMd.indexOf('Freshness Scores')).toBeLessThan(scoredMd.indexOf('Semantic Analysis'));
94
+ const markdown = reporter.generate(results);
95
+ expect(markdown).not.toContain('up to date');
96
+ expect(markdown.match(/docs\/vector-api\.md/g)).toHaveLength(1);
97
+ const scored = reporter.generateWithScores(results, scores);
98
+ expect(scored.indexOf('Freshness Scores')).toBeLessThan(scored.indexOf('Semantic Analysis'));
99
+ expect(scored.match(/docs\/vector-api\.md/g)).toHaveLength(1);
121
100
  });
122
- it('generateWithScores includes freshness section', () => {
101
+ it('generates populated and null freshness score modes', () => {
123
102
  const scores = {
124
103
  projectScore: 92,
125
104
  projectGrade: 'A',
@@ -133,40 +112,89 @@ describe('MarkdownReporter', () => {
133
112
  ],
134
113
  summary: { total: 1, gradeA: 1, gradeB: 0, gradeC: 0, gradeD: 0, gradeF: 0 },
135
114
  };
136
- const md = reporter.generateWithScores(cleanResults, scores);
137
- expect(md).toContain('## Freshness Scores');
138
- expect(md).toContain('92/100');
139
- expect(md).toContain('Grade: A');
115
+ const markdown = reporter.generateWithScores(cleanResults, scores);
116
+ expect(markdown).toContain('92/100');
117
+ expect(markdown).toContain('Grade: A');
118
+ expect(reporter.generateWithScores(cleanResults, null)).not.toContain('Freshness Scores');
140
119
  });
141
- it('generateWithScores with null scores omits section', () => {
142
- const md = reporter.generateWithScores(cleanResults, null);
143
- expect(md).not.toContain('Freshness Scores');
120
+ it('captures summary then documents before the clock and retains those references', () => {
121
+ const events = [];
122
+ const summary = { total: 1, valid: 0, errors: 1, warnings: 0, skipped: 0 };
123
+ const documents = [];
124
+ let currentSummary = summary;
125
+ let currentDocuments = documents;
126
+ const results = {
127
+ get summary() {
128
+ events.push('summary');
129
+ return currentSummary;
130
+ },
131
+ set summary(value) {
132
+ currentSummary = value;
133
+ },
134
+ get documents() {
135
+ events.push('documents');
136
+ return currentDocuments;
137
+ },
138
+ set documents(value) {
139
+ currentDocuments = value;
140
+ },
141
+ };
142
+ const clock = vi.spyOn(Date.prototype, 'toISOString').mockImplementation(() => {
143
+ events.push('clock');
144
+ summary.total = 7;
145
+ documents.push({
146
+ path: 'docs/captured.md',
147
+ issues: [
148
+ {
149
+ reference: { type: 'file-path', value: 'x', lineNumber: 1, raw: 'x', sourceFile: 'captured.md' },
150
+ valid: false,
151
+ severity: 'error',
152
+ message: 'captured issue',
153
+ },
154
+ ],
155
+ });
156
+ results.summary = { total: 99, valid: 99, errors: 0, warnings: 0, skipped: 0 };
157
+ results.documents = [];
158
+ return '2025-01-02T03:04:05.678Z';
159
+ });
160
+ try {
161
+ const report = reporter.generate(results);
162
+ expect(events).toEqual(['summary', 'documents', 'clock']);
163
+ expect(report).toContain('| Total Checked | 7 |');
164
+ expect(report).toContain('docs/captured.md');
165
+ expect(report).not.toContain('| Total Checked | 99 |');
166
+ }
167
+ finally {
168
+ clock.mockRestore();
169
+ }
144
170
  });
145
- it('generates per-document score table', () => {
146
- const scores = {
147
- projectScore: 85,
148
- projectGrade: 'B',
149
- documents: [
150
- {
151
- document: 'a.md',
152
- totalScore: 90,
153
- factors: { referenceValidity: 100, gitTimeDelta: 80, codeChangeFrequency: 80, symbolCoverage: 90 },
154
- grade: 'A',
155
- },
156
- {
157
- document: 'b.md',
158
- totalScore: 70,
159
- factors: { referenceValidity: 70, gitTimeDelta: 70, codeChangeFrequency: 70, symbolCoverage: 70 },
160
- grade: 'C',
161
- },
162
- ],
163
- summary: { total: 2, gradeA: 1, gradeB: 0, gradeC: 1, gradeD: 0, gradeF: 0 },
171
+ it.each([
172
+ { failure: 'summary', expected: ['summary'] },
173
+ { failure: 'documents', expected: ['summary', 'documents'] },
174
+ ])('does not read the clock after a throwing $failure getter', ({ failure, expected }) => {
175
+ const events = [];
176
+ const results = {
177
+ get summary() {
178
+ events.push('summary');
179
+ if (failure === 'summary') {
180
+ throw new Error('summary failed');
181
+ }
182
+ return { total: 0, valid: 0, errors: 0, warnings: 0, skipped: 0 };
183
+ },
184
+ get documents() {
185
+ events.push('documents');
186
+ throw new Error('documents failed');
187
+ },
164
188
  };
165
- const md = reporter.generateWithScores(cleanResults, scores);
166
- expect(md).toContain('a.md');
167
- expect(md).toContain('90/100');
168
- expect(md).toContain('b.md');
169
- expect(md).toContain('70/100');
189
+ const clock = vi.spyOn(Date.prototype, 'toISOString');
190
+ try {
191
+ expect(() => reporter.generate(results)).toThrow(`${failure} failed`);
192
+ expect(events).toEqual(expected);
193
+ expect(clock).not.toHaveBeenCalled();
194
+ }
195
+ finally {
196
+ clock.mockRestore();
197
+ }
170
198
  });
171
199
  });
172
200
  //# sourceMappingURL=markdownReporter.test.js.map
@@ -1 +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;oBACD;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE;wBACjH,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,MAAM;wBAChB,OAAO,EAAE,mBAAmB;qBAC7B;iBACF;aACF;SACF;QACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KAC7E,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,UAAU,CAAC,CAAC;QACjC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,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,kBAAkB,CAAC,CAAC;QACzC,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,oEAAoE,EAAE,GAAG,EAAE;QAC5E,MAAM,OAAO,GAAsB;YACjC,GAAG,YAAY;YACf,gBAAgB,EAAE;gBAChB;oBACE,OAAO,EAAE,oBAAoB;oBAC7B,UAAU,EAAE,YAAY;oBACxB,OAAO,EAAE,0BAA0B;oBACnC,cAAc,EAAE,GAAG;oBACnB,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,uBAAuB,EAAE;oBACnG,UAAU,EAAE,8BAA8B;iBAC3C;aACF;SACF,CAAC;QAEF,MAAM,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAC1C,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;QAC/C,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACvC,MAAM,CAAC,EAAE,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAE1D,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,GAAG;YACjB,YAAY,EAAE,GAAG;YACjB,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,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC9D,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACnG,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"}
1
+ {"version":3,"file":"markdownReporter.test.js","sourceRoot":"","sources":["../../src/reporters/markdownReporter.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;IACxC,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;IACF,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;oBACD;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE;wBACjH,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,MAAM;wBAChB,OAAO,EAAE,mBAAmB;qBAC7B;iBACF;aACF;SACF;QACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;KAC7E,CAAC;IAEF,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QACjD,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;QAC/D,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAChD,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;QACtD,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACxC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACtC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACzC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAC/C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QAC7C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QAC1C,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,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,OAAO,CAAC,yBAAyB,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;QAChF,MAAM,OAAO,GAAsB;YACjC,GAAG,YAAY;YACf,gBAAgB,EAAE;gBAChB;oBACE,OAAO,EAAE,oBAAoB;oBAC7B,UAAU,EAAE,YAAY;oBACxB,OAAO,EAAE,0BAA0B;oBACnC,cAAc,EAAE,GAAG;oBACnB,SAAS,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,uBAAuB,EAAE;oBACnG,UAAU,EAAE,8BAA8B;iBAC3C;aACF;SACF,CAAC;QACF,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,GAAG;YACjB,YAAY,EAAE,GAAG;YACjB,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;QAEF,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC5C,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QAC7C,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC5D,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC;QAC7F,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,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,QAAQ,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACnE,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACrC,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACvC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+EAA+E,EAAE,GAAG,EAAE;QACvF,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAC3E,MAAM,SAAS,GAAmC,EAAE,CAAC;QACrD,IAAI,cAAc,GAAG,OAAO,CAAC;QAC7B,IAAI,gBAAgB,GAAG,SAAS,CAAC;QACjC,MAAM,OAAO,GAAsB;YACjC,IAAI,OAAO;gBACT,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACvB,OAAO,cAAc,CAAC;YACxB,CAAC;YACD,IAAI,OAAO,CAAC,KAAK;gBACf,cAAc,GAAG,KAAK,CAAC;YACzB,CAAC;YACD,IAAI,SAAS;gBACX,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACzB,OAAO,gBAAgB,CAAC;YAC1B,CAAC;YACD,IAAI,SAAS,CAAC,KAAK;gBACjB,gBAAgB,GAAG,KAAK,CAAC;YAC3B,CAAC;SACF,CAAC;QACF,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC,kBAAkB,CAAC,GAAG,EAAE;YAC5E,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACrB,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC;YAClB,SAAS,CAAC,IAAI,CAAC;gBACb,IAAI,EAAE,kBAAkB;gBACxB,MAAM,EAAE;oBACN;wBACE,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,aAAa,EAAE;wBAChG,KAAK,EAAE,KAAK;wBACZ,QAAQ,EAAE,OAAO;wBACjB,OAAO,EAAE,gBAAgB;qBAC1B;iBACF;aACF,CAAC,CAAC;YACH,OAAO,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YAC/E,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC;YACvB,OAAO,0BAA0B,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAC;YAC1D,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC;YAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,wBAAwB,CAAC,CAAC;QACzD,CAAC;gBACO,CAAC;YACP,KAAK,CAAC,WAAW,EAAE,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,SAAS,CAAC,EAAE;QAC7C,EAAE,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE;KACpD,CAAC,CAAC,0DAA0D,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE;QAChG,MAAM,MAAM,GAAa,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAsB;YACjC,IAAI,OAAO;gBACT,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACvB,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;gBACpC,CAAC;gBACD,OAAO,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;YACpE,CAAC;YACD,IAAI,SAAS;gBACX,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBACzB,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACtC,CAAC;SACF,CAAC;QACF,MAAM,KAAK,GAAG,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;QAEtD,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,OAAO,SAAS,CAAC,CAAC;YACtE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACjC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACvC,CAAC;gBACO,CAAC;YACP,KAAK,CAAC,WAAW,EAAE,CAAC;QACtB,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,28 @@
1
+ import * as publicApi from '../index.js';
2
+ describe('public reporter interface', () => {
3
+ it('keeps the four root exports and their method signatures without exposing internals', () => {
4
+ expectTypeOf(publicApi.ConsoleReporter).toBeConstructibleWith();
5
+ expectTypeOf(publicApi.JsonReporter).toBeConstructibleWith();
6
+ expectTypeOf(publicApi.MarkdownReporter).toBeConstructibleWith();
7
+ expectTypeOf(publicApi.EnhancedReporter).toBeConstructibleWith();
8
+ expectTypeOf(publicApi.ConsoleReporter.prototype.generate).parameters.toEqualTypeOf();
9
+ expectTypeOf(publicApi.ConsoleReporter.prototype.generate).returns.toBeVoid();
10
+ expectTypeOf(publicApi.ConsoleReporter.prototype.generateWithScores).parameters.toEqualTypeOf();
11
+ expectTypeOf(publicApi.ConsoleReporter.prototype.generateWithScores).returns.toBeVoid();
12
+ expectTypeOf(publicApi.JsonReporter.prototype.generate).parameters.toEqualTypeOf();
13
+ expectTypeOf(publicApi.JsonReporter.prototype.generate).returns.toBeString();
14
+ expectTypeOf(publicApi.JsonReporter.prototype.generateWithScores).parameters.toEqualTypeOf();
15
+ expectTypeOf(publicApi.JsonReporter.prototype.generateWithScores).returns.toBeString();
16
+ expectTypeOf(publicApi.MarkdownReporter.prototype.generate).parameters.toEqualTypeOf();
17
+ expectTypeOf(publicApi.MarkdownReporter.prototype.generate).returns.toBeString();
18
+ expectTypeOf(publicApi.MarkdownReporter.prototype.generateWithScores).parameters.toEqualTypeOf();
19
+ expectTypeOf(publicApi.MarkdownReporter.prototype.generateWithScores).returns.toBeString();
20
+ expectTypeOf(publicApi.EnhancedReporter.prototype.generateScanReport).parameters.toEqualTypeOf();
21
+ expectTypeOf(publicApi.EnhancedReporter.prototype.generateScanReport).returns.toBeString();
22
+ expectTypeOf().toBeAny();
23
+ expect(publicApi).not.toHaveProperty('ReportContext');
24
+ expect(publicApi).not.toHaveProperty('renderConsoleReport');
25
+ expect(publicApi).not.toHaveProperty('createReportContext');
26
+ });
27
+ });
28
+ //# sourceMappingURL=publicReporterApi.test.js.map