Skip to content

Fish completions tests invokes setup #2124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dearchap merged 2 commits into from
May 10, 2025
Merged

Fish completions tests invokes setup #2124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9de83fa
Fish completion presents only the canonical name of suggested command.
bittrance May 5, 2025
86cbfed
Fish completion tests now include command setup.
bittrance May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 26 additions & 28 deletions fish.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@ func (cmd *Command) writeFishCompletionTemplate(w io.Writer) error {
}

// Add global flags
completions := cmd.prepareFishFlags(cmd.VisibleFlags(), []string{})
completions := prepareFishFlags(cmd.Name, cmd)

// Add commands and their flags
completions = append(
completions,
cmd.prepareFishCommands(cmd.Commands, []string{})...,
prepareFishCommands(cmd.Name, cmd)...,
)

toplevelCommandNames := []string{}
Expand All @@ -52,16 +52,17 @@ func (cmd *Command) writeFishCompletionTemplate(w io.Writer) error {
})
}

func (cmd *Command) prepareFishCommands(commands []*Command, previousCommands []string) []string {
func prepareFishCommands(binary string, parent *Command) []string {
commands := parent.Commands
completions := []string{}
for _, command := range commands {
if !command.Hidden {
var completion strings.Builder
fmt.Fprintf(&completion,
"complete -x -c %s -n '%s' -a '%s'",
cmd.Name,
cmd.fishSubcommandHelper(previousCommands, commands),
strings.Join(command.Names(), " "),
binary,
fishSubcommandHelper(binary, parent, commands),
command.Name,
)

if command.Usage != "" {
Expand All @@ -73,31 +74,28 @@ func (cmd *Command) prepareFishCommands(commands []*Command, previousCommands []
}
completions = append(
completions,
cmd.prepareFishFlags(command.VisibleFlags(), command.Names())...,
prepareFishFlags(binary, command)...,
)

// recursively iterate subcommands
if len(command.Commands) > 0 {
completions = append(
completions,
cmd.prepareFishCommands(
command.Commands, command.Names(),
)...,
)
}
completions = append(
completions,
prepareFishCommands(binary, command)...,
)
}

return completions
}

func (cmd *Command) prepareFishFlags(flags []Flag, previousCommands []string) []string {
func prepareFishFlags(binary string, owner *Command) []string {
flags := owner.VisibleFlags()
completions := []string{}
for _, f := range flags {
completion := &strings.Builder{}
fmt.Fprintf(completion,
"complete -c %s -n '%s'",
cmd.Name,
cmd.fishFlagHelper(previousCommands),
binary,
fishFlagHelper(binary, owner),
)

fishAddFileFlag(f, completion)
Expand Down Expand Up @@ -146,28 +144,28 @@ func fishAddFileFlag(flag Flag, completion *strings.Builder) {
completion.WriteString(" -f")
}

func (cmd *Command) fishSubcommandHelper(allCommands []string, siblings []*Command) string {
fishHelper := fmt.Sprintf("__fish_%s_no_subcommand", cmd.Name)
if len(allCommands) > 0 {
func fishSubcommandHelper(binary string, command *Command, siblings []*Command) string {
fishHelper := fmt.Sprintf("__fish_%s_no_subcommand", binary)
if len(command.Lineage()) > 1 {
var siblingNames []string
for _, command := range siblings {
siblingNames = append(siblingNames, command.Names()...)
for _, sibling := range siblings {
siblingNames = append(siblingNames, sibling.Names()...)
}
fishHelper = fmt.Sprintf(
"__fish_seen_subcommand_from %s; and not __fish_seen_subcommand_from %s",
strings.Join(allCommands, " "),
strings.Join(command.Names(), " "),
strings.Join(siblingNames, " "),
)
}
return fishHelper
}

func (cmd *Command) fishFlagHelper(allCommands []string) string {
fishHelper := fmt.Sprintf("__fish_%s_no_subcommand", cmd.Name)
if len(allCommands) > 0 {
func fishFlagHelper(binary string, command *Command) string {
fishHelper := fmt.Sprintf("__fish_%s_no_subcommand", binary)
if len(command.Lineage()) > 1 {
fishHelper = fmt.Sprintf(
"__fish_seen_subcommand_from %s",
strings.Join(allCommands, " "),
strings.Join(command.Names(), " "),
)
}
return fishHelper
Expand Down
1 change: 1 addition & 0 deletions fish_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ func TestFishCompletion(t *testing.T) {
Name: "foofile",
TakesFile: true,
})
cmd.setupCommandGraph()

oldTemplate := FishCompletionTemplate
defer func() { FishCompletionTemplate = oldTemplate }()
Expand Down
24 changes: 19 additions & 5 deletions testdata/expected-fish-full.fish
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,31 @@ complete -c greet -n '__fish_greet_no_subcommand' -f -l flag -s fl -s f -r
complete -c greet -n '__fish_greet_no_subcommand' -f -l another-flag -s b -d 'another usage text'
complete -c greet -n '__fish_greet_no_subcommand' -l logfile -r
complete -c greet -n '__fish_greet_no_subcommand' -l foofile -r
complete -x -c greet -n '__fish_greet_no_subcommand' -a 'config c' -d 'another usage test'
complete -x -c greet -n '__fish_greet_no_subcommand' -a 'config' -d 'another usage test'
complete -c greet -n '__fish_seen_subcommand_from config c' -l flag -s fl -s f -r
complete -c greet -n '__fish_seen_subcommand_from config c' -f -l another-flag -s b -d 'another usage text'
complete -x -c greet -n '__fish_seen_subcommand_from config c; and not __fish_seen_subcommand_from sub-config s ss' -a 'sub-config s ss' -d 'another usage test'
complete -c greet -n '__fish_seen_subcommand_from config c' -f -l help -s h -d 'show help'
complete -x -c greet -n '__fish_seen_subcommand_from config c; and not __fish_seen_subcommand_from sub-config s ss help h' -a 'sub-config' -d 'another usage test'
complete -c greet -n '__fish_seen_subcommand_from sub-config s ss' -f -l sub-flag -s sub-fl -s s -r
complete -c greet -n '__fish_seen_subcommand_from sub-config s ss' -f -l sub-command-flag -s s -d 'some usage text'
complete -x -c greet -n '__fish_greet_no_subcommand' -a 'info i in' -d 'retrieve generic information'
complete -c greet -n '__fish_seen_subcommand_from sub-config s ss' -f -l help -s h -d 'show help'
complete -x -c greet -n '__fish_seen_subcommand_from sub-config s ss; and not __fish_seen_subcommand_from help h' -a 'help' -d 'Shows a list of commands or help for one command'
complete -x -c greet -n '__fish_seen_subcommand_from config c; and not __fish_seen_subcommand_from sub-config s ss help h' -a 'help' -d 'Shows a list of commands or help for one command'
complete -x -c greet -n '__fish_greet_no_subcommand' -a 'info' -d 'retrieve generic information'
complete -c greet -n '__fish_seen_subcommand_from info i in' -f -l help -s h -d 'show help'
complete -x -c greet -n '__fish_seen_subcommand_from info i in; and not __fish_seen_subcommand_from help h' -a 'help' -d 'Shows a list of commands or help for one command'
complete -x -c greet -n '__fish_greet_no_subcommand' -a 'some-command'
complete -c greet -n '__fish_seen_subcommand_from some-command' -f -l help -s h -d 'show help'
complete -x -c greet -n '__fish_seen_subcommand_from some-command; and not __fish_seen_subcommand_from help h' -a 'help' -d 'Shows a list of commands or help for one command'
complete -c greet -n '__fish_seen_subcommand_from hidden-command' -f -l completable
complete -x -c greet -n '__fish_greet_no_subcommand' -a 'usage u' -d 'standard usage text'
complete -c greet -n '__fish_seen_subcommand_from hidden-command' -f -l help -s h -d 'show help'
complete -x -c greet -n '__fish_seen_subcommand_from hidden-command; and not __fish_seen_subcommand_from help h' -a 'help' -d 'Shows a list of commands or help for one command'
complete -x -c greet -n '__fish_greet_no_subcommand' -a 'usage' -d 'standard usage text'
complete -c greet -n '__fish_seen_subcommand_from usage u' -l flag -s fl -s f -r
complete -c greet -n '__fish_seen_subcommand_from usage u' -f -l another-flag -s b -d 'another usage text'
complete -x -c greet -n '__fish_seen_subcommand_from usage u; and not __fish_seen_subcommand_from sub-usage su' -a 'sub-usage su' -d 'standard usage text'
complete -c greet -n '__fish_seen_subcommand_from usage u' -f -l help -s h -d 'show help'
complete -x -c greet -n '__fish_seen_subcommand_from usage u; and not __fish_seen_subcommand_from sub-usage su help h' -a 'sub-usage' -d 'standard usage text'
complete -c greet -n '__fish_seen_subcommand_from sub-usage su' -f -l sub-command-flag -s s -d 'some usage text'
complete -c greet -n '__fish_seen_subcommand_from sub-usage su' -f -l help -s h -d 'show help'
complete -x -c greet -n '__fish_seen_subcommand_from sub-usage su; and not __fish_seen_subcommand_from help h' -a 'help' -d 'Shows a list of commands or help for one command'
complete -x -c greet -n '__fish_seen_subcommand_from usage u; and not __fish_seen_subcommand_from sub-usage su help h' -a 'help' -d 'Shows a list of commands or help for one command'
Loading