doctor

Documentation

Overview

Package doctor aggregates safe project health checks.

Index

• type Certainty
• type Finding
• type FixClass
• type Remediation
• type Report
  • func Inspect(project *projectmodel.Project, filesystem fsx.FS) Report

Types

type Certainty

type Certainty string

const (
	Confirmed Certainty = "confirmed"
	Inferred  Certainty = "inferred"
	Heuristic Certainty = "heuristic"
)

type Finding

type Finding struct {
	ID          string       `json:"id"`
	Severity    string       `json:"severity"`
	Certainty   Certainty    `json:"certainty"`
	Source      string       `json:"source"`
	Path        string       `json:"path,omitempty"`
	Message     string       `json:"message"`
	Remediation *Remediation `json:"remediation,omitempty"`
}

type FixClass

type FixClass string

const (
	FixSafe   FixClass = "safe"
	FixReview FixClass = "review-required"
)

type Remediation

type Remediation struct {
	Class   FixClass `json:"class"`
	Command string   `json:"command,omitempty"`
	Message string   `json:"message"`
}

type Report

type Report struct {
	SchemaVersion int       `json:"schemaVersion"`
	Findings      []Finding `json:"findings"`
}

func Inspect

func Inspect(project *projectmodel.Project, filesystem fsx.FS) Report