Package: github.com/rsteube/carapace/internal/common

package common Import Path github.com/rsteube/carapace/internal/common (on go.dev) Dependency Relation imports 9 packages, and imported by 16 packages

Involved Source Files dash.go group.go message.go meta.go mock.go suffix.go d value.go Package common code

Package-Level Type Names (total 10)

/* sort by: alphabet | popularity */

type ByDisplay ([]) ByDisplay alias to filter by display. Methods (total 3) ( ByDisplay) Len() int ( ByDisplay) Less(i, j int) bool ( ByDisplay) Swap(i, j int) Implements (at least one exported) ByDisplay : sort.Interface

type ByRune ([]) Methods (total 3) ( ByRune) Len() int ( ByRune) Less(i, j int) bool ( ByRune) Swap(i, j int) Implements (at least one exported) ByRune : sort.Interface

type ByValue ([]) ByValue alias to filter by value. Methods (total 3) ( ByValue) Len() int ( ByValue) Less(i, j int) bool ( ByValue) Swap(i, j int) Implements (at least one exported) ByValue : sort.Interface

type Group (struct) Fields (only one) Cmd *cobra.Command Methods (total 2) ( Group) Style() string ( Group) Tag() string

type Messages (struct) Methods (total 8) (*Messages) Add(s string) ( Messages) Get() []string ( Messages) Integrate(values RawValues, prefix string) RawValues ( Messages) IsEmpty() bool ( Messages) MarshalJSON() ([]byte, error) (*Messages) Merge(other Messages) (*Messages) Suppress(expr ...string) error (*Messages) UnmarshalJSON(data []byte) (err error) Implements (at least 4) Messages : github.com/goccy/go-json.Marshaler *Messages : github.com/goccy/go-json.Unmarshaler Messages : encoding/json.Marshaler *Messages : encoding/json.Unmarshaler As Inputs Of (at least one exported) func (*Messages).Merge(other Messages)

type Meta (struct) Fields (total 3) Messages Messages Nospace SuffixMatcher Usage string Methods (only one) (*Meta) Merge(other Meta) As Inputs Of (at least 14) func (*Meta).Merge(other Meta) func github.com/rsteube/carapace/internal/shell.Value(shell string, value string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/bash.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/bash_ble.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/elvish.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/export.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/fish.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/ion.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/nushell.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/oil.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/powershell.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/tcsh.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/xonsh.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/zsh.ActionRawValues(currentWord string, meta Meta, values RawValues) string

type Mock (struct) Fields (total 2) Dir string Replies map[string]string Methods (total 2) ( Mock) CacheDir() string ( Mock) WorkDir() string As Outputs Of (at least 2) func NewMock(t t) *Mock func github.com/rsteube/carapace/internal/env.Sandbox() (m *Mock, err error)

type RawValue (struct) RawValue represents a completion candidate. Fields (total 5) Description string Display string Style string Tag string Value string Methods (only one) ( RawValue) TrimmedDescription() string TrimmedDescription returns the trimmed description.

type RawValues ([]) RawValues is an alias for []RawValue. Methods (total 6) ( RawValues) Decolor() RawValues Decolor clears style for all values. ( RawValues) EachTag(f func(tag string, values RawValues)) ( RawValues) Filter(values ...string) RawValues Filter filters values. ( RawValues) FilterPrefix(prefix string) RawValues FilterPrefix filters values with given prefix. ( RawValues) Retain(values ...string) RawValues Retain retains given values. ( RawValues) Unique() RawValues As Outputs Of (at least 7) func RawValuesFrom(values ...string) RawValues func Messages.Integrate(values RawValues, prefix string) RawValues func RawValues.Decolor() RawValues func RawValues.Filter(values ...string) RawValues func RawValues.FilterPrefix(prefix string) RawValues func RawValues.Retain(values ...string) RawValues func RawValues.Unique() RawValues As Inputs Of (at least 14) func Messages.Integrate(values RawValues, prefix string) RawValues func github.com/rsteube/carapace/internal/shell.Value(shell string, value string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/bash.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/bash_ble.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/elvish.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/export.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/fish.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/ion.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/nushell.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/oil.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/powershell.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/tcsh.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/xonsh.ActionRawValues(currentWord string, meta Meta, values RawValues) string func github.com/rsteube/carapace/internal/shell/zsh.ActionRawValues(currentWord string, meta Meta, values RawValues) string

type SuffixMatcher (struct) Methods (total 5) (*SuffixMatcher) Add(suffixes ...rune) ( SuffixMatcher) MarshalJSON() ([]byte, error) ( SuffixMatcher) Matches(s string) bool (*SuffixMatcher) Merge(other SuffixMatcher) (*SuffixMatcher) UnmarshalJSON(data []byte) (err error) Implements (at least 4) SuffixMatcher : github.com/goccy/go-json.Marshaler *SuffixMatcher : github.com/goccy/go-json.Unmarshaler SuffixMatcher : encoding/json.Marshaler *SuffixMatcher : encoding/json.Unmarshaler As Inputs Of (at least one exported) func (*SuffixMatcher).Merge(other SuffixMatcher)

Package-Level Functions (total 3)

func IsDash(cmd *cobra.Command) bool IsDash checks if command contains a dash disabling flag parsing example action positional1 -- dash1 dash2

func NewMock(t t) *Mock

func RawValuesFrom(values ...string) RawValues RawValuesFrom creates RawValues from given values.

Package-Level Variables (only one)

var FromInvokedAction (action interface{}) (Meta, RawValues) FromInvokedAction provides access to RawValues within an InvokedAction. It is intended for testing purposes in Sandbox (circumventing dependency issues).