Merge pull request urfave#2122 from bittrance/fish-completion-hidden-commands

Fish completion inside hidden commands

Author: dearchap

command_test.go

@@ -98,6 +98,11 @@ func buildExtendedTestCommand() *Command {
 	}, {
 		Name:   "hidden-command",
 		Hidden: true,
+		Flags: []Flag{
+			&BoolFlag{
+				Name: "completable",
+			},
+		},
 	}, {
 		Aliases: []string{"u"},
 		Flags: []Flag{
@@ -4876,7 +4881,26 @@ func TestJSONExportCommand(t *testing.T) {
 			"defaultCommand": "",
 			"category": "",
 			"commands": null,
-			"flags": null,
+			"flags": [
+			  {
+				"name": "completable",
+				"category": "",
+				"defaultText": "",
+				"usage": "",
+				"required": false,
+				"hidden": false,
+				"hideDefault": false,
+				"local": false,
+				"defaultValue": false,
+				"aliases": null,
+				"takesFileArg": false,
+				"config": {
+				  "Count": null
+				},
+				"onlyOnce": false,
+				"validateDefaults": false
+			  }
+			],
 			"hideHelp": false,
 			"hideHelpCommand": false,
 			"hideVersion": false,

fish.go

@@ -37,7 +37,7 @@ func (cmd *Command) writeFishCompletionTemplate(w io.Writer) error {
 	// Add commands and their flags
 	completions = append(
 		completions,
-		cmd.prepareFishCommands(cmd.VisibleCommands(), []string{})...,
+		cmd.prepareFishCommands(cmd.Commands, []string{})...,
 	)
 
 	toplevelCommandNames := []string{}
@@ -55,20 +55,22 @@ func (cmd *Command) writeFishCompletionTemplate(w io.Writer) error {
 func (cmd *Command) prepareFishCommands(commands []*Command, previousCommands []string) []string {
 	completions := []string{}
 	for _, command := range commands {
-		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(), " "),
-		)
-
-		if command.Usage != "" {
+		if !command.Hidden {
+			var completion strings.Builder
 			fmt.Fprintf(&completion,
-				" -d '%s'",
-				escapeSingleQuotes(command.Usage))
+				"complete -x -c %s -n '%s' -a '%s'",
+				cmd.Name,
+				cmd.fishSubcommandHelper(previousCommands, commands),
+				strings.Join(command.Names(), " "),
+			)
+
+			if command.Usage != "" {
+				fmt.Fprintf(&completion,
+					" -d '%s'",
+					escapeSingleQuotes(command.Usage))
+			}
+			completions = append(completions, completion.String())
 		}
-		completions = append(completions, completion.String())
 		completions = append(
 			completions,
 			cmd.prepareFishFlags(command.VisibleFlags(), command.Names())...,

testdata/expected-fish-full.fish

@@ -22,6 +22,7 @@ complete -c greet -n '__fish_seen_subcommand_from sub-config s ss' -f -l sub-fla
 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 -x -c greet -n '__fish_greet_no_subcommand' -a 'some-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 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'