cmd

Documentation

Index

• Variables
• func BuildResults(rulesetFlag string, specBytes []byte, ...) (*model.RuleResultSet, *motor.RuleSetExecutionResult, error)
• func BuildResultsWithDocCheckSkip(rulesetFlag string, specBytes []byte, ...) (*model.RuleResultSet, *motor.RuleSetExecutionResult, error)
• func BuildRuleSetFromUserSuppliedSet(rsBytes []byte, rs rulesets.RuleSets) (*rulesets.RuleSet, error)
• func CheckFailureSeverity(failSeverityFlag string, errors int, warnings int, informs int) error
• func Execute(version, commit, date string)
• func GetDashboardCommand() *cobra.Command
• func GetGenerateRulesetCommand() *cobra.Command
• func GetHTMLReportCommand() *cobra.Command
• func GetLintCommand() *cobra.Command
• func GetRootCommand() *cobra.Command
• func GetSpectralReportCommand() *cobra.Command
• func GetVacuumReportCommand() *cobra.Command
• func LoadCustomFunctions(functionsFlag string) (map[string]model.RuleFunction, error)
• func PrintBanner()
• func RenderSummary(rs *model.RuleResultSet, silent bool, totalFiles, fileIndex int, ...)
• func RenderTime(timeFlag bool, duration time.Duration, fi int64)
• func RenderTimeAndFiles(timeFlag bool, duration time.Duration, fileSize int64, totalFiles int)

Variables

var (
	Version string
	Commit  string
	Date    string
)

TODO: This is a temporary UI, it's to help figure out the best experience, and it is not intended as a final face of vacuum. It's going to change around a good bit, so don't get too comfy with it :)

Functions

func BuildResults

func BuildResults(
	rulesetFlag string,
	specBytes []byte,
	customFunctions map[string]model.RuleFunction,
	base string) (*model.RuleResultSet, *motor.RuleSetExecutionResult, error)

func BuildResultsWithDocCheckSkip

func BuildResultsWithDocCheckSkip(
	rulesetFlag string,
	specBytes []byte,
	customFunctions map[string]model.RuleFunction,
	base string,
	skipCheck bool) (*model.RuleResultSet, *motor.RuleSetExecutionResult, error)

func BuildRuleSetFromUserSuppliedSet

func BuildRuleSetFromUserSuppliedSet(rsBytes []byte, rs rulesets.RuleSets) (*rulesets.RuleSet, error)

BuildRuleSetFromUserSuppliedSet creates a ready to run ruleset, augmented or provided by a user configured ruleset. This ruleset could be lifted directly from a Spectral configuration.

func CheckFailureSeverity

func CheckFailureSeverity(failSeverityFlag string, errors int, warnings int, informs int) error

func Execute

func Execute(version, commit, date string)

func GetDashboardCommand

func GetDashboardCommand() *cobra.Command

func GetGenerateRulesetCommand

func GetGenerateRulesetCommand() *cobra.Command

func GetHTMLReportCommand

func GetHTMLReportCommand() *cobra.Command

GetHTMLReportCommand returns a cobra command for generating an HTML Report.

func GetLintCommand

func GetLintCommand() *cobra.Command

func GetRootCommand

func GetRootCommand() *cobra.Command

func GetSpectralReportCommand

func GetSpectralReportCommand() *cobra.Command

func GetVacuumReportCommand

func GetVacuumReportCommand() *cobra.Command

func LoadCustomFunctions

func LoadCustomFunctions(functionsFlag string) (map[string]model.RuleFunction, error)

LoadCustomFunctions will scan for (and load) custom functions defined as vacuum plugins.

func PrintBanner

func PrintBanner()

func RenderSummary

func RenderSummary(rs *model.RuleResultSet, silent bool, totalFiles, fileIndex int, filename, sev string)

func RenderTime

func RenderTime(timeFlag bool, duration time.Duration, fi int64)

RenderTime will render out the time taken to process a specification, and the size of the file in kb.

func RenderTimeAndFiles

func RenderTimeAndFiles(timeFlag bool, duration time.Duration, fileSize int64, totalFiles int)

RenderTimeAndFiles will render out the time taken to process a specification, and the size of the file in kb. it will also render out how many files were processed.