claw

type AmbiguousPositionalsError struct{}

type DefaultValueTypeError struct {
	// contains filtered or unexported fields
}

type DuplicateNameError struct {
	// contains filtered or unexported fields
}

type EmptyProgramNameError struct{}

type Flag struct {

	// LongName is the name of the optional flag if it is non-empty.
	// LongName must be empty or at least two characters long,
	// with alphanumeric characters in kebab-case.
	// Use ShortName if a shorter name is preferred.
	LongName string

	// ShortName is the name of the optional flag if LongName is empty.
	// It must be empty or an alphabet.
	ShortName byte

	// Type is the type of the parameter.
	// It must be one of "string, "int", "float", and "bool".
	// An empty string defaults to "string".
	Type string

	// DefaultValue is the default value of the parameter.
	// The type of DefaultValue must match the Type field.
	// The positional parameter is optional if DefaultValue != nil,
	// and required otherwise.
	DefaultValue any

	// Description is a short text of what the flag is, for the help menu.
	Description string

	// ValueName is the hint text printed in place of the value of a non-bool type flag on the help menu.
	// For example, --flag=<value>.
	// An empty string defaults to the Type of the flag (eg. --flag=<string>).
	ValueName string
	// contains filtered or unexported fields
}

type InvalidFlagNameError struct {
	// contains filtered or unexported fields
}

type InvalidParamOrderError struct{}

type InvalidPositionalNameError struct {
	// contains filtered or unexported fields
}

type InvalidTypeError struct {
	// contains filtered or unexported fields
}

type Options struct {
	// Name is the name of the program in the "Usage" part of the help menu
	// Its value must be non-empty.
	Name string

	// Description is a short text describing what the program does
	// at the top of the help menu.
	Description string

	// Positionals is the positional parameters to parse.
	// All optional parameters must come after all required parameters.
	// There can only be at most one repeating parameter,
	// and no other optional parameter if there is a repeating parameter.
	Positionals []Positional // the positional parameters to parse

	Flags            []Flag // the option flags to parse
	Postnote         string // text to print at the end of the help menu
	DisableShortHelp bool   // disable printing the help menu on -h
}

type Positional struct {
	// Name is the name of the parameter to be printed in the help menu
	// and used as the key in the args map returned by Parse.
	// It must be a non-empty alphanumeric string in snake_case.
	Name string

	// Type is the type of the parameter.
	// It must be one of "string, "int", "float", and "bool".
	// An empty string defaults to "string".
	Type string

	// DefaultValue is the default value of the parameter.
	// The type of DefaultValue must match the Type field.
	// The positional parameter is optional if DefaultValue != nil,
	// and required otherwise.
	DefaultValue any

	// Description is a short text of what the parameter is, for the help menu.
	// If left empty, the parameter will only be printed in the "Usage" section
	// but not in the "Parameters" section.
	Description string

	Repeating bool // whether the parameter can take more than one argument
}