Documentation
¶
Overview ¶
Package doctor provides health checks for certify setup and environment.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FormatOnboardPlan ¶
func FormatOnboardPlan(plan *OnboardPlan) string
FormatOnboardPlan renders the plan as a human-readable string.
func FormatReport ¶
FormatReport renders the report as a human-readable string.
Types ¶
type Check ¶
type Check struct {
Name string
Group string
Status CheckStatus
Message string
Fix string // suggested fix command or action
}
Check represents a single health check result.
type CheckStatus ¶
type CheckStatus int
CheckStatus represents the result of a single health check.
const ( StatusPass CheckStatus = iota StatusWarn StatusFail StatusSkip )
func (CheckStatus) String ¶
func (s CheckStatus) String() string
type OnboardPlan ¶
type OnboardPlan struct {
Steps []OnboardStep
Root string
}
OnboardPlan holds the full onboarding plan for a project.
func BuildOnboardPlan ¶
func BuildOnboardPlan(root string) *OnboardPlan
BuildOnboardPlan creates an onboarding plan by checking what's already done.
func (*OnboardPlan) AllDone ¶
func (p *OnboardPlan) AllDone() bool
AllDone returns true if every step is done.
func (*OnboardPlan) NextStep ¶
func (p *OnboardPlan) NextStep() *OnboardStep
NextStep returns the first step that is Ready or Pending, or nil if all done.
type OnboardStatus ¶
type OnboardStatus int
OnboardStatus represents whether a step is done.
const ( OnboardPending OnboardStatus = iota OnboardDone OnboardReady // dependencies met, ready to run )
func (OnboardStatus) Emoji ¶
func (s OnboardStatus) Emoji() string
type OnboardStep ¶
type OnboardStep struct {
Number int
Title string
Description string
Command string // command to run (empty = informational)
Status OnboardStatus // computed from filesystem
Detail string // additional context
}
OnboardStep represents a single onboarding step.
Source Files
Click to show internal directories.
Click to hide internal directories.