config

Documentation

Index

• type ChecksConfig
• type Config
  • func Load(path string) (Config, error)

Types

type ChecksConfig

type ChecksConfig struct {
	// AddAllBuiltIn, if set, adds all built-in checks. This allows users to
	// explicitly opt-out of checks that are not relevant using Exclude.
	AddAllBuiltIn bool `json:"addAllBuiltIn"`
	// DoNotAutoAddDefaults, if set, prevents the automatic addition of default checks.
	DoNotAutoAddDefaults bool `json:"doNotAutoAddDefaults"`
	// Exclude is a list of check names to exclude.
	Exclude []string `json:"exclude"`
	// Include is a list of check names to include. If a check is in both Include and Exclude,
	// Exclude wins.
	Include []string `json:"include"`
}

ChecksConfig is the config that determines which checks to run.

type Config

type Config struct {
	CustomChecks []check.Check `json:"customChecks,omitempty"`
	Checks       ChecksConfig  `json:"checks,omitempty"`
}

Config represents the config file format.

func Load

func Load(path string) (Config, error)

Load loads the config from the given path.