yaml_utils

func LookupKey ¶ added in v0.51.0

func LookupKey(node *yaml.Node, key string) (*yaml.Node, *yaml.Node)

func MoveYamlKey ¶ added in v0.63.0

func MoveYamlKey(rootNode *yaml.Node, oldPath []string, newPath []string) (error, bool)

Takes the root node of a yaml document, the path to an existing key, and the path at which it should live instead. If the key exists, it (and its value) is moved to the new path, creating intermediate mapping nodes as needed, and any mapping nodes left empty behind it are removed. Does nothing if the key at oldPath doesn't exist. Returns an error if a key already exists at newPath, or if a node along either path exists but isn't a mapping.

func RemoveKey ¶ added in v0.51.0

func RemoveKey(node *yaml.Node, key string) (*yaml.Node, *yaml.Node)

Returns the key and value if they were present

func RenameYamlKey ¶

func RenameYamlKey(rootNode *yaml.Node, path []string, newKey string) (error, bool)

Takes the root node of a yaml document, a path to a key, and a new name for the key. Will rename the key to the new name if it exists, and do nothing otherwise.

func TransformNode ¶ added in v0.47.0

func TransformNode(rootNode *yaml.Node, path []string, transform func(node *yaml.Node) error) error

Walks a yaml document from the root node to the specified path, and then applies the transformation to that node. If the requested path is not defined in the document, no changes are made to the document.

func Walk ¶ added in v0.42.0

func Walk(rootNode *yaml.Node, callback func(node *yaml.Node, path string)) error

Traverses a yaml document, calling the callback function for each node. The callback is expected to modify the node in place

func YamlMarshal ¶ added in v0.48.0

func YamlMarshal(node *yaml.Node) ([]byte, error)