checks

Documentation

Index

• type Checker
  • func GetChecker(cmd amalgomated.Cmd) (Checker, error)

Types

type Checker

type Checker interface {
	// Cmd returns the command represented by this checker
	Cmd() amalgomated.Cmd

	// Check runs the current checker on "all" packages using the provided configuration and returns the output. The
	// provided Cmder is used to invoke the check. "rootDir" is used as the root directory to determine the packages
	// that the checker is run on. Conceptually, this method uses "config" and "rootDir" to generate the arguments
	// required to check "all" packages (excluding any that the config specifies should be excluded), invokes the
	// Cmder using those arguments in the given working directory, and returns the filtered output.
	Check(runner amalgomated.Cmder, rootDir string, config params.OKGo) ([]checkoutput.Issue, error)

	// CheckPackages runs the current checker on the specified packages using the provided configuration and returns
	// the output. The provided Cmder is used to invoke the check. The root directory contained in the "packages"
	// parameter is used as the working directory of the Cmder. Conceptually, this method uses "config" and
	// "packages" to generate the arguments required to check the specified packages (excluding any that the config
	// specifies should be excluded), invokes the Cmder using those arguments in the given working directory, and
	// returns the filtered output.
	CheckPackages(runner amalgomated.Cmder, packages pkgpath.Packages, config params.OKGo) ([]checkoutput.Issue, error)
}

func GetChecker

func GetChecker(cmd amalgomated.Cmd) (Checker, error)