format

Documentation

Overview

Package format provides functions for formatting the types found in the cfn package.

Index

• func Anything(data interface{}, options Options) string
• func Diff(d diff.Diff, options Options) string
• func SortKeys(keys []string, path []interface{}) []string
• func Template(t cfn.Template, options Options) string
• func Value(data value.Interface, options Options) string
• type Options
• type Style

Functions

func Anything

func Anything(data interface{}, options Options) string

Anything returns a string representation of any given value as either JSON or YAML depending on options.Style

func Diff

func Diff(d diff.Diff, options Options) string

Diff returns a string representation of a diff.Diff. options.Style is currently ignored and the format will be annotated YAML

func SortKeys

func SortKeys(keys []string, path []interface{}) []string

SortKeys sorts the given keys based on their location within a CloudFormation template as given by the path parameter

func Template

func Template(t cfn.Template, options Options) string

Template returns a string representation of a cfn.Template as either JSON or YAML depending on options.Style

func Value

func Value(data value.Interface, options Options) string

Value returns a string representation of any given value as either JSON or YAML depending on options.Style

Types

type Options

type Options struct {
	Style    Style
	Compact  bool
	Comments map[string]interface{}
}

Options represents a collection of formatting options

type Style

type Style int

Style represents a style offered by a given formatter

const (
	// YAML specifies the YAML format
	YAML Style = iota

	// JSON specifies the JSON format
	JSON
)