Skip to content

Commit

Permalink
Apply code review feedback
Browse files Browse the repository at this point in the history
Co-Authored-By: Marc Khouzam <[email protected]>
  • Loading branch information
ccoVeille and marckhouzam committed Jan 21, 2025
1 parent 72b0553 commit 9a528ef
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions completions.go
Original file line number Diff line number Diff line change
Expand Up @@ -123,15 +123,17 @@ 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
}

// 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
Expand All @@ -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 {
Expand Down

0 comments on commit 9a528ef

Please sign in to comment.