feat: JSON report output (#3)#5
Merged
Merged
Conversation
Reframe the roadmap v0.2 section around the milestone issues with a recommended order (JSON output first, then aliases, multi-sheet, and YAML-driven rules as a stretch). Mark v0.1.0 as released. No behaviour change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add a machine-readable report alongside Markdown. Markdown stays the default; `--format json` writes JSON with metadata (tool, version, UTC timestamp, format), inputs, verdict, score, a summary (counts by severity and by finding type) and the full findings list (findings expose `severity`). No change to validation logic, scoring, matching, finding types or Markdown output. Adds 5 tests (md default, json on request, parseable, metadata shape, expected finding types + summary consistency, clean-case empty). ruff + pytest green. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements #3 — JSON report output.
What changed
--format md|jsonoption onqdv pfmea-control-plan(Markdown is the default; existing behaviour unchanged).core/report.py:build_report_data()/render_json()/write_json().JSON shape
metadata(tool, version, UTC ISO-8601 timestamp, format),inputs,verdict,score,summary(counts by severity and by finding type), and the fullfindingslist (each: type, severity, operation_id, message).Out of scope (unchanged)
Validation logic, scoring, matching, finding types, Markdown output. No CSV/UI/AI.
Checklist
--formatflag + JSON serialisationjson.loads, metadata shape, finding types + summary consistency, clean-case score 100 / empty)ruff+pytestgreen (28 tests)Closes #3 when merged.