Skip to main content

Crate dev_report

Crate dev_report 

Source
Expand description

§dev-report

Structured, machine-readable reports for AI-assisted Rust development.

dev-report is the foundation schema of the dev-* verification suite. Every other crate in the suite (dev-bench, dev-fixtures, dev-async, dev-stress, dev-chaos) emits results that conform to this schema.

§Why a separate crate

AI agents need decision-grade output. A test runner that prints colored checkmarks to a TTY is unreadable to an agent. dev-report defines a stable, versioned schema that:

  • Serializes to JSON for programmatic consumption
  • Carries enough evidence for an agent to decide accept / reject / retry
  • Keeps verdicts separate from logs so consumers do not have to parse text

§Quick example

use dev_report::{Report, Verdict, Severity, CheckResult};

let mut report = Report::new("my-crate", "0.1.0");
report.push(CheckResult::pass("compile"));
report.push(CheckResult::fail("test_round_trip", Severity::Error)
    .with_detail("expected 42, got 41"));

let verdict = report.overall_verdict();
let json = report.to_json().unwrap();

Structs§

CheckResult
Result of a single check.
Report
A full report. The output of one verification run.

Enums§

Severity
Severity classification when a check fails or warns.
Verdict
Top-level verdict for a check or a whole report.

Traits§

Producer
A producer of reports. Implement this on your harness type to integrate with the dev-* suite.