cliflags

Documentation

Overview

Package cliflags allows an application to bind parameters to control outputt formats

Index

• Constants
• func AddFormattingFlags(flags *pflag.FlagSet)
• func BindFormattingParamsToFlags(flags *pflag.FlagSet, config *viper.Viper, configBase string) error
• func GetFormmatterFromFlags(flags *pflag.FlagSet, v *viper.Viper, defaultFormat yaff.Format, ...) (yaff.Formatter, yaff.FormatOptions, error)

Constants

const (
	// FlagsReportingFormat output format.
	FlagsReportingFormat = "format"
	// FlagsReportingTemplate inline reporting template.
	FlagsReportingTemplate = "template"
	// FlagsReportingTemplateFile template file.
	FlagsReportingTemplateFile = "templatefile"
	// FlagsReportingIndent indent level.
	FlagsReportingIndent = "jsonindent"
	// FlagsReportingStyle text style.
	FlagsReportingStyle = "style"
	// FlagsReportingInclude column set to include in results.
	FlagsReportingInclude = "colset"
	// FlagsReportingExclude Columns to exclude.
	FlagsReportingExclude = "excludecols"
	// FlagsColumnSeparator Columns to exclude.
	FlagsColumnSeparator = "separator"
	// FlagsTtyWidth width override for tty.
	FlagsTtyWidth = "ttywidth"
)

const (
	// ParamsReportingFormat reporting format.
	ParamsReportingFormat = "format"
	// ParamsReportingStyle reporting style.
	ParamsReportingStyle = "style"
	// ParamsReportingIndent indent.
	ParamsReportingIndent = "indent"
	// ParamColumnSeparator is the column separator.
	ParamColumnSeparator = "separator"
	// ParamTtyWidth is the tty width to use.
	ParamTtyWidth = "ttywidth"
)

Functions

func AddFormattingFlags

func AddFormattingFlags(flags *pflag.FlagSet)

AddFormattingFlags adds formatting flags to a flag set.

func BindFormattingParamsToFlags

func BindFormattingParamsToFlags(flags *pflag.FlagSet, config *viper.Viper, configBase string) error

BindFormattingParamsToFlags binds a flags set to viper params. configBase is the base configuration path to use for the passed config viper.

func GetFormmatterFromFlags

func GetFormmatterFromFlags(flags *pflag.FlagSet, v *viper.Viper, defaultFormat yaff.Format, configBase string) (yaff.Formatter, yaff.FormatOptions, error)

GetFormmatterFromFlags returns a formatter and its options based off command line a config settings.