yamlpatch

Documentation

Index

• func IsMapping(i interface{}) bool
• func IsScalar(i interface{}) bool
• func IsSequence(i interface{}) bool
• func YAML(sources [][]byte, strict bool) (*bytes.Buffer, error)
• type Patcher
  • func NewPatcher(filePath string, suffix string) *Patcher
  • func (p *Patcher) MergedPatchContent() ([]byte, error)
  • func (p *Patcher) PrependedPatchContent() ([]byte, error)

Functions

func IsMapping

func IsMapping(i interface{}) bool

IsMapping reports whether a type is a mapping in YAML, represented as a map[interface{}]interface{}.

func IsScalar

func IsScalar(i interface{}) bool

IsScalar reports whether a type is a scalar value in YAML.

func IsSequence

func IsSequence(i interface{}) bool

IsSequence reports whether a type is a sequence in YAML, represented as an []interface{}.

func YAML

func YAML(sources [][]byte, strict bool) (*bytes.Buffer, error)

YAML deep-merges any number of YAML sources, with later sources taking priority over earlier ones.

Maps are deep-merged. For example,

{"one": 1, "two": 2} + {"one": 42, "three": 3}
== {"one": 42, "two": 2, "three": 3}

Sequences are replaced. For example,

{"foo": [1, 2, 3]} + {"foo": [4, 5, 6]}
== {"foo": [4, 5, 6]}

In non-strict mode, duplicate map keys are allowed within a single source, with later values overwriting previous ones. Attempting to merge mismatched types (e.g., merging a sequence into a map) replaces the old value with the new.

Enabling strict mode returns errors in both of the above cases.

Types

type Patcher

type Patcher struct {
	BaseFilePath  string
	PatchFilePath string
}

func NewPatcher

func NewPatcher(filePath string, suffix string) *Patcher

func (*Patcher) MergedPatchContent

func (p *Patcher) MergedPatchContent() ([]byte, error)

MergedPatchContent reads a YAML file and, if it exists, its patch file, then merges them and returns it serialized.

func (*Patcher) PrependedPatchContent

func (p *Patcher) PrependedPatchContent() ([]byte, error)

PrependedPatchContent collates the base .yaml file with the .yaml.patch, by putting the content of the patch BEFORE the base document. The result is a multi-document YAML in all cases, even if the base and patch files are single documents.