config

Documentation

Index

• Constants
• func BoolCompletion(_ *cobra.Command, _ []string, _ string) ([]string, cobra.ShellCompDirective)
• func EnvName(name string) string
• func WithContext(ctx context.Context, conf *Config) context.Context
• type Config
  • func FromContext(ctx context.Context) (*Config, bool)
  • func New() *Config
  • func (c *Config) Load(cmd *cobra.Command) error
  • 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 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"

	Auto  = "auto"
	Color = "color"
	Plain = "plain"
	JSON  = "json"
)

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_"

Functions

func BoolCompletion

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

func EnvName

func EnvName(name string) 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 New

func New() *Config

func (*Config) Load

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

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 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