feat(cmd): add fish completion (#2517)

Add fish completion for the CLI

Author: chenrui333

go.sum

@@ -174,8 +174,6 @@ github.com/bombsimon/wsl/v3 v3.1.0/go.mod h1:st10JtZYLE4D5sC7b8xV4zTKZwAQjCH/Hy2
 github.com/bradfitz/go-smtpd v0.0.0-20170404230938-deb6d6237625/go.mod h1:HYsPBTaaSFSlLx/70C2HPIMNZpVV8+vt/A+FMnYP11g=
 github.com/briandowns/spinner v1.15.0 h1:L0jR0MYN7OAeMwpTzDZWIeqyDLXtTeJFxqoq+sL0VQM=
 github.com/briandowns/spinner v1.15.0/go.mod h1:QOuQk7x+EaDASo80FEXwlwiA+j/PPIcX3FScO+3/ZPQ=
-github.com/briandowns/spinner v1.16.0 h1:DFmp6hEaIx2QXXuqSJmtfSBSAjRmpGiKG6ip2Wm/yOs=
-github.com/briandowns/spinner v1.16.0/go.mod h1:QOuQk7x+EaDASo80FEXwlwiA+j/PPIcX3FScO+3/ZPQ=
 github.com/bshuster-repo/logrus-logstash-hook v0.4.1/go.mod h1:zsTqEiSzDgAa/8GZR7E1qaXrhYNDKBYy5/dWPTIflbk=
 github.com/bugsnag/bugsnag-go v0.0.0-20141110184014-b1d153021fcd/go.mod h1:2oa8nejYd4cQ/b0hMIopN0lCRxU0bueqREvZLWFrtK8=
 github.com/bugsnag/osext v0.0.0-20130617224835-0dd3f918b21b/go.mod h1:obH5gd0BsqsP2LwDJ9aOkm/6J86V6lyAXCoQWGw3K50=
@@ -1327,7 +1325,6 @@ golang.org/x/tools v0.0.0-20210105154028-b0ab187a4818/go.mod h1:emZCQorbCU4vsT4f
 golang.org/x/tools v0.0.0-20210106214847-113979e3529a/go.mod h1:emZCQorbCU4vsT4fOWvOPXz4eW1wZW4PmDk9uLelYpA=
 golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
-golang.org/x/tools v0.1.2 h1:kRBLX7v7Af8W7Gdbbc908OJcdgtK8bOz9Uaj8/F1ACA=
 golang.org/x/tools v0.1.2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

internal/pkg/cli/completion.go

@@ -17,24 +17,28 @@ import (
 type shellCompleter interface {
 	GenBashCompletion(w io.Writer) error
 	GenZshCompletion(w io.Writer) error
+	GenFishCompletion(w io.Writer, includeDesc bool) error
 }
 
 type completionOpts struct {
-	Shell string // must be "bash" or "zsh"
+	Shell string // must be "bash" or "zsh" or "fish"
 
 	w         io.Writer
 	completer shellCompleter
 }
 
-// Validate returns an error if the shell is not "bash" or "zsh".
+// Validate returns an error if the shell is not "bash" or "zsh" or "fish".
 func (opts *completionOpts) Validate() error {
 	if opts.Shell == "bash" {
 		return nil
 	}
 	if opts.Shell == "zsh" {
 		return nil
 	}
-	return errors.New("shell must be bash or zsh")
+	if opts.Shell == "fish" {
+		return nil
+	}
+	return errors.New("shell must be bash, zsh or fish")
 }
 
 // Execute writes the completion code to the writer.
@@ -43,16 +47,19 @@ func (opts *completionOpts) Execute() error {
 	if opts.Shell == "bash" {
 		return opts.completer.GenBashCompletion(opts.w)
 	}
-	return opts.completer.GenZshCompletion(opts.w)
+	if opts.Shell == "zsh" {
+		return opts.completer.GenZshCompletion(opts.w)
+	}
+	return opts.completer.GenFishCompletion(opts.w, true)
 }
 
-// BuildCompletionCmd returns the command to output shell completion code for the specified shell (bash or zsh).
+// BuildCompletionCmd returns the command to output shell completion code for the specified shell (bash or zsh or fish).
 func BuildCompletionCmd(rootCmd *cobra.Command) *cobra.Command {
 	opts := &completionOpts{}
 	cmd := &cobra.Command{
 		Use:   "completion [shell]",
 		Short: "Output shell completion code.",
-		Long: `Output shell completion code for bash or zsh.
+		Long: `Output shell completion code for bash, zsh or fish.
 The code must be evaluated to provide interactive completion of commands.`,
 		Example: `
   Install zsh completion
@@ -67,10 +74,16 @@ The code must be evaluated to provide interactive completion of commands.`,
   Install bash completion on linux
   /code $ source <(copilot completion bash)
   /code $ copilot completion bash > copilot.sh
-  /code $ sudo mv copilot.sh /etc/bash_completion.d/copilot`,
+  /code $ sudo mv copilot.sh /etc/bash_completion.d/copilot
+
+  Install fish completion
+  /code$ copilot completion fish | source
+
+  To load completions for each session, execute once:
+  /code$ copilot completion fish > ~/.config/fish/completions/copilot.fish`,
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(args) != 1 {
-				return errors.New("requires a single shell argument (bash or zsh)")
+				return errors.New("requires a single shell argument (bash, zsh or fish)")
 			}
 			return nil
 		},

internal/pkg/cli/completion_test.go

@@ -25,9 +25,13 @@ func TestCompletionOpts_Validate(t *testing.T) {
 			inputShell:  "bash",
 			wantedError: nil,
 		},
+		"fish": {
+			inputShell:  "fish",
+			wantedError: nil,
+		},
 		"invalid shell": {
 			inputShell:  "chicken",
-			wantedError: errors.New("shell must be bash or zsh"),
+			wantedError: errors.New("shell must be bash, zsh or fish"),
 		},
 	}
 
@@ -63,13 +67,23 @@ func TestCompletionOpts_Execute(t *testing.T) {
 			mocking: func(mock *mocks.MockshellCompleter) {
 				mock.EXPECT().GenBashCompletion(gomock.Any()).Times(1)
 				mock.EXPECT().GenZshCompletion(gomock.Any()).Times(0)
+				mock.EXPECT().GenFishCompletion(gomock.Any(), gomock.Any()).Times(0)
 			},
 		},
 		"zsh": {
 			inputShell: "zsh",
 			mocking: func(mock *mocks.MockshellCompleter) {
 				mock.EXPECT().GenBashCompletion(gomock.Any()).Times(0)
 				mock.EXPECT().GenZshCompletion(gomock.Any()).Times(1)
+				mock.EXPECT().GenFishCompletion(gomock.Any(), gomock.Any()).Times(0)
+			},
+		},
+		"fish": {
+			inputShell: "fish",
+			mocking: func(mock *mocks.MockshellCompleter) {
+				mock.EXPECT().GenBashCompletion(gomock.Any()).Times(0)
+				mock.EXPECT().GenZshCompletion(gomock.Any()).Times(0)
+				mock.EXPECT().GenFishCompletion(gomock.Any(), gomock.Any()).Times(1)
 			},
 		},
 	}

internal/pkg/cli/mocks/mock_completion.go

@@ -4,7 +4,7 @@ $ copilot completion [shell] [flags]
 ```
 
 ## What does it do?
-`copilot completion` prints shell completion code for bash or zsh. The code must be evaluated to provide interactive completion of commands.
+`copilot completion` prints shell completion code for bash, zsh or fish. The code must be evaluated to provide interactive completion of commands.
 
 See the help menu for instructions on how to setup auto-completion for your respective shell.
 
@@ -30,4 +30,9 @@ Install bash completion on linux
 $ source <(copilot completion bash)
 $ copilot completion bash > copilot.sh
 $ sudo mv copilot.sh /etc/bash_completion.d/copilot
-```
+```
+Install fish completion on linux
+```bash
+$ source <(copilot completion fish)
+$ copilot completion fish > ~/.config/fish/completions/copilot.fish
+```