format

Documentation

Overview

Package format contains functionality to render a cft.Template into YAML or JSON

Index

• func CftToYaml(t cft.Template) string
• func CheckMultilineBegin(s string) bool
• func Jsonise(node *yaml.Node) interface{}
• func PrettyPrint(i interface{}) string
• func String(t cft.Template, opt Options) string
• type Options

Functions

func CftToYaml

func CftToYaml(t cft.Template) string

CftToYaml converts a template to a YAML string

func CheckMultilineBegin

func CheckMultilineBegin(s string) bool

func Jsonise

func Jsonise(node *yaml.Node) interface{}

func PrettyPrint

func PrettyPrint(i interface{}) string

converts struct to a JSON formatted string

func String

func String(t cft.Template, opt Options) string

String returns a string representation of the supplied cft.Template

Types

type Options

type Options struct {
	// JSON determines whether the outputs will be JSON (true) or YAML (false)
	JSON bool

	// Unsorted will cause the formatter to leave the ordering of template elements
	// as in the original template if true.
	// If false, the formatter will rearrange the template elements into
	// canonical order.
	Unsorted bool
}

Options contains options for formatting cfn templates