glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-04-27 17:17:20 +00:00
Code Issues Projects Releases Packages Wiki Activity

Apply code review feedback

Browse source 
Co-Authored-By: Marc Khouzam <marc.khouzam@broadcom.com>
This commit is contained in:
ccoVeille 2025-01-21 22:54:52 +01:00
parent 72b055394b
commit 9a528ef57a
No known key found for this signature in database
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
completions.go
View file

@ -123,7 +123,8 @@ type CompletionFunc func(cmd *Command, args []string, toComplete string) ([]stri
// NoFileCompletions can be used to disable file completion for commands that should
// not trigger file completions.
//
// This method satisfies [CompletionFunc] and can be used with [Command.RegisterFlagCompletionFunc]
// This method satisfies [CompletionFunc].
// It can be used with [Command.RegisterFlagCompletionFunc] and for [Command.ValidArgsFunction].
func NoFileCompletions(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
return nil, ShellCompDirectiveNoFileComp
}
@ -131,7 +132,8 @@ func NoFileCompletions(cmd *Command, args []string, toComplete string) ([]string
// FixedCompletions can be used to create a completion function which always
// returns the same results.
//
// This method returns a function that satisfies [CompletionFunc] and can be used with [Command.RegisterFlagCompletionFunc]
// This method returns a function that satisfies [CompletionFunc]
// It can be used with [Command.RegisterFlagCompletionFunc] and for [Command.ValidArgsFunction].
func FixedCompletions(choices []string, directive ShellCompDirective) CompletionFunc {
return func(cmd *Command, args []string, toComplete string) ([]string, ShellCompDirective) {
return choices, directive
@ -140,7 +142,8 @@ func FixedCompletions(choices []string, directive ShellCompDirective) Completion
// RegisterFlagCompletionFunc should be called to register a function to provide completion for a flag.
//
// You can use [FixedCompletions] or [NoFileCompletions] as completion functions.
// You can use pre-defined completion functions such as [FixedCompletions] or [NoFileCompletions],
// or you can define your own.
func (c *Command) RegisterFlagCompletionFunc(flagName string, f CompletionFunc) error {
flag := c.Flag(flagName)
if flag == nil {