ctl

type ByName struct{ Commands }

type Command interface {
	// ExecuteCommand is called when grnc-ctl is used to invoke a command that matches this Command's Name() method.
	// It is expected to execute whatever functionality is represented by the Command and describe the outcome in a
	// *CommandOutput. If errors are encountered, they should be formatted and returned as a slice of *ws.CategorisedError.
	ExecuteCommand(qualifiers []string, args map[string]string) (*CommandOutput, []*ws.CategorisedError)

	// A unique name for this command. Names should be short and only contain letters, numbers, underscores and dashes.
	Name() string

	// A short description (recommended less than 80 characters) briefly explaining the purpose of the Command. This text
	// will be shown when a user runs grnc-ctl help
	Summmary() string

	// A formal description of how this Command should be called e.g. start [component] [-fw true] [-rc true].
	Usage() string

	// A detailed, free-text description of the purpose of this Command. This text will be shown when a user runs
	// grnc-ctl help command-name and each element of the slice will be rendered as a new paragraph.
	Help() []string
}

type CommandDecorator struct {
	// Logger used by Granitic framework components. Automatically injected.
	FrameworkLogger logging.Logger

	// An instance of CommandManager to register discovered Commands with.
	CommandManager *CommandManager
}

type CommandLogic struct {
	// Logger used by Granitic framework components. Automatically injected.
	FrameworkLogger logging.Logger

	// An instance of CommandManager that contains all known commands.
	CommandManager *CommandManager
}

type CommandManager struct {
	// Logger used by Granitic framework components. Automatically injected.
	FrameworkLogger logging.Logger

	// A slice of command names that should not be registered, effectively disabling their use. Populated via configuration.
	Disabled []string

	// The contents of Disabled converted to a Set at facility instantiation time.
	DisabledLookup types.StringSet
	// contains filtered or unexported fields
}

type CommandOutput struct {
	// An optional text header that will be rendered as paragraph of text before the text of the OutputBody is displayed.
	OutputHeader string

	// Optional output text that will be rendered by grnc-ctl according to the hint in RenderHint. If column output is used,
	// each element in the outer slice is a row and each inner slice will be rendered as an indented column (up to a maxiumu of two
	// columns.
	OutputBody [][]string

	// Whether grnc-ctl should render the OutputBody as Columns or Paragraph
	RenderHint renderMode
}

type Commands []Command