doctor

package

v0.1.1 Latest Latest Go to latest Published: Jul 10, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/AxeForging/gauntlet

Links

Open Source Insights

Documentation ¶

Overview ¶

Package doctor runs a set of preflight checks: git state, stack detection, config validity, tool availability. Same output contract as `gauntlet check` — verdict-first, ranked, exit 0/1/2.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Register ¶

func Register(c Check)

Register adds a Check to the global registry.

func Run ¶

func Run(root string) domain.Verdict

Run executes every registered check against `root` and packages results as a domain.Verdict so the same formatter path renders them.

Types ¶

type Check ¶

type Check interface {
	Name() string
	Run(root string) CheckResult
}

Check is the pluggable interface every preflight step satisfies.

func All ¶

func All() []Check

All returns the current registered checks.

type CheckResult ¶

type CheckResult struct {
	Name    string
	Status  CheckStatus
	Message string
	// Fix is a short human-readable next-action if Status != OK.
	Fix string
}

CheckResult is what every Check returns.

type CheckStatus ¶

type CheckStatus int

CheckStatus is the outcome of one preflight check.

const (
	StatusOK CheckStatus = iota
	StatusWarn
	StatusFail
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL