report

Documentation

Index

• Constants
• func HasFailures(s Summary) bool
• func PassLabel() string
• type Finding
  • func UniqueFindings(findings []Finding) []Finding
• type Result
• type Score
  • func ComputeScore(res Result) Score
• type Severity
  • func (s Severity) LegacySeverity() string
• type Summary
  • func BuildSummary(findings []Finding) Summary

Constants

const JSONSchemaVersion = "1"

JSONSchemaVersion is the current JSON output schema version. Increment when making breaking changes to the JSON output format.

Functions

func HasFailures

func HasFailures(s Summary) bool

HasFailures returns true when errors or critical findings exist.

func PassLabel

func PassLabel() string

PassLabel returns PASS when severity is info-only success marker.

Types

type Finding

type Finding struct {
	ID          string   `json:"id"`
	Name        string   `json:"name,omitempty"`
	Category    string   `json:"category"`
	Severity    Severity `json:"severity"`
	File        string   `json:"file,omitempty"`
	Line        int      `json:"line,omitempty"`
	Column      int      `json:"column,omitempty"`
	Message     string   `json:"message"`
	Explanation string   `json:"explanation,omitempty"`
	Suggestion  string   `json:"suggestion,omitempty"`
}

Finding is a single diagnostic from any ForgeKit command.

func UniqueFindings

func UniqueFindings(findings []Finding) []Finding

UniqueFindings removes duplicate findings while preserving order.

type Result

type Result struct {
	SchemaVersion string    `json:"schema_version"`
	Tool          string    `json:"tool"`
	Version       string    `json:"version"`
	Command       string    `json:"command"`
	Project       string    `json:"project,omitempty"`
	Timestamp     time.Time `json:"timestamp"`
	Summary       Summary   `json:"summary"`
	Findings      []Finding `json:"findings"`
}

Result is the stable JSON schema for machine-readable output. Used by analyze, doctor, check commands.

type Score

type Score struct {
	Categories map[string]int `json:"categories"`
	Global     int            `json:"global"`
	Notes      []string       `json:"notes,omitempty"`
}

Score represents per-category scoring and global score.

func ComputeScore

func ComputeScore(res Result) Score

ComputeScore computes simple category scores based on findings and project files. It uses deterministic rules and avoids magic numbers scattered in code.

type Severity

type Severity string

Severity levels shared by doctor, analyze and check.

const (
	SeverityInfo     Severity = "info"
	SeverityWarning  Severity = "warning"
	SeverityError    Severity = "error"
	SeverityCritical Severity = "critical"
)

func (Severity) LegacySeverity

func (s Severity) LegacySeverity() string

LegacySeverity maps to PASS/WARNING/ERROR/INFO display labels.

type Summary

type Summary struct {
	Pass     int `json:"pass"`
	Info     int `json:"info"`
	Warning  int `json:"warning"`
	Error    int `json:"error"`
	Critical int `json:"critical"`
}

func BuildSummary

func BuildSummary(findings []Finding) Summary

BuildSummary counts findings by severity.