diff

Documentation

Overview

Package diff provides functionalities to compare two YAML documents.

Index

• type From
  • func (from From) Parse(to []byte, overriders ...overrider) (Tree, error)
  • func (from From) ParseWithCFNOverriders(to []byte) (Tree, error)
• type Tree
  • func (t Tree) Write(w io.Writer) error

Types

type From

type From []byte

From is the YAML document that another YAML document is compared against.

func (From) Parse

func (from From) Parse(to []byte, overriders ...overrider) (Tree, error)

Parse constructs a diff tree that represent the differences of a YAML document against the From document.

func (From) ParseWithCFNOverriders

func (from From) ParseWithCFNOverriders(to []byte) (Tree, error)

ParseWithCFNOverriders constructs a diff tree that represent the differences of a YAML document against the From document with overriders designed for CFN documents, including: 1. An ignorer that ignores diffs under "Metadata.Manifest". 2. An overrider that is able to compare intrinsic functions with full/short form correctly.

type Tree

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

Tree represents a difference tree between two YAML documents.

func (Tree) Write

func (t Tree) Write(w io.Writer) error