yamltools

Documentation

Overview

Package yamltools provides functions for handling YAML nodes, such as copying comments, applying comments, and diffing YAML documents.

Index

• func ApplyComments(dstNode *yaml.Node, path string, dstPaths map[string]*yaml.Node)
• func CopyComments(srcNode, dstNode *yaml.Node, path string, dstPaths map[string]*yaml.Node)
• func DiffYAMLs(original, modified []byte) ([]byte, error)

Functions

func ApplyComments

func ApplyComments(dstNode *yaml.Node, path string, dstPaths map[string]*yaml.Node)

ApplyComments applies the copied comments to the target document.

func CopyComments

func CopyComments(srcNode, dstNode *yaml.Node, path string, dstPaths map[string]*yaml.Node)

CopyComments updates the comments in dstNode considering the structure of whitespace.

func DiffYAMLs

func DiffYAMLs(original, modified []byte) ([]byte, error)

DiffYAMLs compares two YAML documents and outputs the differences.