checkcmd

package

v0.0.15 Latest Latest Go to latest Published: Aug 18, 2026 License: MIT Imports: 10 Imported by: 0

Details

This section is empty.

This section is empty.

func ConfigPath(repoRoot string) string

ConfigPath returns the expected check config file path for a repo.

func FailedStepName(results []StepResult) string

FailedStepName returns the first step that failed (not skipped).

func FormatFailureSummary(results []StepResult, runErr error) string

FormatFailureSummary builds a readable failure summary for CLI output.

func InitConfigTemplate(repoRoot string) (string, error)

InitConfigTemplate writes `.fastgit/check.yaml` when missing.

func New() *redant.Command

New creates the check command group.

type Config struct {
	Steps []Step
}

Config holds check pipeline configuration.

func DefaultConfig() Config

DefaultConfig returns the built-in pipeline for Go projects.

func ForCommit(cfg *Config) *Config

ForCommit returns a lighter pipeline for the commit flow (skips test step).

func LoadConfig(repoRoot string) *Config

LoadConfig loads `.fastgit/check.yaml`. Returns nil Config if the file does not exist.

type RunOptions struct {
	StagedOnly bool
	Fix        bool
	DryRun     bool
	RepoRoot   string
}

RunOptions controls check execution.

type Step struct {
	Name        string
	Command     string
	FixCommand  string
	Fixable     bool
	Optional    bool
	Description string
}

Step defines one quality gate step.

type StepResult struct {
	Step    Step
	Skipped bool
	Reason  string
	Err     error
	Output  string
}

StepResult holds the outcome of one step.

func Run(ctx context.Context, cfg Config, opts RunOptions) ([]StepResult, error)

Run executes the check pipeline.