support for zsh auto-completion - #983

cmd/genautocomplete/genautocomplete.go

@@ -1,44 +1,19 @@
 package genautocomplete
 
 import (
-	"log"
-
 	"github.com/ncw/rclone/cmd"
 	"github.com/spf13/cobra"
 )
 
 func init() {
-	cmd.Root.AddCommand(commandDefintion)
+	cmd.Root.AddCommand(completionDefinition)
 }
 
-var commandDefintion = &cobra.Command{
-	Use:   "genautocomplete [output_file]",
-	Short: `Output bash completion script for rclone.`,
+var completionDefinition = &cobra.Command{
+	Use:   "genautocomplete [shell]",
+	Short: `Output completion script for a given shell.`,
 	Long: `
-Generates a bash shell autocompletion script for rclone.
-
-This writes to /etc/bash_completion.d/rclone by default so will
-probably need to be run with sudo or as root, eg
-
-    sudo rclone genautocomplete
-
-Logout and login again to use the autocompletion scripts, or source
-them directly
-
-    . /etc/bash_completion
-
-If you supply a command line argument the script will be written
-there.
+Generates a shell completion script for rclone.
+Run with --help to list the supported shells.
 `,
-	Run: func(command *cobra.Command, args []string) {
-		cmd.CheckArgs(0, 1, command, args)
-		out := "/etc/bash_completion.d/rclone"
-		if len(args) > 0 {
-			out = args[0]
-		}
-		err := cmd.Root.GenBashCompletionFile(out)
-		if err != nil {
-			log.Fatal(err)
-		}
-	},
 }

cmd/genautocomplete/genautocomplete_bash.go

@@ -0,0 +1,44 @@
+package genautocomplete
+
+import (
+	"log"
+
+	"github.com/ncw/rclone/cmd"
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	completionDefinition.AddCommand(bashCommandDefinition)
+}
+
+var bashCommandDefinition = &cobra.Command{
+	Use:   "bash [output_file]",
+	Short: `Output bash completion script for rclone.`,
+	Long: `
+Generates a bash shell autocompletion script for rclone.
+
+This writes to /etc/bash_completion.d/rclone by default so will
+probably need to be run with sudo or as root, eg
+
+    sudo rclone genautocomplete bash
+
+Logout and login again to use the autocompletion scripts, or source
+them directly
+
+    . /etc/bash_completion
+
+If you supply a command line argument the script will be written
+there.
+`,
+	Run: func(command *cobra.Command, args []string) {
+		cmd.CheckArgs(0, 1, command, args)
+		out := "/etc/bash_completion.d/rclone"
+		if len(args) > 0 {
+			out = args[0]
+		}
+		err := cmd.Root.GenBashCompletionFile(out)
+		if err != nil {
+			log.Fatal(err)
+		}
+	},
+}

cmd/genautocomplete/genautocomplete_test.go

@@ -0,0 +1,35 @@
+package genautocomplete
+
+import (
+	"io/ioutil"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestCompletionBash(t *testing.T) {
+	tempFile, err := ioutil.TempFile("", "completion_bash")
+	assert.NoError(t, err)
+	defer func() { _ = tempFile.Close() }()
+	defer func() { _ = os.Remove(tempFile.Name()) }()
+
+	bashCommandDefinition.Run(bashCommandDefinition, []string{tempFile.Name()})
+
+	bs, err := ioutil.ReadFile(tempFile.Name())
+	assert.NoError(t, err)
+	assert.NotEmpty(t, string(bs))
+}
+
+func TestCompletionZsh(t *testing.T) {
+	tempFile, err := ioutil.TempFile("", "completion_zsh")
+	assert.NoError(t, err)
+	defer func() { _ = tempFile.Close() }()
+	defer func() { _ = os.Remove(tempFile.Name()) }()
+
+	zshCommandDefinition.Run(zshCommandDefinition, []string{tempFile.Name()})
+
+	bs, err := ioutil.ReadFile(tempFile.Name())
+	assert.NoError(t, err)
+	assert.NotEmpty(t, string(bs))
+}

cmd/genautocomplete/genautocomplete_zsh.go

@@ -0,0 +1,50 @@
+package genautocomplete
+
+import (
+	"log"
+	"os"
+
+	"github.com/ncw/rclone/cmd"
+	"github.com/spf13/cobra"
+)
+
+func init() {
+	completionDefinition.AddCommand(zshCommandDefinition)
+}
+
+var zshCommandDefinition = &cobra.Command{
+	Use:   "zsh [output_file]",
+	Short: `Output zsh completion script for rclone.`,
+	Long: `
+Generates a zsh autocompletion script for rclone.
+
+This writes to /usr/share/zsh/vendor-completions/_rclone by default so will
+probably need to be run with sudo or as root, eg
+
+    sudo rclone genautocomplete zsh
+
+Logout and login again to use the autocompletion scripts, or source
+them directly
+
+    autoload -U compinit && compinit
+
+If you supply a command line argument the script will be written
+there.
+`,
+	Run: func(command *cobra.Command, args []string) {
+		cmd.CheckArgs(0, 1, command, args)
+		out := "/usr/share/zsh/vendor-completions/_rclone"
+		if len(args) > 0 {
+			out = args[0]
+		}
+		outFile, err := os.Create(out)
+		if err != nil {
+			log.Fatal(err)
+		}
+		defer func() { _ = outFile.Close() }()
+		err = cmd.Root.GenZshCompletion(outFile)
+		if err != nil {
+			log.Fatal(err)
+		}
+	},
+}