cli

Documentation

Index

• Variables
• func Annotations(cmd string) map[string]string
• func PreRunEFunc(config *Config) func(*cobra.Command, []string) error
• func RunEFunc(config *Config) func(*cobra.Command, []string) error
• type Config
  • func DefaultConfig() *Config

Variables

var (
	OutputTemplate = fmt.Sprintf("%s\n%s\n%s", outputBeginComment, outputContent, outputEndComment)
	OutputModes    = strings.Join([]string{outputModeInject, outputModeReplace}, ", ")
)

Output to file template and modes

var AllSections = strings.Join(allSections, ", ")

AllSections list.

var SortTypes = strings.Join(allSorts, ", ")

SortTypes list.

Functions

func Annotations

func Annotations(cmd string) map[string]string

Annotations returns set of annotations for cobra.Commands, specifically the command 'name' and command 'kind'

func PreRunEFunc

func PreRunEFunc(config *Config) func(*cobra.Command, []string) error

PreRunEFunc returns actual 'cobra.Command#PreRunE' function for 'formatter' commands. This functions reads and normalizes flags and arguments passed through CLI execution.

func RunEFunc

func RunEFunc(config *Config) func(*cobra.Command, []string) error

RunEFunc returns actual 'cobra.Command#RunE' function for 'formatter' commands. This functions extract print.Settings and terraform.Options from generated and normalized Config and initializes required print.Format instance and executes it.

Types

type Config

type Config struct {
	File         string       `mapstructure:"-"`
	Formatter    string       `mapstructure:"formatter"`
	Version      string       `mapstructure:"version"`
	HeaderFrom   string       `mapstructure:"header-from"`
	FooterFrom   string       `mapstructure:"footer-from"`
	Content      string       `mapstructure:"content"`
	Sections     sections     `mapstructure:"sections"`
	Output       output       `mapstructure:"output"`
	OutputValues outputvalues `mapstructure:"output-values"`
	Sort         sort         `mapstructure:"sort"`
	Settings     settings     `mapstructure:"settings"`
	// contains filtered or unexported fields
}

Config represents all the available config options that can be accessed and passed through CLI

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig returns new instance of Config with default values set