common

Documentation

Index

• Variables
• func Complete(base completionBase, filters ...completionFilter) ...
• func FormatDuration(d time.Duration) string
• func FormatField(s string) string
• func FormatIntToSI(n uint64, decimals int) string
• func GetDatabase(ctx context.Context, identifier string, nc rig.Client) (*database.Database, string, error)
• func GetGroup(ctx context.Context, identifier string, nc rig.Client) (*group.Group, string, error)
• func GetStorageProvider(ctx context.Context, identifier string, nc rig.Client) (*storage.Provider, string, error)
• func GetUser(ctx context.Context, identifier string, nc rig.Client) (*user.User, string, error)
• func GetUserAndPasswordUpdates(username, email, phoneNumber, password string) ([]*user.Update, error)
• func GetUserIdentifier(username, email, phoneNumber string) (*model.UserIdentifier, error)
• func GetUserIdentifierUpdates(username, email, phoneNumber string) ([]*user.Update, error)
• func MaxArgsCompletionFilter(max int) completionFilter
• func ParseUserIdentifier(identifier string) (*model.UserIdentifier, error)
• func ParseUserIdentifierUpdate(identifier string) (*user.Update, error)
• func PromptConfirm(label string, def bool) (bool, error)
• func PromptInput(label string, opts ...GetInputOption) (string, error)
• func PromptPassword(label string) (string, error)
• func PromptSelect(label string, choices []string, opts ...SelectInputOption) (int, string, error)
• func PromptTableSelect(label string, choices [][]string, columnHeaders []string, ...) (int, error)
• func PromptUserIndentifier() (*model.UserIdentifier, error)
• func PromptUserIndentifierUpdate() (*user.Update, error)
• func ProtoToPrettyJson(m protoreflect.ProtoMessage) string
• func ToStringWithSignificantDigits(f float64, digits int) string
• type GetInputOption
• type SelectInputOption

Variables

var ArgsCompletionFilter = func(cmd *cobra.Command, args []string, toComplete string, completions []string, directive cobra.ShellCompDirective) ([]string, cobra.ShellCompDirective) {
	args = append(args, toComplete)
	err := cmd.Args(cmd, args)
	if err != nil {
		fmt.Println(err.Error())
		return []string{}, cobra.ShellCompDirectiveError
	}

	return completions, directive
}

var BoolCompletions = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
	return []string{"true", "false"}, cobra.ShellCompDirectiveNoFileComp
}

var BoolValidate = func(bool string) error {
	if bool != "true" && bool != "false" {
		return errors.InvalidArgumentErrorf("invalid boolean value")
	}
	return nil
}

var BoolValidateOpt = func(inp *textinput.TextInput) {
	inp.Validate = BoolValidate
}

var InputDefaultOpt = func(def string) GetInputOption {
	return func(inp *textinput.TextInput) {
		inp.InitialValue = def
	}
}

var NoCompletions = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
	return []string{}, cobra.ShellCompDirectiveNoFileComp
}

var SelectEnableFilterOpt = func(s *selection.Selection[string]) {
	s.Filter = selection.FilterContainsCaseSensitive[string]
}

var SelectExtendTemplateOpt = func(t template.FuncMap) SelectInputOption {
	return func(s *selection.Selection[string]) {
		s.ExtendedTemplateFuncs = t
	}
}

var SelectFuzzyFilterOpt = func(s *selection.Selection[string]) {
	s.Filter = func(filter string, choice *selection.Choice[string]) bool {
		return fuzzy.Match(filter, choice.Value)
	}
}

var SelectTemplateOpt = func(template string) SelectInputOption {
	return func(s *selection.Selection[string]) {
		s.Template = template
	}
}

var ValidateAbsPathOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateAbsolutePath
}

var ValidateAbsolutePath = func(input string) error {
	if abs := path.IsAbs(input); !abs {
		return errors.InvalidArgumentErrorf("must be an absolute path")
	}
	return nil
}

var ValidateAll = func(input string) error {
	return nil
}

var ValidateAllOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateAll
}

var ValidateBool = func(s string) error {
	if s == "" {
		return nil
	}

	if _, err := parseBool(s); err != nil {
		return err
	}

	return nil
}

var ValidateBoolOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateBool
}

var ValidateEmail = func(input string) error {
	_, err := mail.ParseAddress(input)
	if err != nil {
		return err
	}
	return nil
}

var ValidateEmailOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateEmail
}

var ValidateFilePath = func(input string) error {
	if path.Ext(input) == "" {
		return errors.InvalidArgumentErrorf("must be a file path")
	}
	return nil
}

var ValidateFilePathOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateFilePath
}

var ValidateImage = func(input string) error {
	_, err := reference.ParseDockerRef(input)
	if err != nil {
		return err
	}

	return nil
}

var ValidateImageOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateImage
}

var ValidateInt = func(input string) error {
	_, err := strconv.Atoi(input)
	if err != nil {
		return err
	}
	return nil
}

var ValidateIntOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateInt
}

var ValidateNonEmpty = func(input string) error {
	if input == "" {
		return errors.InvalidArgumentErrorf("value cannot be empty")
	}
	return nil
}

var ValidateNonEmptyOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateNonEmpty
}

var ValidatePasswordOpt = func(inp *textinput.TextInput) {
	inp.Validate = utils.ValidatePassword
}

var ValidatePhoneOpt = func(inp *textinput.TextInput) {
	inp.Validate = utils.ValidatePhone
}

var ValidateQuantity = func(s string) error {
	_, err := resource.ParseQuantity(s)
	return err
}

var ValidateQuantityOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateQuantity
}

var ValidateSystemName = func(input string) error {
	if l := len(input); l < 3 || l > 63 {
		return errors.InvalidArgumentErrorf("must be between 3 and 63 characters long")
	}

	if !regexp.MustCompile(`^[a-z][a-z0-9-]+[a-z0-9]$`).MatchString(input) {
		return errors.InvalidArgumentErrorf("invalid name; can only contain a-z, 0-9 and '-'")
	}

	return nil
}

var ValidateSystemNameOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateSystemName
}

var ValidateURL = func(input string) error {
	_, err := url.Parse(input)
	return err
}

var ValidateURLOpt = func(inp *textinput.TextInput) {
	inp.Validate = ValidateURL
}

Functions

func Complete

func Complete(base completionBase, filters ...completionFilter) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

Complete is a helper function to chain a completion function and subsequent filters.

func FormatDuration

func FormatDuration(d time.Duration) string

func FormatField

func FormatField(s string) string

func FormatIntToSI

func FormatIntToSI(n uint64, decimals int) string

func GetDatabase

func GetDatabase(ctx context.Context, identifier string, nc rig.Client) (*database.Database, string, error)

func GetGroup

func GetGroup(ctx context.Context, identifier string, nc rig.Client) (*group.Group, string, error)

func GetStorageProvider

func GetStorageProvider(ctx context.Context, identifier string, nc rig.Client) (*storage.Provider, string, error)

func GetUser

func GetUser(ctx context.Context, identifier string, nc rig.Client) (*user.User, string, error)

func GetUserAndPasswordUpdates

func GetUserAndPasswordUpdates(username, email, phoneNumber, password string) ([]*user.Update, error)

func GetUserIdentifier

func GetUserIdentifier(username, email, phoneNumber string) (*model.UserIdentifier, error)

func GetUserIdentifierUpdates

func GetUserIdentifierUpdates(username, email, phoneNumber string) ([]*user.Update, error)

func MaxArgsCompletionFilter

func MaxArgsCompletionFilter(max int) completionFilter

func ParseUserIdentifier

func ParseUserIdentifier(identifier string) (*model.UserIdentifier, error)

func ParseUserIdentifierUpdate

func ParseUserIdentifierUpdate(identifier string) (*user.Update, error)

func PromptConfirm

func PromptConfirm(label string, def bool) (bool, error)

func PromptInput

func PromptInput(label string, opts ...GetInputOption) (string, error)

func PromptPassword

func PromptPassword(label string) (string, error)

func PromptSelect

func PromptSelect(label string, choices []string, opts ...SelectInputOption) (int, string, error)

func PromptTableSelect

func PromptTableSelect(label string, choices [][]string, columnHeaders []string, opts ...SelectInputOption) (int, error)

func PromptUserIndentifier

func PromptUserIndentifier() (*model.UserIdentifier, error)

func PromptUserIndentifierUpdate

func PromptUserIndentifierUpdate() (*user.Update, error)

func ProtoToPrettyJson

func ProtoToPrettyJson(m protoreflect.ProtoMessage) string

func ToStringWithSignificantDigits

func ToStringWithSignificantDigits(f float64, digits int) string

Types

type GetInputOption

type GetInputOption = func(*textinput.TextInput)

type SelectInputOption

type SelectInputOption = func(s *selection.Selection[string])

TODO What about non-string Selection