config

Documentation

Index

• Constants
• Variables
• func BoolCompletion(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)
• func EnvName(name string) string
• func InitLog(w io.Writer, level slog.Level, format LogFormat)
• func LogFormatStrings() []string
• func LogLevelStrings() []string
• func WithContext(ctx context.Context, conf *Config) context.Context
• type Config
  • func FromContext(ctx context.Context) (*Config, bool)
  • func Load(cmd *cobra.Command) (*Config, error)
  • func New() *Config
  • func (c *Config) InitLog(w io.Writer)
  • func (c *Config) RegisterCompletions(cmd *cobra.Command)
  • func (c *Config) RegisterFlags(cmd *cobra.Command)
• type DeprecatedWriter
  • func (d DeprecatedWriter) Write(b []byte) (int, error)
• type LogFormat
  • func LogFormatString(s string) (LogFormat, error)
  • func LogFormatValues() []LogFormat
  • func (i LogFormat) IsALogFormat() bool
  • func (i LogFormat) MarshalText() ([]byte, error)
  • func (i LogFormat) String() string
  • func (i *LogFormat) UnmarshalText(text []byte) error
• type Vars
  • func (vars Vars) Fill(src map[string]string)
  • func (vars Vars) SetNested(v any, k ...string)
  • func (vars Vars) V() any
  • func (vars Vars) Val() any
  • func (vars Vars) Value() any

Constants

const (
	Bash       = "bash"
	Zsh        = "zsh"
	Fish       = "fish"
	Powershell = "powershell"
)

const (
	VarFlag = "var"

	InplaceFlag         = "inplace"
	PrefixFlag          = "prefix"
	LeftDelimFlag       = "left-delim"
	RightDelimFlag      = "right-delim"
	IndentFlag          = "indent"
	StripFlag           = "strip"
	NoSourceCommentFlag = "no-source-comment"

	IgnoreUnsetErrorsFlag    = "ignore-unset-errors"
	IgnoreTemplateErrorsFlag = "ignore-template-errors"

	LogLevelFlag  = "log-level"
	LogFormatFlag = "log-format"

	CompletionFlag = "completion"

	// Deprecated: Replaced by VarFlag
	ValueFlag = "value"
	// Deprecated: Removed. Yampl will always recurse if a given path is a directory
	RecursiveFlag = "recursive"
	// Deprecated: Replaced by IgnoreUnsetErrorsFlag and IgnoreTemplateErrorsFlag
	FailFlag = "fail"
)

const CurrentValueKey = "Value"

CurrentValueKey is the key for the current YAML node's value

deprecated

const EnvPrefix = "YAMPL_"

Variables

var ErrCmdMissingConfig = errors.New("config missing from command context")

Functions

func BoolCompletion

func BoolCompletion(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)

func EnvName

func EnvName(name string) string

func InitLog

func InitLog(w io.Writer, level slog.Level, format LogFormat)

func LogFormatStrings

func LogFormatStrings() []string

LogFormatStrings returns a slice of all String values of the enum

func LogLevelStrings

func LogLevelStrings() []string

func WithContext

func WithContext(ctx context.Context, conf *Config) context.Context

Types

type Config

type Config struct {
	Vars Vars

	Inplace         bool
	Prefix          string
	LeftDelim       string
	RightDelim      string
	Indent          int
	Strip           bool
	NoSourceComment bool

	IgnoreUnsetErrors    bool
	IgnoreTemplateErrors bool

	LogLevel  string
	LogFormat string

	Completion string
	// contains filtered or unexported fields
}

func FromContext

func FromContext(ctx context.Context) (*Config, bool)

func Load

func Load(cmd *cobra.Command) (*Config, error)

func New

func New() *Config

func (*Config) InitLog

func (c *Config) InitLog(w io.Writer)

func (*Config) RegisterCompletions

func (c *Config) RegisterCompletions(cmd *cobra.Command)

func (*Config) RegisterFlags

func (c *Config) RegisterFlags(cmd *cobra.Command)

type DeprecatedWriter

type DeprecatedWriter struct{}

func (DeprecatedWriter) Write

func (d DeprecatedWriter) Write(b []byte) (int, error)

type LogFormat

type LogFormat uint8

const (
	FormatAuto LogFormat = iota
	FormatColor
	FormatPlain
	FormatJSON
)

func LogFormatString

func LogFormatString(s string) (LogFormat, error)

LogFormatString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func LogFormatValues

func LogFormatValues() []LogFormat

LogFormatValues returns all values of the enum

func (LogFormat) IsALogFormat

func (i LogFormat) IsALogFormat() bool

IsALogFormat returns "true" if the value is listed in the enum definition. "false" otherwise

func (LogFormat) MarshalText

func (i LogFormat) MarshalText() ([]byte, error)

MarshalText implements the encoding.TextMarshaler interface for LogFormat

func (LogFormat) String

func (i LogFormat) String() string

func (*LogFormat) UnmarshalText

func (i *LogFormat) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface for LogFormat

type Vars

type Vars map[string]any

func (Vars) Fill

func (vars Vars) Fill(src map[string]string)

func (Vars) SetNested

func (vars Vars) SetNested(v any, k ...string)

func (Vars) V

func (vars Vars) V() any

V returns the current YAML node value

Deprecated: Use `current` template function instead

func (Vars) Val

func (vars Vars) Val() any

Val returns the current YAML node value

Deprecated: Use `current` template function instead

func (Vars) Value

func (vars Vars) Value() any

Value returns the current YAML node value

Deprecated: Use `current` template function instead