Documentation
¶
Overview ¶
Package lint contains functions for verifying yaml files are valid
Index ¶
Constants ¶
View Source
const ( SevErr = "Error" SevWarn = "Warning" )
Severity definitions.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type LintError ¶
type LintError struct {
PackageName string
Findings []PackageFinding
}
LintError represents an error containing lint findings.
func (*LintError) OnlyWarnings ¶
OnlyWarnings returns true if all findings have severity warning.
type PackageFinding ¶
type PackageFinding struct {
// YqPath is the path to the key where the error originated from, this is sometimes empty in the case of a general error
YqPath string
Description string
// Item is the value of a key that is causing an error, for example a bad image name
Item string
// Severity of finding.
Severity Severity
}
PackageFinding is a struct that contains a finding about something wrong with a package
func (PackageFinding) ItemizedDescription ¶
func (f PackageFinding) ItemizedDescription() string
ItemizedDescription returns a string with the description and item if finding contains one.
Source Files
Click to show internal directories.
Click to hide internal directories.