cli

type BasicSubCommand struct {
	Name             string
	Short            string
	Long             string
	ConfigParams     configparam.ParamList
	IgnoreConfigFile bool
	Run              func(context.Context) error
}

type CLIConfiguration struct {
	ConfiguratorCLI

	// ShortName is the abbreviated name of the observed system
	// that does not contain spaces, like "cf" for CloudFoundry
	// provider
	ShortName string

	// ObservedSystem is the full name of the external system that
	// may contain spaces, like "Cloud Foundry"
	ObservedSystem string

	// HasVerboseFlag indicates whether the CLI tool shall support
	// the --verbose/-v flag.
	HasVerboseFlag bool
}

type ConfigFileSettings map[string]any

type ConfigSchema struct {
	CLIConfiguration
}

type ConfiguratorCLI interface {
	// CommandUse method returns the one-line usage message.
	CommandUse(config *ConfigSchema) string
	// CommandShort method returns the short description shown in the 'help' output.
	CommandShort(config *ConfigSchema) string
	// CommandLong method returns the long message shown in the 'help <this-command>' output.
	CommandLong(config *ConfigSchema) string
}

type DefaultConfiguratorCLI struct{}

type SubCommand interface {
	// GetName returns the name of the subcommand, such as 'login' or 'cleanup'.
	GetName() string
	// GetShort returns the short description shown in the 'help' output.
	GetShort() string
	// GetLong returns the long message shown in the 'help <this-command>' output.
	GetLong() string
	// GetConfigParams returns the configuration parameters that can be applied for the subcommand.
	GetConfigParams() configparam.ParamList
	// MustIgnoreConfigFile returns true if the subcommand shall ignore the parameters set in the configuration file.
	MustIgnoreConfigFile() bool
	// GetRun returns the function that is to be executed when the subcommand is invoked.
	GetRun() func(context.Context) error
}