Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 89 additions & 1 deletion src/output/multi-folder-html-reporter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,62 @@ import {
serializeHtmlFinding,
} from "./html-reporter.js";
import type { SerializedFinding } from "./html-reporter.js";
import { renderOverrideFindingsHtml } from "./override-findings-html.js";
import { renderMaintenanceFindingsHtml } from "./maintenance-findings-html.js";
import { loadLogoDataUri } from "./logos.js";
import { pluralize } from "../utils/string.js";
import type { SeverityLabel } from "../types.js";
import type { OverrideFinding } from "../overrides/types.js";
import type { MaintenanceFinding } from "../maintenance/types.js";

export type MultiFolderReportData = {
multiFolder: true;
projectPath: string;
scannedAt: string;
cliVersion: string;
folders: string[];
findings: Array<SerializedFinding & { subfolder: string }>;
overrideFindings?: Array<OverrideFinding & { subfolder: string }>;
maintenanceFindings?: Array<MaintenanceFinding & { subfolder: string }>;
};

export function buildMultiFolderReportData(params: {
results: MultiFolderScanResult[];
projectPath: string;
cliVersion: string;
includeOverrides?: boolean;
includeMaintenance?: boolean;
}): MultiFolderReportData {
const findings = params.results.flatMap(r =>
r.sorted.map(f => ({
...serializeHtmlFinding(f, r.suggestedFixCommands),
subfolder: r.subfolder,
})),
);

return {
multiFolder: true,
projectPath: params.projectPath,
scannedAt: new Date().toISOString(),
cliVersion: params.cliVersion,
folders: params.results.map(r => r.subfolder),
findings,
...(params.includeOverrides
? {
overrideFindings: params.results.flatMap(r =>
r.overrideFindings.map(f => ({ ...f, subfolder: r.subfolder })),
),
}
: {}),
...(params.includeMaintenance
? {
maintenanceFindings: params.results.flatMap(r =>
r.maintenanceFindings.map(f => ({ ...f, subfolder: r.subfolder })),
),
}
: {}),
};
}

type SevCounts = Record<SeverityLabel, number>;

Expand Down Expand Up @@ -43,6 +96,9 @@ function renderFolderSection(
folderIdx: number,
idxOffset: number,
serialized: SerializedFinding[],
projectRoot: string,
includeOverrides?: boolean,
includeMaintenance?: boolean,
): string {
const counts = { critical: 0, high: 0, medium: 0, low: 0, unknown: 0 };
for (const f of result.sorted) {
Expand All @@ -62,6 +118,13 @@ function renderFolderSection(
const fixPlanHtml = renderFixPlan(result.suggestedFixCommands);
const noticesHtml = renderFolderNotices(result.coverage);
const completenessBannerHtml = renderCompletenessBanner(result.completeness);
const folderAbs = path.join(projectRoot, result.subfolder);
const overrideHtml = includeOverrides
? renderOverrideFindingsHtml(result.overrideFindings, folderAbs)
: "";
const maintenanceHtml = includeMaintenance
? renderMaintenanceFindingsHtml(result.maintenanceFindings)
: "";

const emptyRow = result.sorted.length === 0
? `<tr><td colspan="6" style="text-align:center;padding:24px;color:#8b949e">No findings</td></tr>`
Expand Down Expand Up @@ -111,6 +174,8 @@ function renderFolderSection(
</tbody>
</table>
</div>
${overrideHtml}
${maintenanceHtml}
</div>
</details>`;
}
Expand All @@ -121,6 +186,10 @@ export async function writeMultiFolderHtmlReport(params: {
projectPath: string;
cliVersion: string;
autoOpen: boolean;
/** When true, render override hygiene panels (even if empty). */
includeOverrides?: boolean;
/** When true, render maintenance risk panels (even if empty). */
includeMaintenance?: boolean;
}): Promise<{ reportPath: string }> {
fs.mkdirSync(params.outputDir, { recursive: true });

Expand All @@ -142,6 +211,14 @@ export async function writeMultiFolderHtmlReport(params: {
r.sorted.map(f => serializeHtmlFinding(f, r.suggestedFixCommands)),
);

const reportData = buildMultiFolderReportData({
results: params.results,
projectPath: params.projectPath,
cliVersion: params.cliVersion,
includeOverrides: params.includeOverrides,
includeMaintenance: params.includeMaintenance,
});

// Compact per-folder findings for JavaScript (only fields needed for filter/sort/search)
const folderFindingsJson = JSON.stringify(
allSerialized.map(findings =>
Expand All @@ -162,7 +239,15 @@ export async function writeMultiFolderHtmlReport(params: {
let idxOffset = 0;
const folderSectionsHtml = params.results
.map((r, fi) => {
const html = renderFolderSection(r, fi, idxOffset, allSerialized[fi]);
const html = renderFolderSection(
r,
fi,
idxOffset,
allSerialized[fi],
params.projectPath,
params.includeOverrides,
params.includeMaintenance,
);
idxOffset += r.sorted.length;
return html;
})
Expand All @@ -188,6 +273,7 @@ details[open] > .folder-summary .chevron{transform:rotate(90deg)}
.folder-counts{font-size:11px;color:#8b949e;margin-left:auto}
.folder-body{padding:0}
.folder-body .fix-plan{margin:24px 32px 0}
.folder-body .override-hygiene,.folder-body .maintenance-risk{margin:0 32px 24px}
</style>
</head>
<body>
Expand Down Expand Up @@ -370,6 +456,8 @@ document.addEventListener('click', function(e) {
</html>`;

const indexPath = path.join(params.outputDir, "index.html");
const jsonPath = path.join(params.outputDir, "report.json");
fs.writeFileSync(jsonPath, JSON.stringify(reportData, null, 2), "utf8");
fs.writeFileSync(indexPath, html, "utf8");

if (params.autoOpen) openInBrowser(indexPath);
Expand Down
4 changes: 4 additions & 0 deletions src/scan/multi-folder-scan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -349,6 +349,10 @@ export async function handleMultiFolderScan(params: {
projectPath: params.projectRoot,
cliVersion,
autoOpen: !params.options.noOpen,
// Same undefined-vs-[] contract as single-folder buildReportData: pass the
// flag so empty panels render when the check ran with no hits.
includeOverrides: !!params.options.checkOverrides,
includeMaintenance: !!params.options.checkMaintenance,
});
console.log(`${chalk.gray("Report:")} ${chalk.cyan(reportPath)}`);
}
Expand Down
Loading