score

Documentation

Index

• func RegisterAllChecks(allObjects ks.AllTypes, checksConfig *checks.Config, ...) *checks.Checks
• func Score(allObjects ks.AllTypes, allChecks *checks.Checks, ...) (*scorecard.Scorecard, error)

Functions

func RegisterAllChecks

func RegisterAllChecks(
	allObjects ks.AllTypes,
	checksConfig *checks.Config,
	runConfig *config.RunConfiguration,
) *checks.Checks

func Score

func Score(
	allObjects ks.AllTypes,
	allChecks *checks.Checks,
	runConfig *config.RunConfiguration,
) (*scorecard.Scorecard, error)

Score runs a pre-configured list of tests against the files defined in the configuration, and returns a scorecard. Additional configuration and tuning parameters can be provided via the config.