runner

Documentation

Overview

Package runner provides the check execution engine for the pre-commit system

Index

• type CheckResult
• type Options
• type ProgressCallback
• type Results
• type Runner
  • func New(cfg *config.Config, repoRoot string) *Runner
  • func (r *Runner) Run(ctx context.Context, opts Options) (*Results, error)

Types

type CheckResult

type CheckResult struct {
	Name       string
	Success    bool
	Error      string
	Output     string
	Duration   time.Duration
	Files      []string
	Suggestion string
	CanSkip    bool
	Command    string
}

CheckResult contains the result of a single check

type Options

type Options struct {
	Files               []string
	OnlyChecks          []string
	SkipChecks          []string
	Parallel            int
	FailFast            bool
	ProgressCallback    ProgressCallback
	GracefulDegradation bool
}

Options configures a check run

type ProgressCallback

type ProgressCallback func(checkName, status string)

ProgressCallback is called during check execution for progress updates

type Results

type Results struct {
	CheckResults  []CheckResult
	Passed        int
	Failed        int
	Skipped       int
	TotalDuration time.Duration
	TotalFiles    int
}

Results contains the results of a check run

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

Runner executes pre-commit checks

func New

func New(cfg *config.Config, repoRoot string) *Runner

New creates a new Runner

func (*Runner) Run

func (r *Runner) Run(ctx context.Context, opts Options) (*Results, error)

Run executes checks based on the provided options