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.
- package/README.md +19 -0
- package/dist/config/defaults.js +9 -3
- package/dist/config/defaults.js.map +1 -1
- package/dist/index.d.ts +6 -1
- package/dist/index.js +5 -0
- package/dist/index.js.map +1 -1
- package/dist/manifests/manifestInventory.d.ts +28 -0
- package/dist/manifests/manifestInventory.js +225 -0
- package/dist/manifests/manifestInventory.js.map +1 -0
- package/dist/manifests/manifestInventory.test.d.ts +1 -0
- package/dist/manifests/manifestInventory.test.js +176 -0
- package/dist/manifests/manifestInventory.test.js.map +1 -0
- package/dist/manifests/validatorConstructors.test.d.ts +1 -0
- package/dist/manifests/validatorConstructors.test.js +17 -0
- package/dist/manifests/validatorConstructors.test.js.map +1 -0
- package/dist/parsers/documentParser.d.ts +2 -3
- package/dist/parsers/documentParser.js.map +1 -1
- package/dist/parsers/extractorInterface.test.d.ts +1 -0
- package/dist/parsers/extractorInterface.test.js +34 -0
- package/dist/parsers/extractorInterface.test.js.map +1 -0
- package/dist/parsers/extractors/codeSnippetExtractor.js.map +1 -1
- package/dist/plugins/plugin.d.ts +5 -1
- package/dist/plugins/plugin.js +5 -1
- package/dist/plugins/plugin.js.map +1 -1
- package/dist/reporters/consoleReporter.d.ts +5 -11
- package/dist/reporters/consoleReporter.js +74 -76
- package/dist/reporters/consoleReporter.js.map +1 -1
- package/dist/reporters/consoleReporter.test.js +22 -27
- package/dist/reporters/consoleReporter.test.js.map +1 -1
- package/dist/reporters/enhancedReporter.d.ts +51 -7
- package/dist/reporters/enhancedReporter.js +128 -74
- package/dist/reporters/enhancedReporter.js.map +1 -1
- package/dist/reporters/enhancedReporter.test.js +110 -122
- package/dist/reporters/enhancedReporter.test.js.map +1 -1
- package/dist/reporters/jsonReporter.d.ts +6 -6
- package/dist/reporters/jsonReporter.js +24 -14
- package/dist/reporters/jsonReporter.js.map +1 -1
- package/dist/reporters/jsonReporter.test.js +26 -11
- package/dist/reporters/jsonReporter.test.js.map +1 -1
- package/dist/reporters/markdownIssueCells.d.ts +7 -0
- package/dist/reporters/markdownIssueCells.js +9 -0
- package/dist/reporters/markdownIssueCells.js.map +1 -0
- package/dist/reporters/markdownReporter.d.ts +2 -7
- package/dist/reporters/markdownReporter.js +57 -56
- package/dist/reporters/markdownReporter.js.map +1 -1
- package/dist/reporters/markdownReporter.test.js +104 -76
- package/dist/reporters/markdownReporter.test.js.map +1 -1
- package/dist/reporters/publicReporterApi.test.d.ts +1 -0
- package/dist/reporters/publicReporterApi.test.js +28 -0
- package/dist/reporters/publicReporterApi.test.js.map +1 -0
- package/dist/reporters/reportContext.d.ts +12 -0
- package/dist/reporters/reportContext.js +8 -0
- package/dist/reporters/reportContext.js.map +1 -0
- package/dist/reporters/reportContext.test.d.ts +1 -0
- package/dist/reporters/reportContext.test.js +30 -0
- package/dist/reporters/reportContext.test.js.map +1 -0
- package/dist/reporters/reporters.characterization.test.d.ts +1 -0
- package/dist/reporters/reporters.characterization.test.js +208 -0
- package/dist/reporters/reporters.characterization.test.js.map +1 -0
- package/dist/runner.js +67 -63
- package/dist/runner.js.map +1 -1
- package/dist/runner.test.js +444 -42
- package/dist/runner.test.js.map +1 -1
- package/dist/semantic/vectorSearch.js +2 -1
- package/dist/semantic/vectorSearch.js.map +1 -1
- package/dist/semantic/vectorSearch.test.js +2 -2
- package/dist/semantic/vectorSearch.test.js.map +1 -1
- package/dist/source/sourceIndex.d.ts +39 -0
- package/dist/source/sourceIndex.js +444 -0
- package/dist/source/sourceIndex.js.map +1 -0
- package/dist/source/sourceIndex.largeGlob.test.d.ts +1 -0
- package/dist/source/sourceIndex.largeGlob.test.js +29 -0
- package/dist/source/sourceIndex.largeGlob.test.js.map +1 -0
- package/dist/source/sourceIndex.test.d.ts +1 -0
- package/dist/source/sourceIndex.test.js +263 -0
- package/dist/source/sourceIndex.test.js.map +1 -0
- package/dist/source/sourceValidators.d.ts +7 -0
- package/dist/source/sourceValidators.js +8 -0
- package/dist/source/sourceValidators.js.map +1 -0
- package/dist/source/sourceValidators.test.d.ts +1 -0
- package/dist/source/sourceValidators.test.js +17 -0
- package/dist/source/sourceValidators.test.js.map +1 -0
- package/dist/types.d.ts +34 -2
- package/dist/validators/codePatternValidator.d.ts +5 -11
- package/dist/validators/codePatternValidator.js +17 -145
- package/dist/validators/codePatternValidator.js.map +1 -1
- package/dist/validators/codeSnippetValidator.d.ts +5 -18
- package/dist/validators/codeSnippetValidator.js +19 -312
- package/dist/validators/codeSnippetValidator.js.map +1 -1
- package/dist/validators/dependencyValidator.d.ts +0 -5
- package/dist/validators/dependencyValidator.js +7 -64
- package/dist/validators/dependencyValidator.js.map +1 -1
- package/dist/validators/versionValidator.d.ts +1 -10
- package/dist/validators/versionValidator.js +7 -157
- package/dist/validators/versionValidator.js.map +1 -1
- package/dist/validators/versionValidator.test.js +1 -101
- package/dist/validators/versionValidator.test.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,85 +1,139 @@
|
|
|
1
|
-
import { escapeMarkdownTableCell } from '../utils/escapeMarkdownTableCell.js';
|
|
2
1
|
import { formatVectorMismatches } from './formatVectorMismatches.js';
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
2
|
+
import { normalizeMarkdownIssueCells } from './markdownIssueCells.js';
|
|
3
|
+
export function createEnhancedReportContext(results, graph, gitTracker, freshnessScores) {
|
|
4
|
+
const generatedAt = new Date().toISOString();
|
|
5
|
+
const projectScore = freshnessScores
|
|
6
|
+
? Object.freeze({
|
|
7
|
+
projectScore: freshnessScores.projectScore,
|
|
8
|
+
projectGrade: freshnessScores.projectGrade,
|
|
9
|
+
gradeA: freshnessScores.summary.gradeA,
|
|
10
|
+
gradeB: freshnessScores.summary.gradeB,
|
|
11
|
+
gradeC: freshnessScores.summary.gradeC,
|
|
12
|
+
gradeD: freshnessScores.summary.gradeD,
|
|
13
|
+
gradeF: freshnessScores.summary.gradeF,
|
|
14
|
+
})
|
|
15
|
+
: null;
|
|
16
|
+
const summary = Object.freeze({
|
|
17
|
+
total: results.summary.total,
|
|
18
|
+
valid: results.summary.valid,
|
|
19
|
+
errors: results.summary.errors,
|
|
20
|
+
warnings: results.summary.warnings,
|
|
21
|
+
info: results.summary.info ?? 0,
|
|
22
|
+
});
|
|
23
|
+
const documents = [];
|
|
24
|
+
for (const document of results.documents) {
|
|
25
|
+
const documentScore = freshnessScores?.documents.find((candidate) => candidate.document === document.path);
|
|
26
|
+
const score = documentScore ? Object.freeze({ totalScore: documentScore.totalScore, grade: documentScore.grade }) : null;
|
|
27
|
+
const codeFileRows = [];
|
|
28
|
+
const codeFiles = graph?.getCodeReferencedByDoc(document.path);
|
|
29
|
+
if (codeFiles?.size) {
|
|
30
|
+
for (const filePath of codeFiles) {
|
|
31
|
+
const commitInfo = gitTracker?.getFileCommitInfo(filePath);
|
|
32
|
+
const lastModifiedDate = commitInfo ? new Date(commitInfo.timestamp).toLocaleDateString() : null;
|
|
33
|
+
codeFileRows.push(Object.freeze({ path: filePath, lastModifiedDate }));
|
|
34
|
+
}
|
|
24
35
|
}
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
report += '|------|------|-------|------------|\n';
|
|
53
|
-
for (const issue of doc.issues) {
|
|
54
|
-
const severity = issue.severity === 'error' ? '❌' : issue.severity === 'info' ? 'ℹ️' : '⚠️';
|
|
55
|
-
const suggestion = escapeMarkdownTableCell(issue.suggestion || '-');
|
|
56
|
-
const message = escapeMarkdownTableCell(issue.message || '');
|
|
57
|
-
report += `| ${issue.reference.lineNumber} | ${severity} ${issue.reference.type} | ${message} | ${suggestion} |\n`;
|
|
58
|
-
}
|
|
59
|
-
report += '\n';
|
|
36
|
+
const issues = [];
|
|
37
|
+
for (const issue of document.issues) {
|
|
38
|
+
const { isError, isInfo, suggestion, message } = normalizeMarkdownIssueCells(issue);
|
|
39
|
+
const severity = isError ? '❌' : isInfo ? 'ℹ️' : '⚠️';
|
|
40
|
+
issues.push(Object.freeze({
|
|
41
|
+
lineNumber: issue.reference.lineNumber,
|
|
42
|
+
severity,
|
|
43
|
+
type: issue.reference.type,
|
|
44
|
+
message,
|
|
45
|
+
suggestion,
|
|
46
|
+
}));
|
|
47
|
+
}
|
|
48
|
+
documents.push(Object.freeze({
|
|
49
|
+
path: document.path,
|
|
50
|
+
score,
|
|
51
|
+
codeFiles: Object.freeze(codeFileRows),
|
|
52
|
+
issues: Object.freeze(issues),
|
|
53
|
+
}));
|
|
54
|
+
}
|
|
55
|
+
const semanticAnalysis = formatVectorMismatches(results.vectorMismatches);
|
|
56
|
+
let recentlyImpactedDocuments = Object.freeze([]);
|
|
57
|
+
if (gitTracker?.isGitRepo() && graph) {
|
|
58
|
+
try {
|
|
59
|
+
const recentChanges = gitTracker.getChangedFilesSince(Date.now() - 7 * 24 * 60 * 60 * 1000);
|
|
60
|
+
const impactedDocuments = gitTracker.getAffectedDocs(graph, recentChanges);
|
|
61
|
+
if (impactedDocuments.length > 0) {
|
|
62
|
+
recentlyImpactedDocuments = Object.freeze([...impactedDocuments]);
|
|
60
63
|
}
|
|
61
64
|
}
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
65
|
+
catch {
|
|
66
|
+
// Preserve reporting when recent-change lookup fails.
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
return Object.freeze({
|
|
70
|
+
model: Object.freeze({
|
|
71
|
+
generatedAt,
|
|
72
|
+
projectScore,
|
|
73
|
+
summary,
|
|
74
|
+
documents: Object.freeze(documents),
|
|
75
|
+
semanticAnalysis,
|
|
76
|
+
recentlyImpactedDocuments,
|
|
77
|
+
}),
|
|
78
|
+
});
|
|
79
|
+
}
|
|
80
|
+
export function renderEnhancedReport(report) {
|
|
81
|
+
const enhanced = report.model;
|
|
82
|
+
let output = '';
|
|
83
|
+
output += '# 📚 Documentation Freshness Scan Report\n\n';
|
|
84
|
+
output += `**Generated:** ${enhanced.generatedAt}\n\n`;
|
|
85
|
+
if (enhanced.projectScore) {
|
|
86
|
+
output += `## 📊 Project Freshness Score: ${enhanced.projectScore.projectScore}/100 `;
|
|
87
|
+
output += `(Grade: ${enhanced.projectScore.projectGrade})\n\n`;
|
|
88
|
+
output += '| Grade | Count |\n|-------|-------|\n';
|
|
89
|
+
output += `| A (90-100) | ${enhanced.projectScore.gradeA} |\n`;
|
|
90
|
+
output += `| B (80-89) | ${enhanced.projectScore.gradeB} |\n`;
|
|
91
|
+
output += `| C (70-79) | ${enhanced.projectScore.gradeC} |\n`;
|
|
92
|
+
output += `| D (60-69) | ${enhanced.projectScore.gradeD} |\n`;
|
|
93
|
+
output += `| F (0-59) | ${enhanced.projectScore.gradeF} |\n\n`;
|
|
94
|
+
}
|
|
95
|
+
output += '## ✅ Validation Summary\n\n';
|
|
96
|
+
output += `- **Total References:** ${enhanced.summary.total}\n`;
|
|
97
|
+
output += `- **Valid:** ${enhanced.summary.valid}\n`;
|
|
98
|
+
output += `- **Errors:** ${enhanced.summary.errors}\n`;
|
|
99
|
+
output += `- **Warnings:** ${enhanced.summary.warnings}\n`;
|
|
100
|
+
output += `- **Info:** ${enhanced.summary.info}\n\n`;
|
|
101
|
+
if (enhanced.documents.length > 0) {
|
|
102
|
+
output += '## 📋 Affected Documents\n\n';
|
|
103
|
+
for (const document of enhanced.documents) {
|
|
104
|
+
const scoreText = document.score ? ` (Score: ${document.score.totalScore}, Grade: ${document.score.grade})` : '';
|
|
105
|
+
output += `### 📄 \`${document.path}\`${scoreText}\n\n`;
|
|
106
|
+
if (document.codeFiles.length > 0) {
|
|
107
|
+
output += '**Referenced Code Files:**\n';
|
|
108
|
+
for (const codeFile of document.codeFiles) {
|
|
109
|
+
const commitText = codeFile.lastModifiedDate === null ? '' : ` (last modified: ${codeFile.lastModifiedDate})`;
|
|
110
|
+
output += `- \`${codeFile.path}\`${commitText}\n`;
|
|
76
111
|
}
|
|
112
|
+
output += '\n';
|
|
77
113
|
}
|
|
78
|
-
|
|
79
|
-
|
|
114
|
+
output += '| Line | Type | Issue | Suggestion |\n';
|
|
115
|
+
output += '|------|------|-------|------------|\n';
|
|
116
|
+
for (const issue of document.issues) {
|
|
117
|
+
output += `| ${issue.lineNumber} | ${issue.severity} ${issue.type} | ${issue.message} | ${issue.suggestion} |\n`;
|
|
80
118
|
}
|
|
119
|
+
output += '\n';
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
output += enhanced.semanticAnalysis;
|
|
123
|
+
if (enhanced.recentlyImpactedDocuments.length > 0) {
|
|
124
|
+
output += '## 🔄 Recent Code Changes Impacting Docs\n\n';
|
|
125
|
+
output += 'The following documents reference code that changed in the last 7 days:\n\n';
|
|
126
|
+
for (const documentPath of enhanced.recentlyImpactedDocuments) {
|
|
127
|
+
output += `- \`${documentPath}\`\n`;
|
|
81
128
|
}
|
|
82
|
-
|
|
129
|
+
output += '\n';
|
|
130
|
+
}
|
|
131
|
+
return output;
|
|
132
|
+
}
|
|
133
|
+
/** Enhanced reporter with DeepDocs-style output. */
|
|
134
|
+
export class EnhancedReporter {
|
|
135
|
+
generateScanReport(results, graph, gitTracker, freshnessScores) {
|
|
136
|
+
return renderEnhancedReport(createEnhancedReportContext(results, graph, gitTracker, freshnessScores));
|
|
83
137
|
}
|
|
84
138
|
}
|
|
85
139
|
//# sourceMappingURL=enhancedReporter.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enhancedReporter.js","sourceRoot":"","sources":["../../src/reporters/enhancedReporter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"enhancedReporter.js","sourceRoot":"","sources":["../../src/reporters/enhancedReporter.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,2BAA2B,EAAE,MAAM,yBAAyB,CAAC;AAmDtE,MAAM,UAAU,2BAA2B,CACzC,OAA0B,EAC1B,KAA0B,EAC1B,UAAmC,EACnC,eAAqC;IAErC,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAC7C,MAAM,YAAY,GAAG,eAAe;QAClC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;YACZ,YAAY,EAAE,eAAe,CAAC,YAAY;YAC1C,YAAY,EAAE,eAAe,CAAC,YAAY;YAC1C,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM;YACtC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM;YACtC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM;YACtC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM;YACtC,MAAM,EAAE,eAAe,CAAC,OAAO,CAAC,MAAM;SACvC,CAAC;QACJ,CAAC,CAAC,IAAI,CAAC;IACT,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK;QAC5B,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK;QAC5B,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,MAAM;QAC9B,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ;QAClC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC;KAChC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAuB,EAAE,CAAC;IACzC,KAAK,MAAM,QAAQ,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,aAAa,GAAG,eAAe,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3G,MAAM,KAAK,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,aAAa,CAAC,UAAU,EAAE,KAAK,EAAE,aAAa,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACzH,MAAM,YAAY,GAAuB,EAAE,CAAC;QAC5C,MAAM,SAAS,GAAG,KAAK,EAAE,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC/D,IAAI,SAAS,EAAE,IAAI,EAAE,CAAC;YACpB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBACjC,MAAM,UAAU,GAAG,UAAU,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;gBAC3D,MAAM,gBAAgB,GAAG,UAAU,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;gBACjG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;YACzE,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAuB,EAAE,CAAC;QACtC,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,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;YACtD,MAAM,CAAC,IAAI,CACT,MAAM,CAAC,MAAM,CAAC;gBACZ,UAAU,EAAE,KAAK,CAAC,SAAS,CAAC,UAAU;gBACtC,QAAQ;gBACR,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,IAAI;gBAC1B,OAAO;gBACP,UAAU;aACX,CAAC,CACH,CAAC;QACJ,CAAC;QAED,SAAS,CAAC,IAAI,CACZ,MAAM,CAAC,MAAM,CAAC;YACZ,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK;YACL,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;YACtC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;SAC9B,CAAC,CACH,CAAC;IACJ,CAAC;IAED,MAAM,gBAAgB,GAAG,sBAAsB,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAC1E,IAAI,yBAAyB,GAAsB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACrE,IAAI,UAAU,EAAE,SAAS,EAAE,IAAI,KAAK,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,MAAM,aAAa,GAAG,UAAU,CAAC,oBAAoB,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;YAC5F,MAAM,iBAAiB,GAAG,UAAU,CAAC,eAAe,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;YAC3E,IAAI,iBAAiB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACjC,yBAAyB,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC;YACpE,CAAC;QACH,CAAC;QACD,MAAM,CAAC;YACL,sDAAsD;QACxD,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACnB,WAAW;YACX,YAAY;YACZ,OAAO;YACP,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC;YACnC,gBAAgB;YAChB,yBAAyB;SAC1B,CAAC;KACH,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAA6B;IAChE,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC;IAC9B,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,MAAM,IAAI,8CAA8C,CAAC;IACzD,MAAM,IAAI,kBAAkB,QAAQ,CAAC,WAAW,MAAM,CAAC;IAEvD,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAC1B,MAAM,IAAI,kCAAkC,QAAQ,CAAC,YAAY,CAAC,YAAY,OAAO,CAAC;QACtF,MAAM,IAAI,WAAW,QAAQ,CAAC,YAAY,CAAC,YAAY,OAAO,CAAC;QAC/D,MAAM,IAAI,wCAAwC,CAAC;QACnD,MAAM,IAAI,kBAAkB,QAAQ,CAAC,YAAY,CAAC,MAAM,MAAM,CAAC;QAC/D,MAAM,IAAI,kBAAkB,QAAQ,CAAC,YAAY,CAAC,MAAM,MAAM,CAAC;QAC/D,MAAM,IAAI,kBAAkB,QAAQ,CAAC,YAAY,CAAC,MAAM,MAAM,CAAC;QAC/D,MAAM,IAAI,kBAAkB,QAAQ,CAAC,YAAY,CAAC,MAAM,MAAM,CAAC;QAC/D,MAAM,IAAI,kBAAkB,QAAQ,CAAC,YAAY,CAAC,MAAM,QAAQ,CAAC;IACnE,CAAC;IAED,MAAM,IAAI,6BAA6B,CAAC;IACxC,MAAM,IAAI,2BAA2B,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IAChE,MAAM,IAAI,gBAAgB,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;IACrD,MAAM,IAAI,iBAAiB,QAAQ,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC;IACvD,MAAM,IAAI,mBAAmB,QAAQ,CAAC,OAAO,CAAC,QAAQ,IAAI,CAAC;IAC3D,MAAM,IAAI,eAAe,QAAQ,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC;IAErD,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,8BAA8B,CAAC;QACzC,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;YAC1C,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,QAAQ,CAAC,KAAK,CAAC,UAAU,YAAY,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACjH,MAAM,IAAI,YAAY,QAAQ,CAAC,IAAI,KAAK,SAAS,MAAM,CAAC;YAExD,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAClC,MAAM,IAAI,8BAA8B,CAAC;gBACzC,KAAK,MAAM,QAAQ,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;oBAC1C,MAAM,UAAU,GAAG,QAAQ,CAAC,gBAAgB,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,QAAQ,CAAC,gBAAgB,GAAG,CAAC;oBAC9G,MAAM,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC;gBACpD,CAAC;gBACD,MAAM,IAAI,IAAI,CAAC;YACjB,CAAC;YAED,MAAM,IAAI,wCAAwC,CAAC;YACnD,MAAM,IAAI,wCAAwC,CAAC;YACnD,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;gBACpC,MAAM,IAAI,KAAK,KAAK,CAAC,UAAU,MAAM,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC,OAAO,MAAM,KAAK,CAAC,UAAU,MAAM,CAAC;YACnH,CAAC;YACD,MAAM,IAAI,IAAI,CAAC;QACjB,CAAC;IACH,CAAC;IAED,MAAM,IAAI,QAAQ,CAAC,gBAAgB,CAAC;IAEpC,IAAI,QAAQ,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,IAAI,8CAA8C,CAAC;QACzD,MAAM,IAAI,6EAA6E,CAAC;QACxF,KAAK,MAAM,YAAY,IAAI,QAAQ,CAAC,yBAAyB,EAAE,CAAC;YAC9D,MAAM,IAAI,OAAO,YAAY,MAAM,CAAC;QACtC,CAAC;QACD,MAAM,IAAI,IAAI,CAAC;IACjB,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,oDAAoD;AACpD,MAAM,OAAO,gBAAgB;IAC3B,kBAAkB,CAChB,OAA0B,EAC1B,KAA0B,EAC1B,UAAmC,EACnC,eAAqC;QAErC,OAAO,oBAAoB,CAAC,2BAA2B,CAAC,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,eAAe,CAAC,CAAC,CAAC;IACxG,CAAC;CACF"}
|
|
@@ -1,49 +1,46 @@
|
|
|
1
|
-
import { EnhancedReporter } from './enhancedReporter.js';
|
|
2
1
|
import { CodeDocGraph } from '../graph/codeDocGraph.js';
|
|
2
|
+
import { createEnhancedReportContext, EnhancedReporter } from './enhancedReporter.js';
|
|
3
|
+
const emptyResults = {
|
|
4
|
+
documents: [],
|
|
5
|
+
summary: { total: 0, valid: 0, errors: 0, warnings: 0, skipped: 0 },
|
|
6
|
+
};
|
|
7
|
+
const results = {
|
|
8
|
+
documents: [
|
|
9
|
+
{
|
|
10
|
+
path: 'docs/api.md',
|
|
11
|
+
issues: [
|
|
12
|
+
{
|
|
13
|
+
reference: { type: 'file-path', value: 'missing.ts', lineNumber: 5, raw: 'missing.ts', sourceFile: 'api.md' },
|
|
14
|
+
valid: false,
|
|
15
|
+
severity: 'error',
|
|
16
|
+
message: 'File not found',
|
|
17
|
+
suggestion: 'Did you mean missing.tsx?',
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
reference: { type: 'external-url', value: 'https://old.com', lineNumber: 12, raw: 'https://old.com', sourceFile: 'api.md' },
|
|
21
|
+
valid: false,
|
|
22
|
+
severity: 'warning',
|
|
23
|
+
message: 'URL returned 404',
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
reference: { type: 'dependency', value: 'missing-pkg', lineNumber: 20, raw: 'missing-pkg', sourceFile: 'api.md' },
|
|
27
|
+
valid: false,
|
|
28
|
+
severity: 'info',
|
|
29
|
+
message: 'Package not found',
|
|
30
|
+
},
|
|
31
|
+
],
|
|
32
|
+
},
|
|
33
|
+
],
|
|
34
|
+
summary: { total: 4, valid: 1, errors: 1, warnings: 1, info: 1, skipped: 0 },
|
|
35
|
+
};
|
|
36
|
+
const graphWithReference = () => {
|
|
37
|
+
const graph = new CodeDocGraph();
|
|
38
|
+
graph.addReference('docs/api.md', 'src/server.ts', results.documents[0].issues[0].reference);
|
|
39
|
+
return graph;
|
|
40
|
+
};
|
|
3
41
|
describe('EnhancedReporter', () => {
|
|
4
42
|
const reporter = new EnhancedReporter();
|
|
5
|
-
|
|
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
|
-
reference: { type: 'dependency', value: 'missing-pkg', lineNumber: 20, raw: 'missing-pkg', sourceFile: 'api.md' },
|
|
25
|
-
valid: false,
|
|
26
|
-
severity: 'info',
|
|
27
|
-
message: 'Package not found',
|
|
28
|
-
},
|
|
29
|
-
],
|
|
30
|
-
},
|
|
31
|
-
],
|
|
32
|
-
summary: { total: 4, valid: 1, errors: 1, warnings: 1, info: 1, skipped: 0 },
|
|
33
|
-
};
|
|
34
|
-
const emptyResults = {
|
|
35
|
-
documents: [],
|
|
36
|
-
summary: { total: 0, valid: 0, errors: 0, warnings: 0, skipped: 0 },
|
|
37
|
-
};
|
|
38
|
-
it('generates scan report with validation summary', () => {
|
|
39
|
-
const report = reporter.generateScanReport(results, null, null, null);
|
|
40
|
-
expect(report).toContain('Documentation Freshness Scan Report');
|
|
41
|
-
expect(report).toContain('Total References:** 4');
|
|
42
|
-
expect(report).toContain('Errors:** 1');
|
|
43
|
-
expect(report).toContain('Warnings:** 1');
|
|
44
|
-
expect(report).toContain('Info:** 1');
|
|
45
|
-
});
|
|
46
|
-
it('includes freshness scores with grade table', () => {
|
|
43
|
+
it('generates summary, score, graph, and distinct severity details', () => {
|
|
47
44
|
const scores = {
|
|
48
45
|
projectScore: 80,
|
|
49
46
|
projectGrade: 'B',
|
|
@@ -57,105 +54,96 @@ describe('EnhancedReporter', () => {
|
|
|
57
54
|
],
|
|
58
55
|
summary: { total: 1, gradeA: 0, gradeB: 1, gradeC: 0, gradeD: 0, gradeF: 0 },
|
|
59
56
|
};
|
|
60
|
-
const report = reporter.generateScanReport(results, null, null, scores);
|
|
61
|
-
expect(report).toContain('80/100');
|
|
62
|
-
expect(report).toContain('Grade: B');
|
|
63
|
-
expect(report).toContain('A (90-100)');
|
|
64
|
-
});
|
|
65
|
-
it('shows referenced code files from graph', () => {
|
|
66
|
-
const graph = new CodeDocGraph();
|
|
67
|
-
graph.addReference('docs/api.md', 'src/server.ts', {
|
|
68
|
-
type: 'file-path',
|
|
69
|
-
value: 'src/server.ts',
|
|
70
|
-
lineNumber: 1,
|
|
71
|
-
raw: 'src/server.ts',
|
|
72
|
-
sourceFile: 'api.md',
|
|
73
|
-
});
|
|
74
|
-
const report = reporter.generateScanReport(results, graph, null, null);
|
|
75
|
-
expect(report).toContain('src/server.ts');
|
|
76
|
-
expect(report).toContain('Referenced Code Files');
|
|
77
|
-
});
|
|
78
|
-
it('shows commit info for referenced code files', () => {
|
|
79
|
-
const graph = new CodeDocGraph();
|
|
80
|
-
graph.addReference('docs/api.md', 'src/server.ts', {
|
|
81
|
-
type: 'file-path',
|
|
82
|
-
value: 'src/server.ts',
|
|
83
|
-
lineNumber: 1,
|
|
84
|
-
raw: 'src/server.ts',
|
|
85
|
-
sourceFile: 'api.md',
|
|
86
|
-
});
|
|
87
57
|
const gitTracker = {
|
|
88
|
-
isGitRepo: () => true,
|
|
89
58
|
getFileCommitInfo: vi.fn().mockReturnValue({ hash: 'abc', timestamp: Date.now(), message: 'fix' }),
|
|
90
|
-
|
|
91
|
-
getAffectedDocs: vi.fn().mockReturnValue([]),
|
|
59
|
+
isGitRepo: () => false,
|
|
92
60
|
};
|
|
93
|
-
const report = reporter.generateScanReport(results,
|
|
94
|
-
expect(report).toContain('
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
const scores = {
|
|
98
|
-
projectScore: 80,
|
|
99
|
-
projectGrade: 'B',
|
|
100
|
-
documents: [
|
|
101
|
-
{
|
|
102
|
-
document: 'docs/api.md',
|
|
103
|
-
totalScore: 80,
|
|
104
|
-
factors: { referenceValidity: 80, gitTimeDelta: 80, codeChangeFrequency: 80, symbolCoverage: 80 },
|
|
105
|
-
grade: 'B',
|
|
106
|
-
},
|
|
107
|
-
],
|
|
108
|
-
summary: { total: 1, gradeA: 0, gradeB: 1, gradeC: 0, gradeD: 0, gradeF: 0 },
|
|
109
|
-
};
|
|
110
|
-
const report = reporter.generateScanReport(results, null, null, scores);
|
|
61
|
+
const report = reporter.generateScanReport(results, graphWithReference(), gitTracker, scores);
|
|
62
|
+
expect(report).toContain('Total References:** 4');
|
|
63
|
+
expect(report).toContain('Warnings:** 1');
|
|
64
|
+
expect(report).toContain('Info:** 1');
|
|
111
65
|
expect(report).toContain('Score: 80');
|
|
112
66
|
expect(report).toContain('Grade: B');
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
expect(report).toContain('
|
|
117
|
-
expect(report).toContain('⚠️');
|
|
67
|
+
expect(report).toContain('src/server.ts');
|
|
68
|
+
expect(report).toContain('last modified');
|
|
69
|
+
expect(report).toContain('❌ file-path');
|
|
70
|
+
expect(report).toContain('⚠️ external-url');
|
|
118
71
|
expect(report).toContain('ℹ️ dependency');
|
|
119
|
-
expect(report).toContain('File not found');
|
|
120
|
-
expect(report).toContain('missing.tsx');
|
|
121
|
-
expect(report).toContain('URL returned 404');
|
|
122
72
|
});
|
|
123
|
-
it('omits affected documents
|
|
73
|
+
it('omits affected documents and normalizes legacy info when no documents have issues', () => {
|
|
124
74
|
const report = reporter.generateScanReport(emptyResults, null, null, null);
|
|
125
75
|
expect(report).not.toContain('Affected Documents');
|
|
126
76
|
expect(report).toContain('Info:** 0');
|
|
127
77
|
});
|
|
128
|
-
it('
|
|
129
|
-
const
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
78
|
+
it('renders semantic analysis once before recent impacts', () => {
|
|
79
|
+
const vectorResults = {
|
|
80
|
+
...emptyResults,
|
|
81
|
+
vectorMismatches: [
|
|
82
|
+
{
|
|
83
|
+
docPath: 'docs/api.md',
|
|
84
|
+
docSection: 'API',
|
|
85
|
+
docText: 'API docs',
|
|
86
|
+
bestMatchScore: 0,
|
|
87
|
+
bestMatch: null,
|
|
88
|
+
suggestion: 'Review this section',
|
|
89
|
+
},
|
|
90
|
+
],
|
|
91
|
+
};
|
|
137
92
|
const gitTracker = {
|
|
138
93
|
isGitRepo: () => true,
|
|
139
|
-
|
|
140
|
-
getChangedFilesSince: vi.fn().mockReturnValue(['src/server.ts']),
|
|
94
|
+
getChangedFilesSince: vi.fn().mockReturnValue(['src/api.ts']),
|
|
141
95
|
getAffectedDocs: vi.fn().mockReturnValue(['docs/api.md']),
|
|
142
96
|
};
|
|
143
|
-
const report = reporter.generateScanReport(
|
|
144
|
-
expect(report).
|
|
145
|
-
expect(report
|
|
97
|
+
const report = reporter.generateScanReport(vectorResults, new CodeDocGraph(), gitTracker, null);
|
|
98
|
+
expect(report.indexOf('Semantic Analysis')).toBeLessThan(report.indexOf('Recent Code Changes'));
|
|
99
|
+
expect(report.match(/Semantic Analysis/g)).toHaveLength(1);
|
|
100
|
+
expect(report).toContain('| - |');
|
|
101
|
+
});
|
|
102
|
+
it('freezes only internally owned model entries and arrays', () => {
|
|
103
|
+
const graph = graphWithReference();
|
|
104
|
+
const context = createEnhancedReportContext(results, graph, null, null);
|
|
105
|
+
const entry = context.model.documents[0];
|
|
106
|
+
expect(Object.isFrozen(context)).toBe(true);
|
|
107
|
+
expect(Object.isFrozen(context.model)).toBe(true);
|
|
108
|
+
expect(Object.isFrozen(context.model.summary)).toBe(true);
|
|
109
|
+
expect(Object.isFrozen(context.model.documents)).toBe(true);
|
|
110
|
+
expect(Object.isFrozen(entry)).toBe(true);
|
|
111
|
+
expect(Object.isFrozen(entry.codeFiles)).toBe(true);
|
|
112
|
+
expect(Object.isFrozen(entry.codeFiles[0])).toBe(true);
|
|
113
|
+
expect(Object.isFrozen(graph)).toBe(false);
|
|
114
|
+
expect(Object.isFrozen(results)).toBe(false);
|
|
146
115
|
});
|
|
147
|
-
it('
|
|
148
|
-
const graph = new CodeDocGraph();
|
|
116
|
+
it.each(['changes', 'affected'])('swallows %s lookup errors inside the recent-change boundary', (failure) => {
|
|
149
117
|
const gitTracker = {
|
|
150
118
|
isGitRepo: () => true,
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
119
|
+
getChangedFilesSince: vi.fn(() => {
|
|
120
|
+
if (failure === 'changes') {
|
|
121
|
+
throw new Error('git error');
|
|
122
|
+
}
|
|
123
|
+
return ['src/api.ts'];
|
|
154
124
|
}),
|
|
155
|
-
getAffectedDocs: vi.fn()
|
|
125
|
+
getAffectedDocs: vi.fn(() => {
|
|
126
|
+
if (failure === 'affected') {
|
|
127
|
+
throw new Error('graph error');
|
|
128
|
+
}
|
|
129
|
+
return ['docs/api.md'];
|
|
130
|
+
}),
|
|
131
|
+
};
|
|
132
|
+
expect(reporter.generateScanReport(emptyResults, new CodeDocGraph(), gitTracker, null)).not.toContain('Recent Code Changes');
|
|
133
|
+
});
|
|
134
|
+
it('propagates collaborator errors outside the recent-change boundary', () => {
|
|
135
|
+
const commitFailure = {
|
|
136
|
+
getFileCommitInfo: () => {
|
|
137
|
+
throw new Error('commit lookup failed');
|
|
138
|
+
},
|
|
139
|
+
};
|
|
140
|
+
expect(() => reporter.generateScanReport(results, graphWithReference(), commitFailure, null)).toThrow('commit lookup failed');
|
|
141
|
+
const repoFailure = {
|
|
142
|
+
isGitRepo: () => {
|
|
143
|
+
throw new Error('repo detection failed');
|
|
144
|
+
},
|
|
156
145
|
};
|
|
157
|
-
|
|
158
|
-
expect(report).not.toContain('Recent Code Changes');
|
|
146
|
+
expect(() => reporter.generateScanReport(emptyResults, new CodeDocGraph(), repoFailure, null)).toThrow('repo detection failed');
|
|
159
147
|
});
|
|
160
148
|
});
|
|
161
149
|
//# sourceMappingURL=enhancedReporter.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"enhancedReporter.test.js","sourceRoot":"","sources":["../../src/reporters/enhancedReporter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"enhancedReporter.test.js","sourceRoot":"","sources":["../../src/reporters/enhancedReporter.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAGxD,OAAO,EAAE,2BAA2B,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEtF,MAAM,YAAY,GAAsB;IACtC,SAAS,EAAE,EAAE;IACb,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE;CACpE,CAAC;AAEF,MAAM,OAAO,GAAsB;IACjC,SAAS,EAAE;QACT;YACE,IAAI,EAAE,aAAa;YACnB,MAAM,EAAE;gBACN;oBACE,SAAS,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,CAAC,EAAE,GAAG,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE;oBAC7G,KAAK,EAAE,KAAK;oBACZ,QAAQ,EAAE,OAAO;oBACjB,OAAO,EAAE,gBAAgB;oBACzB,UAAU,EAAE,2BAA2B;iBACxC;gBACD;oBACE,SAAS,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,iBAAiB,EAAE,UAAU,EAAE,QAAQ,EAAE;oBAC3H,KAAK,EAAE,KAAK;oBACZ,QAAQ,EAAE,SAAS;oBACnB,OAAO,EAAE,kBAAkB;iBAC5B;gBACD;oBACE,SAAS,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,EAAE,EAAE,GAAG,EAAE,aAAa,EAAE,UAAU,EAAE,QAAQ,EAAE;oBACjH,KAAK,EAAE,KAAK;oBACZ,QAAQ,EAAE,MAAM;oBAChB,OAAO,EAAE,mBAAmB;iBAC7B;aACF;SACF;KACF;IACD,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;CAC7E,CAAC;AAEF,MAAM,kBAAkB,GAAG,GAAG,EAAE;IAC9B,MAAM,KAAK,GAAG,IAAI,YAAY,EAAE,CAAC;IACjC,KAAK,CAAC,YAAY,CAAC,aAAa,EAAE,eAAe,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAC7F,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,MAAM,QAAQ,GAAG,IAAI,gBAAgB,EAAE,CAAC;IAExC,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,MAAM,GAAkB;YAC5B,YAAY,EAAE,EAAE;YAChB,YAAY,EAAE,GAAG;YACjB,SAAS,EAAE;gBACT;oBACE,QAAQ,EAAE,aAAa;oBACvB,UAAU,EAAE,EAAE;oBACd,OAAO,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE,EAAE;oBACjG,KAAK,EAAE,GAAG;iBACX;aACF;YACD,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;SAC7E,CAAC;QACF,MAAM,UAAU,GAAG;YACjB,iBAAiB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YAClG,SAAS,EAAE,GAAG,EAAE,CAAC,KAAK;SACQ,CAAC;QAEjC,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,EAAE,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAC9F,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACtC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mFAAmF,EAAE,GAAG,EAAE;QAC3F,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3E,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QACnD,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;QAC9D,MAAM,aAAa,GAAsB;YACvC,GAAG,YAAY;YACf,gBAAgB,EAAE;gBAChB;oBACE,OAAO,EAAE,aAAa;oBACtB,UAAU,EAAE,KAAK;oBACjB,OAAO,EAAE,UAAU;oBACnB,cAAc,EAAE,CAAC;oBACjB,SAAS,EAAE,IAAI;oBACf,UAAU,EAAE,qBAAqB;iBAClC;aACF;SACF,CAAC;QACF,MAAM,UAAU,GAAG;YACjB,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;YACrB,oBAAoB,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,YAAY,CAAC,CAAC;YAC7D,eAAe,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,aAAa,CAAC,CAAC;SAC3B,CAAC;QAEjC,MAAM,MAAM,GAAG,QAAQ,CAAC,kBAAkB,CAAC,aAAa,EAAE,IAAI,YAAY,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;QAChG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAChG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,KAAK,GAAG,kBAAkB,EAAE,CAAC;QACnC,MAAM,OAAO,GAAG,2BAA2B,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;QACxE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAEzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5D,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACvD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,UAAU,CAAU,CAAC,CAAC,6DAA6D,EAAE,CAAC,OAAO,EAAE,EAAE;QACnH,MAAM,UAAU,GAAG;YACjB,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI;YACrB,oBAAoB,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE;gBAC/B,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAC1B,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;gBAC/B,CAAC;gBACD,OAAO,CAAC,YAAY,CAAC,CAAC;YACxB,CAAC,CAAC;YACF,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE;gBAC1B,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;gBACjC,CAAC;gBACD,OAAO,CAAC,aAAa,CAAC,CAAC;YACzB,CAAC,CAAC;SAC4B,CAAC;QAEjC,MAAM,CAAC,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,YAAY,EAAE,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAC/H,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mEAAmE,EAAE,GAAG,EAAE;QAC3E,MAAM,aAAa,GAAG;YACpB,iBAAiB,EAAE,GAAG,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC1C,CAAC;SAC6B,CAAC;QACjC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,OAAO,EAAE,kBAAkB,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;QAE9H,MAAM,WAAW,GAAG;YAClB,SAAS,EAAE,GAAG,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC3C,CAAC;SAC6B,CAAC;QACjC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,YAAY,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAClI,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import type { ProjectScores, ValidationResults } from '../types.js';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
import { createReportContext } from './reportContext.js';
|
|
3
|
+
type ReportContext = ReturnType<typeof createReportContext>;
|
|
4
|
+
export declare function createScoredJsonReportContext(results: ValidationResults, freshnessScores: ProjectScores | null): ReportContext;
|
|
5
|
+
export declare function renderJsonReport(report: ReportContext): string;
|
|
6
|
+
/** JSON reporter for machine-readable output. */
|
|
5
7
|
export declare class JsonReporter {
|
|
6
8
|
generate(results: ValidationResults): string;
|
|
7
|
-
/**
|
|
8
|
-
* Generate with freshness scores
|
|
9
|
-
*/
|
|
10
9
|
generateWithScores(results: ValidationResults, freshnessScores: ProjectScores | null): string;
|
|
11
10
|
}
|
|
11
|
+
export {};
|