formatter

Documentation

Index

• Constants
• func ShortFormat(name string) string
• type FormattedResult
  • func CookbooksReportSummary(state *reporting.CookbooksReport) FormattedResult
  • func MakeCookbooksReportCSV(state *reporting.CookbooksReport) *FormattedResult
  • func MakeCookbooksReportTXT(state *reporting.CookbooksReport) *FormattedResult
  • func MakeNodesReportCSV(records []*reporting.NodeReportItem, nodeFilter string) *FormattedResult
  • func MakeNodesReportTXT(records []*reporting.NodeReportItem, nodeFilter string) *FormattedResult
  • func NodesReportSummary(records []*reporting.NodeReportItem, appliedNodesFilter string) FormattedResult

Constants

const (
	MinTermWidth = 120
)

MinTermWidth is required terminal width

Functions

func ShortFormat

func ShortFormat(name string) string

Types

type FormattedResult

type FormattedResult struct {
	Report string
	Errors string
}

FormattedResult contains the report and its errors

func CookbooksReportSummary

func CookbooksReportSummary(state *reporting.CookbooksReport) FormattedResult

CookbooksReportSummary prints smaller, summarized report

func MakeCookbooksReportCSV

func MakeCookbooksReportCSV(state *reporting.CookbooksReport) *FormattedResult

MakeCookbooksReportCSV generates a CSV formatted cookbooks report

func MakeCookbooksReportTXT

func MakeCookbooksReportTXT(state *reporting.CookbooksReport) *FormattedResult

MakeCookbooksReportTXT text output of long, non-summarize report

func MakeNodesReportCSV

func MakeNodesReportCSV(records []*reporting.NodeReportItem, nodeFilter string) *FormattedResult

MakeNodesReportCSV generates a CSV formatted nodes report

func MakeNodesReportTXT

func MakeNodesReportTXT(records []*reporting.NodeReportItem, nodeFilter string) *FormattedResult

MakeNodesReportTXT text output of long, non-summarize report

func NodesReportSummary

func NodesReportSummary(records []*reporting.NodeReportItem, appliedNodesFilter string) FormattedResult

NodesReportSummary prints smaller, summarized report