report

Documentation

Index

• Constants
• func WriteVerificationReport(path string, report VerificationReport) error
• type RuleResult
• type Summary
• type VerificationReport
  • func NewVerificationReport(design *ir.DesignIR) VerificationReport

Constants

const SchemaVersion = "0"

Functions

func WriteVerificationReport

func WriteVerificationReport(path string, report VerificationReport) error

WriteVerificationReport writes report JSON to a file with stable formatting.

Types

type RuleResult

type RuleResult struct {
	ID       string `json:"id"`
	Severity string `json:"severity"`
	Message  string `json:"message"`
}

RuleResult is reserved for deterministic verification rules over DesignIR.

type Summary

type Summary struct {
	Source             string   `json:"source"`
	InputFile          string   `json:"input_file"`
	Parts              int      `json:"parts"`
	Rules              int      `json:"rules"`
	HasFailures        bool     `json:"has_failures"`
	Delimiter          string   `json:"delimiter,omitempty"`
	ParseErrorsCount   int      `json:"parse_errors_count"`
	ParseWarningsCount int      `json:"parse_warnings_count"`
	ParseErrors        []string `json:"parse_errors"`
	ParseWarnings      []string `json:"parse_warnings"`
	NextSteps          []string `json:"next_steps,omitempty"`
	Nets               int      `json:"nets,omitempty"`
}

type VerificationReport

type VerificationReport struct {
	ReportVersion string       `json:"report_version"`
	Summary       Summary      `json:"summary"`
	DesignIR      *ir.DesignIR `json:"design_ir"`
	Rules         []RuleResult `json:"rules"`
}

VerificationReport is the output schema for BOM scan results.

func NewVerificationReport

func NewVerificationReport(design *ir.DesignIR) VerificationReport

NewVerificationReport builds the deterministic JSON payload for scan.