expand

README

expand

expand package provides convenient functions to apply func os.Expand efficiently.

Import

import "github.com/k1LoW/expand"

Usage

c := &Config{}
p := "config.yml"
buf, err := os.ReadFile(p)
if err != nil {
    return err
}
if err := yaml.Unmarshal(expand.ExpandenvYAMLBytes(buf), c); err != nil {
    return err
}

Documentation

Index

• func ExpandYAML(s string, mapping func(string) (string, bool)) string
• func ExpandYAMLBytes(b []byte, mapping func(string) (string, bool)) []byte
• func ExpandenvYAML(s string) string
• func ExpandenvYAMLBytes(b []byte) []byte
• func ExprRepFn(delimStart, delimEnd string, env any) repFn
• func InterpolateRepFn(mapping func(string) (string, bool)) repFn
• func ReplaceYAML(s string, repFn func(s string) (string, error), opts ...Option) (string, error)
• type Mapper
  • func (m Mapper) Get(key string) (string, bool)
• type Option
  • func QuoteCollection() Option
  • func ReplaceMapKey() Option

Functions

func ExpandYAML

func ExpandYAML(s string, mapping func(string) (string, bool)) string

ExpandYAML replaces ${var} or $var in the values of YAML (string) based on the mapping function.

func ExpandYAMLBytes

func ExpandYAMLBytes(b []byte, mapping func(string) (string, bool)) []byte

ExpandYAML replaces ${var} or $var in the values of YAML ([]byte) based on the mapping function.

func ExpandenvYAML

func ExpandenvYAML(s string) string

ExpandenvYAML replaces ${var} or $var in the values of YAML (string) according to the values of the current environment variables.

func ExpandenvYAMLBytes

func ExpandenvYAMLBytes(b []byte) []byte

ExpandenvYAML replaces ${var} or $var in the values of YAML ([]byte) according to the values of the current environment variables.

func ExprRepFn

func ExprRepFn(delimStart, delimEnd string, env any) repFn

func InterpolateRepFn

func InterpolateRepFn(mapping func(string) (string, bool)) repFn

func ReplaceYAML

func ReplaceYAML(s string, repFn func(s string) (string, error), opts ...Option) (string, error)

ReplaceYAML replaces the tokens of YAML (string) using repFn.

Types

type Mapper

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

func (Mapper) Get

func (m Mapper) Get(key string) (string, bool)

type Option

type Option func(*config) error

func QuoteCollection

func QuoteCollection() Option

QuoteCollection - Quotes the replaced value as a string if it is a map or slice.

func ReplaceMapKey

func ReplaceMapKey() Option

ReplaceMapKey - Replace map key of YAML.