lint

Documentation

Overview

Package lint contains tools for linting charts.

Linting is the process of testing charts for errors or warnings regarding formatting, compilation, or standards compliance.

Index

• Constants
• type Message
  • func All(basedir string) []Message
  • func Chartfile(basepath string) (m []Message)
  • func Templates(basepath string) (messages []Message)
  • func Values(basepath string) (messages []Message)
  • func (m Message) String() string
• type Severity

Constants

const (
	// UnknownSev indicates that the severity of the error is unknown, and should not stop processing.
	UnknownSev = iota
	// InfoSev indicates information, for example missing values.toml file
	InfoSev
	// WarningSev indicates that something does not meet code standards, but will likely function.
	WarningSev
	// ErrorSev indicates that something will not likely function.
	ErrorSev
)

Types

type Message

type Message struct {
	// Severity is one of the *Sev constants
	Severity int
	// Text contains the message text
	Text string
}

Message is a linting output message

func All

func All(basedir string) []Message

All runs all of the available linters on the given base directory.

func Chartfile

func Chartfile(basepath string) (m []Message)

Chartfile checks the Chart.yaml file for errors and warnings.

func Templates

func Templates(basepath string) (messages []Message)

Templates lints a chart's templates.

func Values

func Values(basepath string) (messages []Message)

Values lints a chart's values.toml file.

func (Message) String

func (m Message) String() string

String prints a string representation of this Message.

Implements fmt.Stringer.

type Severity

type Severity int

Severity indicatest the severity of a Message.