lint

Documentation

Overview

Package lint contains functions for verifying zarf yaml files are valid

Package lint contains functions for verifying zarf yaml files are valid

Index

• Variables
• type Validator
  • func Validate(ctx context.Context, createOpts types.ZarfCreateOptions) (*Validator, error)
  • func (v Validator) DisplayFormattedMessage()
  • func (v Validator) IsSuccess() bool

Variables

var ZarfSchema embed.FS

ZarfSchema is exported so main.go can embed the schema file

Types

type Validator

type Validator struct {
	// contains filtered or unexported fields
}

Validator holds the warnings/errors and messaging that we get from validation

func Validate

func Validate(ctx context.Context, createOpts types.ZarfCreateOptions) (*Validator, error)

Validate validates a zarf file against the zarf schema, returns *validator with warnings or errors if they exist along with an error if the validation itself failed

func (Validator) DisplayFormattedMessage

func (v Validator) DisplayFormattedMessage()

DisplayFormattedMessage message sent to user based on validator results

func (Validator) IsSuccess

func (v Validator) IsSuccess() bool

IsSuccess returns true if there are not any errors