Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Command ¶
type Command struct {
// Command Название команды. Пустые команды не создаются.
Command string
// Description Описание команды, отображается в помощи пользователю.
Description string
// GroupKey Идентификатор группы команд, ключ связи описания группы с командой, входящей в группу.
GroupKey string
// IsDefault Команда по умолчанию.
IsDefault bool
// IsHidden Команда скрыта, не отображается в помощи.
IsHidden bool
// Value Ссылка на структуру значений с мета информацией, в неё же будут загружены
// указанное в CLI или ENV, значения.
Value any
}
Command Структура регистрации динамических команд приложения.
type ConstantEnvironment ¶
type ConstantEnvironment struct {
// Anchor Название якоря переменной.
Anchor string
// Destination Требуемое название переменной окружения.
Destination string
}
ConstantEnvironment Названия специальных переменных окружения.
type ConstantEnvironmentName ¶
type ConstantEnvironmentName []*ConstantEnvironment
ConstantEnvironmentName Срез названий специальных переменных окружения.
func (ConstantEnvironmentName) Destination ¶
func (cen ConstantEnvironmentName) Destination(name string) string
Destination Требуемое название переменной окружения.
func (ConstantEnvironmentName) MustFindByAnchor ¶
func (cen ConstantEnvironmentName) MustFindByAnchor(name string) (ret *ConstantEnvironment)
MustFindByAnchor Поиск по якорю, возвращается либо найденный объект, либо пустой объект.
type Error ¶
type Error struct{}
Error object of package.
func (*Error) HelpDisplayed ¶
HelpDisplayed Отображение помощи по командам, аргументам и флагам командной строки.
func (*Error) NotCorrectArgument ¶
NotCorrectArgument Не верное значение или тип аргумента, флага или параметра.
func (*Error) RequiredCommand ¶
RequiredCommand Не указана обязательная команда командной строки.
func (*Error) RequiredFlag ¶
RequiredFlag Не указан обязательный флаг командной строки.
func (*Error) UnexpectedError ¶
UnexpectedError Неожиданная ошибка.
func (*Error) UnknownArgument ¶
UnknownArgument Неизвестный аргумент командной строки.
func (*Error) UnknownCommand ¶
UnknownCommand Неизвестная команда командной строки.
type Flag ¶
type Flag struct {
// ShortKey Короткий, односимвольный синоним флага, может быть пустым.
ShortKey rune
// Flag Полное наименование флага, если пустой, флаг игнорируется.
Flag string
// Description Помощь для пользователя, описывающая назначение флага.
Description string
// Environment Наименование переменной окружения из которой может быть взято значение флага.
Environment string
// Placeholder Значение флага, которое будет указано при отображении в помощи.
Placeholder string
// Обязательный флаг.
IsRequired bool
// IsHidden Флаг скрыт, не отображается в помощи.
IsHidden bool
// Value Ссылка на переменную, в которую будет загружено указанное в CLI или ENV, значение.
Value any
}
Flag Структура регистрации динамических глобальных флагов приложения.
type Interface ¶
type Interface interface {
// Constant Установка названия переменных окружения, используемых отдельно от структуры конфигурации.
Constant(env ConstantEnvironmentName) Interface
// Bootstrap Первоначальная инициализация минимальной конфигурации приложения.
Bootstrap(b *kitTypes.BootstrapDefaultValue) (err error)
// RegisterCommand Регистрации динамических команд приложения.
RegisterCommand(cmd *Command)
// RegisterFlag Регистрация динамических глобальных флагов приложения.
RegisterFlag(flg *Flag)
// Init Инициализация командного интерфейса и загрузка переменных окружения.
Init() (help *bytes.Buffer, description string, err error)
// Command Команда приложения, первая часть.
Command() (ret string)
// CommandFull Полная команда приложения.
CommandFull() []string
// Errors Справочник всех ошибок пакета.
Errors() *Error
}
Interface Интерфейс пакета.
func New ¶
func New(bootstrap *kitTypes.BootstrapConfiguration) Interface
New Конструктор объекта пакета.
Source Files
Directories