Merge pull request cli#39 from github/completion

mislav · web-flow · commit cdd495160ce9 · 2019-11-06T19:31:29.000+01:00
Add `completion` script
diff --git a/command/completion.go b/command/completion.go
@@ -0,0 +1,43 @@
+package command
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	RootCmd.AddCommand(completionCmd)
+	completionCmd.Flags().StringP("shell", "s", "bash", "The type of shell")
+}
+
+var completionCmd = &cobra.Command{
+	Use:    "completion",
+	Hidden: true,
+	Short:  "Generates completion scripts",
+	Long: `To enable completion in your shell, run:
+
+  eval "$(gh completion)"
+
+You can add that to your '~/.bash_profile' to enable completion whenever you
+start a new shell.
+
+When installing with Homebrew, see https://docs.brew.sh/Shell-Completion
+`,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		shellType, err := cmd.Flags().GetString("shell")
+		if err != nil {
+			return err
+		}
+
+		switch shellType {
+		case "bash":
+			RootCmd.GenBashCompletion(cmd.OutOrStdout())
+		case "zsh":
+			RootCmd.GenZshCompletion(cmd.OutOrStdout())
+		default:
+			return fmt.Errorf("unsupported shell type: %s", shellType)
+		}
+		return nil
+	},
+}
diff --git a/command/completion_test.go b/command/completion_test.go
@@ -0,0 +1,50 @@
+package command
+
+import (
+	"bytes"
+	"strings"
+	"testing"
+)
+
+func TestCompletion_bash(t *testing.T) {
+	out := bytes.Buffer{}
+	completionCmd.SetOut(&out)
+
+	RootCmd.SetArgs([]string{"completion"})
+	_, err := RootCmd.ExecuteC()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	outStr := out.String()
+	if !strings.Contains(outStr, "complete -o default -F __start_gh gh") {
+		t.Errorf("problem in bash completion:\n%s", outStr)
+	}
+}
+
+func TestCompletion_zsh(t *testing.T) {
+	out := bytes.Buffer{}
+	completionCmd.SetOut(&out)
+
+	RootCmd.SetArgs([]string{"completion", "-s", "zsh"})
+	_, err := RootCmd.ExecuteC()
+	if err != nil {
+		t.Fatal(err)
+	}
+
+	outStr := out.String()
+	if !strings.Contains(outStr, "#compdef _gh gh") {
+		t.Errorf("problem in zsh completion:\n%s", outStr)
+	}
+}
+
+func TestCompletion_unsupported(t *testing.T) {
+	out := bytes.Buffer{}
+	completionCmd.SetOut(&out)
+
+	RootCmd.SetArgs([]string{"completion", "-s", "fish"})
+	_, err := RootCmd.ExecuteC()
+	if err == nil || err.Error() != "unsupported shell type: fish" {
+		t.Fatal(err)
+	}
+}
