textformatter

Documentation

Overview

Package textformatter is the yaff Text formatter.

Index

• Constants
• func NewFormatter() (yaff.Formatter, error)
• type Options
  • func NewOptions() Options
• type TableStyle
  • func GetTextStyleFromString(style string) (TableStyle, error)

Constants

const Text = yaff.Format("text")

Text format.

Functions

func NewFormatter

func NewFormatter() (yaff.Formatter, error)

NewFormatter return a new formatter.

Types

type Options

type Options struct {
	Style           TableStyle
	ExcludeHeader   bool
	ColumnSeparator string
	ColumnSet       map[string]bool
	ExcludeSet      map[string]bool
	// TerminalWidth is the width oth the terminal the aligned text is being output to
	// if this is 0 no wrapping will be used.  For values > column min width this value will
	// be used to wrap text.
	TerminalWidth int
}

Options for the JSON formatter.

func NewOptions

func NewOptions() Options

NewOptions return new options.

type TableStyle

type TableStyle int

TableStyle is the style of the output table.

const (
	// Plain text.
	Plain TableStyle = iota

	// Aligned in columns.
	Aligned

	// Grid surrounding.
	Grid

	// Markdown uses a markdown table format.
	Markdown
)

func GetTextStyleFromString

func GetTextStyleFromString(style string) (TableStyle, error)

GetTextStyleFromString get the text style for a string.