meta

type Flag struct {

	// The name of the underlying struct field this flag comes from.
	FieldName string // "Number"

	// Short and Long Names of the flag
	// each potentially more than one
	Short []string // ["n"]
	Long  []string // ["number"]

	// Indicates if the flag is required
	Required bool // false

	// Name and Description of the flag in help texts
	Value string // "digit"
	Usage string // "A digit used within something"

	// Default value of the flag, as shown to the user.
	// When multiple default values are set, they are joined as a string.
	Default string // "42"

	// Valid choices for the option
	Choices []string
}

type Info struct {
	BuildVersion string
	BuildTime    time.Time

	Executable  string // Name of the main executable of the program
	Description string // Description of the program
}

type Meta struct {
	// Name of the Executable and Current command.
	// When Command is empty, the entire struct describes the program as a whole.
	Executable string
	Command    string

	// Description holds a human-readable description of the object being described.
	Description string

	// Applicable Global, Command and Positional Flags.
	GlobalFlags  []Flag
	CommandFlags []Flag
	Positionals  []Positional

	// List of available sub-commands, only set when Command == "".
	Commands []string
}

type Positional struct {
	// Name and Description of the positional in help texts
	Value string // defaults to "ARGUMENT"
	Usage string

	// Min and Max indicate how many positional arguments are expected for this command.
	// Min must be >= 0. Max must be either Min, or -1.
	// Max == -1 indicates an unlimited number of repeats.
	Min, Max int
}