run

Documentation

Index

• type CheckStatus
• type Result
  • func Run(lintCtxs []lintcontext.LintContext, registry checkregistry.CheckRegistry, ...) (Result, error)
• type Summary

Types

type CheckStatus

type CheckStatus string

CheckStatus is enum type.

const (
	// ChecksPassed means no lint errors found.
	ChecksPassed CheckStatus = "Passed"
	// ChecksFailed means lint errors were found.
	ChecksFailed CheckStatus = "Failed"
)

type Result

type Result struct {
	Checks  []config.Check
	Reports []diagnostic.WithContext
	Summary Summary
}

Result represents the result from a run of the linter.

func Run

func Run(lintCtxs []lintcontext.LintContext, registry checkregistry.CheckRegistry, checks []string) (Result, error)

Run runs the linter on the given context, with the given config.

type Summary

type Summary struct {
	ChecksStatus      CheckStatus
	CheckEndTime      time.Time
	KubeLinterVersion string
}

Summary holds information about the linter run overall.