common

Documentation

Overview

Package common code

Index

• func IsDash(cmd *cobra.Command) 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 ByRune
  • func (r ByRune) Len() int
  • func (r ByRune) Less(i, j int) bool
  • func (r ByRune) 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
• type SuffixMatcher
  • func (sm SuffixMatcher) Add(s string) SuffixMatcher
  • func (sm SuffixMatcher) Matches(s string) bool

Functions

func IsDash

func IsDash(cmd *cobra.Command) bool

IsDash checks if command contains a dash disabling flag parsing

example action positional1 -- dash1 dash2

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 ByRune

type ByRune []rune

func (ByRune) Len

func (r ByRune) Len() int

func (ByRune) Less

func (r ByRune) Less(i, j int) bool

func (ByRune) Swap

func (r ByRune) 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
	Style       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

type SuffixMatcher

type SuffixMatcher string

func (SuffixMatcher) Add

func (sm SuffixMatcher) Add(s string) SuffixMatcher

func (SuffixMatcher) Matches

func (sm SuffixMatcher) Matches(s string) bool