cfgutil

Documentation

Index

• func AppendUnique(list []string, item string) []string
• func Bool(cfg map[string]any, key string, fallback bool) bool
• func CamelAlias(snake string) string
• func DefaultsFromFields(raw []byte) (map[string]any, error)
• func FieldNames(raw []byte) ([]string, error)
• func Float(cfg map[string]any, key string, fallback float64) float64
• func Int(cfg map[string]any, key string, fallback int) int
• func ResolveAliases(defaults, userCfg map[string]any) (map[string]any, []string)
• func String(cfg map[string]any, key, fallback string) string
• func StringSlice(cfg map[string]any, key string) []string
• type Field
  • func ParseFields(raw []byte) ([]Field, error)
• type Option

Functions

func AppendUnique

func AppendUnique(list []string, item string) []string

AppendUnique appends item to list only if it is not already present.

func Bool

func Bool(cfg map[string]any, key string, fallback bool) bool

Bool reads a bool from a plugin config map with a fallback default.

func CamelAlias

func CamelAlias(snake string) string

CamelAlias returns the deprecated camelCase spelling of a snake_case config key (show_tooltip -> showTooltip), or "" when the key contains no underscore and therefore has no distinct alias.

func DefaultsFromFields

func DefaultsFromFields(raw []byte) (map[string]any, error)

DefaultsFromFields extracts the default values from blueprint-style YAML of the shape fields: {name: {type, label, hint, default, min, max}}. Shared by the clientplugins manifest defaults and external plugin blueprints.

func FieldNames

func FieldNames(raw []byte) ([]string, error)

FieldNames extracts every declared field name from blueprint-style YAML, sorted. Unlike DefaultsFromFields it includes fields that declare no default, so key validation does not treat a default-less field as unknown.

func Float

func Float(cfg map[string]any, key string, fallback float64) float64

Float reads a float64 from a plugin config map with a fallback default.

func Int

func Int(cfg map[string]any, key string, fallback int) int

Int reads an int from a plugin config map with a fallback default.

func ResolveAliases

func ResolveAliases(defaults, userCfg map[string]any) (map[string]any, []string)

ResolveAliases re-keys deprecated camelCase spellings in userCfg to their canonical snake_case names, taken from the keys of defaults. When both spellings are present the canonical one wins; the alias is still reported in used. Keys that are neither canonical nor a known alias pass through unchanged. used is sorted for deterministic output.

func String

func String(cfg map[string]any, key, fallback string) string

String reads a string from a plugin config map with a fallback default.

func StringSlice

func StringSlice(cfg map[string]any, key string) []string

StringSlice reads a string slice from a plugin config map.

Types

type Field

type Field struct {
	Name    string   `json:"name"`
	Type    string   `json:"type"`
	Label   string   `json:"label"`
	Hint    string   `json:"hint,omitempty"`
	Default any      `json:"default"`
	Min     *float64 `json:"min,omitempty"`
	Max     *float64 `json:"max,omitempty"`
	Options []Option `json:"options,omitempty"`
	Fields  []Field  `json:"fields,omitempty"`
}

Field is the typed form of one blueprint entry, preserving every key the YAML may declare so catalogs can publish it verbatim.

func ParseFields

func ParseFields(raw []byte) ([]Field, error)

ParseFields decodes blueprint-style YAML into typed fields sorted by name. An empty document yields an empty, non-nil slice.

type Option

type Option struct {
	Value any    `json:"value" yaml:"value"`
	Label string `json:"label" yaml:"label"`
}

Option is one choice of a select-typed field.