ankh

type BasicUi struct {
	Reader      io.Reader
	Writer      io.Writer
	ErrorWriter io.Writer
}

type CLI struct {
	// Args is the list of command-line arguments received excluding
	// the name of the app. For example, if the command "./cli foo bar"
	// was invoked, then Args should be []string{"foo", "bar"}
	Args []string

	// Commands is a mapping of subcommands names to a factory function
	// for creating that Command implementation. If there is a command
	// with a blank string "", then it will be used as the default command
	// if no subcommand is specified.
	//
	// If the key has a space in it, this will create a nested subcommand.
	// for example, if the key is "foo bar", then to access it our ankh.CLI
	// instalnnce must be access with "./cli foo bar". See the docs for CLI for
	// notes on how this changes some other behavior of the CLI as well.
	//
	// The factory should be as cheap as possible, ideally only allocating
	// a struct. The factory may be called multiple times in the course
	// of a command execution and certain events such as help require the instantiation
	// of all commands. Expensive initiliazation should be deferred to function
	// calls within the interface implementation
	Commands map[string]CommandFactory

	// HiddenCommands is a list of commands that are "hidden". Hidden
	// commands are not given to the help function callback and do not show up
	// in autocomplete. The values in the slice should be equivalent
	// to the Keys in the command map.
	HiddenCommands []string

	// Name defines the name of the CLI.
	Name string

	// Version of the CLI
	Version string

	// Autocomplete enables or disables subcommand auto-completion support.
	// This is enabled by default when NewCLI is called. Otherwise, this
	// must be enabled explicitely.
	//
	// Autocomplete requires the "Name" option to be set on CLI. This name
	// should be set exactly to the binary name that is autocompleted.
	//
	// AutocompleteInstall and AutocompleteUninstall are the global flag
	// names for installing and uninstalling the autocompletion handlers
	// for the user's shell. The flag should omit the hyphen(s) in front of
	// the value. Both single and double hyphens will automatically be supported
	// for the flag name. These default to `autocompelete-install`and
	// `autocomplete-uninstall` respectively.
	//
	// AutocompleteNoDefaultFlags is a boolean which contronls if the default auto-
	// complete flags like -help and -version are added to the output.
	//
	// AutoCompleteGlobalFlags are mapping of global flags for autocompletion.
	// The help and version flags are automatically added.
	Autocomplete               bool
	AutocompleteInstall        string
	AutocompleteUninstall      string
	AutocompleteNoDefaultFlags bool
	AutocompleteGlobalFlags    complete.Flags

	// HelpFunc is the function called to generate the generic help
	// text that is show if help must be shown for the CLI that doe'sn'
	// pertain to a specific command.
	HelpFunc HelpFunc

	// HelpWriter is used to print help text and version when requested.
	// Defaults to os.Stderr for backwards compatibility.
	// It is recommended that you set HelpWriter to os.Stdout, and
	// ErrorWriter to os.Stderr
	HelpWriter io.Writer

	// ErrorWriter is used to output errors when a command can not be run.
	// Defaults to the value of HelpWriter for backward compatibility.
	// It is recommended that you set HelpWriter to os.Stdout, and
	// ErrorWriter to os.Stderr.
	ErrorWriter io.Writer
	// contains filtered or unexported fields
}

type ColoredUi struct {
	OutputColor UiColor
	InfoColor   UiColor
	ErrorColor  UiColor
	WarnColor   UiColor
	Ui          Ui
}

type Command interface {
	// Help should return long-form help text that includes the command-line
	// usage, a brief few sentences explainaing the function of the command
	// and the complete list of flags the command accepts.
	Help() string

	// Run should run the actual command with the given CLI instance and
	// command-line arguments. It should return the exit status when it is
	// finished.
	//
	// There are a handful of special exit codes this can return documented
	// above that change behavior.
	Run(args []string) int

	// Synopsi should return a one-line, short synopsis of the command.
	// This should be less than 50 characters ideally.
	Synopsis() string
}

type CommandAutoComplete interface {
	// AutocompleteArgs return the argument predictor for this command.
	// If argument completion is not supported, this should return
	// complete. PredictNothing.
	AutocompleteArgs() complete.Predictor

	// AutoCompleteFlags returns a mapping of supported flags and autocomplete
	// options for this command. The map key for the Flags map should be the
	// complete flag such as "-foo" or "--foo".
	AutoCompleteFlags() complete.Flags
}

type CommandFactory func() (Command, error)

type CommandHelpTemplate interface {
	// HelpTemplate is the template in text/template format to use for
	// displaying the Help. The keys available are:
	//
	// * ", Help" - The help text itself
	// * ".Subcommands"
	//
	HelpTemplate() string
}

type ConcurrentUi struct {
	Ui Ui
	// contains filtered or unexported fields
}

type HelpFunc func(map[string]CommandFactory) string

type MockCommand struct {
	// Settable
	HelpText     string
	RunResult    int
	SynopsisText string

	// Set by the command
	RunCalled bool
	RunArgs   []string
}

type MockCommandAutocomplete struct {
	MockCommand

	// Settable
	AutocompleteArgsValue  complete.Predictor
	AutocompleteFlagsValue complete.Flags
}

type MockCommandHelpTemplate struct {
	MockCommand

	// Settable
	HelpTemplateText string
}

type MockUi struct {
	InputReader  io.Reader
	ErrorWriter  *syncBuffer
	OutputWriter *syncBuffer
	// contains filtered or unexported fields
}

type PrefixedUi struct {
	AskPrefix       string
	AskSecretPrefix string
	OutputPrefix    string
	InfoPrefix      string
	ErrorPrefix     string
	WarnPrefix      string
	Ui              Ui
}

type Ui interface {
	// Ask the user for input using the given query. The response is
	// returned as the given string, or an error
	Ask(string) (string, error)

	// Ask secret asks the user for input using the given query, but
	// does not echo the keystrokes to the terminal
	AskSecret(string) (string, error)

	// Output is called for normal standard output
	Output(string)

	// Info is called for information related to the previous output
	// In general this may be the exact same as output, but this gives
	// the UI impementors some flexibility with output formats.
	Info(string)

	// Error is used for any error messages that might appear on standard
	// Error
	Error(string)

	// Warn is used for any error messages that might appear on standard
	// Error
	Warn(string)
}

type UiColor struct {
	Code int
	Bold bool
}

type UiWriter struct {
	Ui Ui
}