Skip to content

Report output improvements and a JSON renderer for the MDM#85

Merged
rousso merged 5 commits into
developfrom
feature/report-title-and-hint
Jun 17, 2026
Merged

Report output improvements and a JSON renderer for the MDM#85
rousso merged 5 commits into
developfrom
feature/report-title-and-hint

Conversation

@rousso

@rousso rousso commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Report-output improvements to the analyzer, plus a JSON renderer for programmatic consumers.

Report output

Title banner — the console and both report files now open with a banner carrying the SDK version, the analyser's own version, and the run timestamp (UTC).

--verbose removed — the console always shows the consumable summary; the full per-finding list is always written to analyzer-report.txt. The stale "re-run with --verbose" hint is gone.

analyzer-report.txt is detail-only — the summary is no longer duplicated into it. analyzer-summary.txt holds the digest and points to the detail file.

  • The summary points to analyzer-report.txt on warning-only runs too (previously only on errors); covered by a new test.
  • analyze(Path, boolean skipEfx) is now package-private; the public entry point remains analyze(Path).

JSON output

JsonReportRenderer — renders an AnalysisResults as a JSON string: a summary (counts, plus per-section counts) and a flat, self-describing findings array (section, severity, rule, problem, subject, referenced assets, message). Intended for programmatic consumers such as the Metadata Manager, which will display the findings in a table so a user can review the analysis before exporting an SDK. No CLI or default-run change — consumers call the renderer directly, exactly like the text renderers.

195 tests pass.

@rousso rousso requested a review from yfanti June 16, 2026 19:48
@rousso rousso changed the title Add report banner with SDK and analyser version; drop --verbose; make analyzer-report.txt detail-only Report output improvements and a JSON renderer for the MDM Jun 16, 2026
@rousso rousso merged commit b684b5d into develop Jun 17, 2026
1 check passed
@rousso rousso deleted the feature/report-title-and-hint branch June 17, 2026 08:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants