doctor

package

v0.5.4 Latest Latest Go to latest Published: Aug 16, 2026 License: BSD-3-Clause Imports: 8 Imported by: 0

Details

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

Repository

github.com/flarexes/gitback

Links

Open Source Insights

Documentation ¶

Index ¶

type Check
type Report
- func Generate(layout rt.Layout) (*Report, error)
- func (r *Report) AddCheck(check Check)
- func (r *Report) AddChecks(checks []Check)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Check ¶

type Check struct {
	Name           string `json:"name"`
	Success        bool   `json:"success"`
	Message        string `json:"message,omitempty"`
	Recommendation string `json:"recommendation,omitempty"`
}

Check represents a single diagnostic performed by Doctor.

type Report ¶

type Report struct {
	Checks []Check `json:"checks"`
}

Report contains the complete result of a Doctor run.

func Generate ¶ added in v0.4.7

func Generate(layout rt.Layout) (*Report, error)

Generate runs every diagnostic doctor is able to run given whatever state is currently on disk. Nothing here requires a valid config — a missing or invalid config is reported as a failed check, not a hard error, so the rest of the checks still run and the user gets a full picture of what's wrong in one pass.

func (*Report) AddCheck ¶ added in v0.4.7

func (r *Report) AddCheck(check Check)

AddCheck appends a single diagnostic result to the report.

func (*Report) AddChecks ¶ added in v0.4.7

func (r *Report) AddChecks(checks []Check)

AddChecks appends multiple diagnostic results to the report.

Source Files ¶

View all Source files

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