validation

Documentation

Overview

Package validation provides validation options for the config Validate method.

Index

• type Option
  • func WithLocal() Option
  • func WithStrict() Option
• type Options
  • func NewOptions(options ...Option) *Options
• type RuntimeMode

Types

type Option

type Option func(opts *Options)

Option represents an additional validation parameter for the config Validate method.

func WithLocal

func WithLocal() Option

WithLocal enables local flag.

func WithStrict

func WithStrict() Option

WithStrict enables strict flag.

type Options

type Options struct {
	// Local should disable part of the validation flow which won't work on the host machine.
	Local bool
	// Strict mode returns warnings as errors.
	Strict bool
}

Options additional validation parameters for the config Validate method.

func NewOptions

func NewOptions(options ...Option) *Options

NewOptions creates new validation options.

type RuntimeMode

type RuntimeMode interface {
	fmt.Stringer
	RequiresInstall() bool
}

RuntimeMode abstracts current runtime mode.