common

Documentation

Overview

Package common code

Index

• func CaptureStdout(f func() error) (string, error)
• func IsDash(cmd *cobra.Command) bool
• func IsShorthandOnly(flag *pflag.Flag) (b bool)
• func TraverseLenient(cmd *cobra.Command, args []string) (*cobra.Command, []string, error)
• type ByDisplay
  • func (a ByDisplay) Len() int
  • func (a ByDisplay) Less(i, j int) bool
  • func (a ByDisplay) Swap(i, j int)
• type ByValue
  • func (a ByValue) Len() int
  • func (a ByValue) Less(i, j int) bool
  • func (a ByValue) Swap(i, j int)
• type RawValue
  • func (r RawValue) TrimmedDescription() string
• type RawValues
  • func RawValuesFrom(values ...string) RawValues
  • func (r RawValues) FilterPrefix(prefix string) RawValues

Functions

func CaptureStdout

func CaptureStdout(f func() error) (string, error)

func IsDash

func IsDash(cmd *cobra.Command) bool

IsDash checks if command contains a dash disabling flag parsing

example action positional1 -- dash1 dash2

func IsShorthandOnly

func IsShorthandOnly(flag *pflag.Flag) (b bool)

IsShorthandOnly uses reflection to check for pflag.Flag.Shorthandonly to support both spf13/pflag and cornfeedhobos shorthand change (needed for carapace-bin) won't be necessary if https://github.com/spf13/pflag/pull/256 should ever be merged

func TraverseLenient

func TraverseLenient(cmd *cobra.Command, args []string) (*cobra.Command, []string, error)

TraverseLenient traverses the command tree but filters errors regarding arguments currently being completed

Types

type ByDisplay

type ByDisplay []RawValue

ByDisplay alias to filter by display

func (ByDisplay) Len

func (a ByDisplay) Len() int

func (ByDisplay) Less

func (a ByDisplay) Less(i, j int) bool

func (ByDisplay) Swap

func (a ByDisplay) Swap(i, j int)

type ByValue

type ByValue []RawValue

ByValue alias to filter by value

func (ByValue) Len

func (a ByValue) Len() int

func (ByValue) Less

func (a ByValue) Less(i, j int) bool

func (ByValue) Swap

func (a ByValue) Swap(i, j int)

type RawValue

type RawValue struct {
	Value       string
	Display     string
	Description string
}

RawValue represents a completion candidate

func (RawValue) TrimmedDescription

func (r RawValue) TrimmedDescription() string

TrimmedDescription returns the trimmed description

type RawValues

type RawValues []RawValue

RawValues is an alias for []RawValue

func RawValuesFrom

func RawValuesFrom(values ...string) RawValues

RawValuesFrom creates RawValues from given values

func (RawValues) FilterPrefix

func (r RawValues) FilterPrefix(prefix string) RawValues

FilterPrefix filters values with given prefix