Repository navigation
feat: unify JSON output format between --json flag and HTML report's report.json #237
Description
The HTML report writes a report.json alongside index.html using the internal ReportData shape, while --json outputs a different structure derived directly from findings. These two formats should be identical so tooling built on one works with the other.
Activity
ELHart05 commentedon Jul 18, 2026
I'd like to take this, but since changing
--jsonis a breaking change for anyone parsing it, I want to agree on the target shape with you first.Here is where the two differ today:
--json(write-outputs.ts) emitsmode,source,findingCount;report.json(theReportDatashape) emitsscannedAt,cliVersion,packageManager,lockfileSource. They already shareprojectPath,packageCount,suggestedFixCommands,notes,warnings,skippedDependencies, andfindings.--jsonserializes each finding withserializeFinding;report.jsonusesserializeHtmlFinding, which is the same object plusriskSummaryandnextAction.--jsonspreadsoverrideFindingsToJson(...)at the top level;report.jsoncarries anoverrideFindingsarray. Different shapes.--jsonhas its own separate{ multiFolder, folders, findings }shape, which would need to fold in too.My suggestion: make
ReportDatathe single canonical schema and have--jsonemit it (both produced by one builder/serializer path), folding the useful--json-only fields (mode,source) intoReportDataso nothing is lost, and settling on one overrides representation (theoverrideFindingsarray). I would also add aschemaVersionfield so downstream tooling can detect the change.Two questions before I code:
--jsonontoreport.json(my suggestion), or the reverse?--jsonnow, or would you prefer a deprecation window?Happy to open the PR once you have picked a direction.
alex-powell commentedon Sep 20, 2026
Working on this.
fix(output): align HTML report.json with --json output shape
fix(output): align HTML report.json with --json output shape
fix(output): align the HTML report.json with the --json output shape (O…