printer

Documentation

Index

• Variables
• func GetFileNameText(title string) string
• type EvaluationSummary
• type ExtraMessage
• type FailedRule
• type InvalidK8sInfo
• type InvalidYamlInfo
• type JSONSchemaValidatorResults
• type OccurrenceDetails
• type Printer
  • func CreateNewPrinter() *Printer
  • func (p *Printer) GetEvaluationSummaryText(summary EvaluationSummary, k8sVersion string) string
  • func (p *Printer) GetSummaryTableText(summary Summary) string
  • func (p *Printer) GetTextInColor(text string, color *color.Color) string
  • func (p *Printer) GetTitleText(title string) string
  • func (p *Printer) GetWarningsText(warnings []Warning, quiet bool) string
  • func (p *Printer) GetYamlValidationErrorsText(yamlValidationErrors []error) string
  • func (p *Printer) GetYamlValidationSummaryText(passedFiles int, allFiles int) string
  • func (p *Printer) PrintError(messageText string, messageColor string)
  • func (p *Printer) PrintMessage(messageText string, messageColor string)
  • func (p *Printer) PrintPromptMessage(promptMessage string)
  • func (p *Printer) PrintYamlSchemaResults(errorsResult []jsonschema.Detailed, error error)
  • func (p *Printer) SetTheme(theme *Theme)
• type Summary
• type SummaryItem
• type Theme
  • func CreateSimpleTheme() *Theme
• type Warning

Variables

var StdErr = color.Error

var StdOut = color.Output

Functions

func GetFileNameText

func GetFileNameText(title string) string

Types

type EvaluationSummary

type EvaluationSummary struct {
	ConfigsCount              int
	RulesCount                int
	FilesCount                int
	PassedYamlValidationCount int
	K8sValidation             string
	PassedPolicyCheckCount    int
}

type ExtraMessage

type ExtraMessage struct {
	Text  string
	Color string
}

type FailedRule

type FailedRule struct {
	Name               string
	Occurrences        int
	Suggestion         string
	DocumentationUrl   string
	OccurrencesDetails []OccurrenceDetails
}

type InvalidK8sInfo

type InvalidK8sInfo struct {
	ValidationErrors  []error
	ValidationWarning string
	K8sVersion        string
}

type InvalidYamlInfo

type InvalidYamlInfo struct {
	ValidationErrors []error
}

type JSONSchemaValidatorResults

type JSONSchemaValidatorResults = gojsonschema.Result

type OccurrenceDetails

type OccurrenceDetails struct {
	MetadataName              string
	Kind                      string
	SkipMessage               string
	FailureLocations          []cliClient.FailureLocation
	ValidationFailureMessages []string
}

type Printer

type Printer struct {
	Theme *Theme
}

func CreateNewPrinter

func CreateNewPrinter() *Printer

func (*Printer) GetEvaluationSummaryText

func (p *Printer) GetEvaluationSummaryText(summary EvaluationSummary, k8sVersion string) string

func (*Printer) GetSummaryTableText

func (p *Printer) GetSummaryTableText(summary Summary) string

func (*Printer) GetTextInColor

func (p *Printer) GetTextInColor(text string, color *color.Color) string

func (*Printer) GetTitleText

func (p *Printer) GetTitleText(title string) string

func (*Printer) GetWarningsText

func (p *Printer) GetWarningsText(warnings []Warning, quiet bool) string

func (*Printer) GetYamlValidationErrorsText

func (p *Printer) GetYamlValidationErrorsText(yamlValidationErrors []error) string

func (*Printer) GetYamlValidationSummaryText

func (p *Printer) GetYamlValidationSummaryText(passedFiles int, allFiles int) string

func (*Printer) PrintError

func (p *Printer) PrintError(messageText string, messageColor string)

func (*Printer) PrintMessage

func (p *Printer) PrintMessage(messageText string, messageColor string)

func (*Printer) PrintPromptMessage

func (p *Printer) PrintPromptMessage(promptMessage string)

func (*Printer) PrintYamlSchemaResults

func (p *Printer) PrintYamlSchemaResults(errorsResult []jsonschema.Detailed, error error)

func (*Printer) SetTheme

func (p *Printer) SetTheme(theme *Theme)

type Summary

type Summary struct {
	PlainRows  []SummaryItem
	SkipRow    SummaryItem
	ErrorRow   SummaryItem
	SuccessRow SummaryItem
}

type SummaryItem

type SummaryItem struct {
	RightCol string
	LeftCol  string
	RowIndex int
}

type Theme

type Theme struct {
	Name   string
	Colors struct {
		Green     *color.Color
		Yellow    *color.Color
		RedBold   *color.Color
		Error     *color.Color
		Highlight *color.Color
		Cyan      *color.Color
		CyanBold  *color.Color
	}
	ColorsAttributes struct {
		Cyan  color.Attribute
		Green color.Attribute
		Red   color.Attribute
	}
	Spacing struct {
		Default string
	}
	Emoji struct {
		Error      string
		Suggestion string
		Skip       string
	}
}

func CreateSimpleTheme

func CreateSimpleTheme() *Theme

type Warning

type Warning struct {
	Title           string
	FailedRules     []FailedRule
	SkippedRules    []FailedRule
	InvalidYamlInfo InvalidYamlInfo
	InvalidK8sInfo  InvalidK8sInfo
	ExtraMessages   []ExtraMessage
}