Experiment with adding autocomplete

Author: ptrus

.gitignore

@@ -1,5 +1,7 @@
 # Ignore Oasis CLI binary.
 oasis
+# Ignore generated completions (created by goreleaser).
+completions/
 # Ignore Python cache directories.
 __pycache__/
 # Ignore temporary files.

.goreleaser.yaml

@@ -5,6 +5,10 @@ project_name: Oasis CLI
 before:
   hooks:
     - go mod tidy
+    - mkdir -p completions
+    - sh -c "go run . completion bash > completions/oasis.bash"
+    - sh -c "go run . completion zsh > completions/oasis.zsh"
+    - sh -c "go run . completion fish > completions/oasis.fish"
 
 universal_binaries:
   - id: oasis-darwin-universal
@@ -82,6 +86,8 @@ archives:
     format_overrides:
       - goos: windows
         formats: [ 'zip' ]
+    files:
+      - completions/*
 
 checksum:
   name_template: SHA256SUMS-{{.Version}}.txt

cmd/account/allow.go

@@ -14,9 +14,10 @@ import (
 )
 
 var allowCmd = &cobra.Command{
-	Use:   "allow <beneficiary> <amount>",
-	Short: "Configure beneficiary allowance",
-	Args:  cobra.ExactArgs(2),
+	Use:               "allow <beneficiary> <amount>",
+	Short:             "Configure beneficiary allowance",
+	Args:              cobra.ExactArgs(2),
+	ValidArgsFunction: common.AddressesAt(0), // <beneficiary> at position 1.
 	Run: func(_ *cobra.Command, args []string) {
 		cfg := cliConfig.Global()
 		npa := common.GetNPASelection(cfg)

cmd/account/delegate.go

@@ -18,9 +18,10 @@ import (
 )
 
 var delegateCmd = &cobra.Command{
-	Use:   "delegate <amount> <to>",
-	Short: "Delegate given amount of tokens to an entity",
-	Args:  cobra.ExactArgs(2),
+	Use:               "delegate <amount> <to>",
+	Short:             "Delegate given amount of tokens to an entity",
+	Args:              cobra.ExactArgs(2),
+	ValidArgsFunction: common.AddressesAt(1), // <to> at position 2.
 	Run: func(_ *cobra.Command, args []string) {
 		cfg := cliConfig.Global()
 		npa := common.GetNPASelection(cfg)

cmd/account/deposit.go

@@ -20,9 +20,10 @@ import (
 )
 
 var depositCmd = &cobra.Command{
-	Use:   "deposit <amount> [to]",
-	Short: "Deposit tokens into ParaTime",
-	Args:  cobra.RangeArgs(1, 2),
+	Use:               "deposit <amount> [to]",
+	Short:             "Deposit tokens into ParaTime",
+	Args:              cobra.RangeArgs(1, 2),
+	ValidArgsFunction: common.AddressesAt(1), // [to] at position 2.
 	Run: func(_ *cobra.Command, args []string) {
 		cfg := cliConfig.Global()
 		npa := common.GetNPASelection(cfg)

cmd/account/show/show.go

@@ -26,10 +26,11 @@ var (
 	showDelegations bool
 
 	Cmd = &cobra.Command{
-		Use:     "show [address]",
-		Short:   "Show balance and other information",
-		Aliases: []string{"s", "balance", "b"},
-		Args:    cobra.MaximumNArgs(1),
+		Use:               "show [address]",
+		Short:             "Show balance and other information",
+		Aliases:           []string{"s", "balance", "b"},
+		Args:              cobra.MaximumNArgs(1),
+		ValidArgsFunction: common.CompleteAccountAndAddressBookNames,
 		Run: func(_ *cobra.Command, args []string) {
 			cfg := cliConfig.Global()
 			npa := common.GetNPASelection(cfg)

cmd/account/transfer.go

@@ -18,10 +18,11 @@ import (
 )
 
 var transferCmd = &cobra.Command{
-	Use:     "transfer <amount> [<denom>] <to>",
-	Short:   "Transfer given amount of tokens",
-	Aliases: []string{"t"},
-	Args:    cobra.RangeArgs(2, 3),
+	Use:               "transfer <amount> [<denom>] <to>",
+	Short:             "Transfer given amount of tokens",
+	Aliases:           []string{"t"},
+	Args:              cobra.RangeArgs(2, 3),
+	ValidArgsFunction: common.AddressesAt(1, 2), // <to> can be at position 2 or 3.
 	Run: func(_ *cobra.Command, args []string) {
 		cfg := cliConfig.Global()
 		npa := common.GetNPASelection(cfg)

cmd/account/undelegate.go

@@ -18,9 +18,10 @@ import (
 )
 
 var undelegateCmd = &cobra.Command{
-	Use:   "undelegate <shares> <from>",
-	Short: "Undelegate given amount of shares from an entity",
-	Args:  cobra.ExactArgs(2),
+	Use:               "undelegate <shares> <from>",
+	Short:             "Undelegate given amount of shares from an entity",
+	Args:              cobra.ExactArgs(2),
+	ValidArgsFunction: common.AddressesAt(1), // <from> at position 2.
 	Run: func(_ *cobra.Command, args []string) {
 		cfg := cliConfig.Global()
 		npa := common.GetNPASelection(cfg)

cmd/account/withdraw.go

@@ -19,9 +19,10 @@ import (
 )
 
 var withdrawCmd = &cobra.Command{
-	Use:   "withdraw <amount> [to]",
-	Short: "Withdraw tokens from ParaTime",
-	Args:  cobra.RangeArgs(1, 2),
+	Use:               "withdraw <amount> [to]",
+	Short:             "Withdraw tokens from ParaTime",
+	Args:              cobra.RangeArgs(1, 2),
+	ValidArgsFunction: common.AddressesAt(1), // [to] at position 2.
 	Run: func(_ *cobra.Command, args []string) {
 		cfg := cliConfig.Global()
 		npa := common.GetNPASelection(cfg)

cmd/addressbook.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/spf13/cobra"
 
+	"github.com/oasisprotocol/cli/cmd/common"
 	"github.com/oasisprotocol/cli/config"
 	"github.com/oasisprotocol/cli/table"
 )
@@ -70,9 +71,10 @@ var (
 	}
 
 	abShowCmd = &cobra.Command{
-		Use:   "show <name>",
-		Short: "Show address information",
-		Args:  cobra.ExactArgs(1),
+		Use:               "show <name>",
+		Short:             "Show address information",
+		Args:              cobra.ExactArgs(1),
+		ValidArgsFunction: common.CompleteAddressBookNames,
 		Run: func(_ *cobra.Command, args []string) {
 			name := args[0]
 			abEntry, ok := config.Global().AddressBook.All[name]
@@ -89,10 +91,11 @@ var (
 	}
 
 	abRmCmd = &cobra.Command{
-		Use:     "remove <name>",
-		Aliases: []string{"rm"},
-		Short:   "Remove an address from address book",
-		Args:    cobra.ExactArgs(1),
+		Use:               "remove <name>",
+		Aliases:           []string{"rm"},
+		Short:             "Remove an address from address book",
+		Args:              cobra.ExactArgs(1),
+		ValidArgsFunction: common.CompleteAddressBookNames,
 		Run: func(_ *cobra.Command, args []string) {
 			cfg := config.Global()
 			name := args[0]
@@ -106,10 +109,11 @@ var (
 	}
 
 	abRenameCmd = &cobra.Command{
-		Use:     "rename <old> <new>",
-		Aliases: []string{"mv"},
-		Short:   "Rename address",
-		Args:    cobra.ExactArgs(2),
+		Use:               "rename <old> <new>",
+		Aliases:           []string{"mv"},
+		Short:             "Rename address",
+		Args:              cobra.ExactArgs(2),
+		ValidArgsFunction: common.CompleteAddressBookNames,
 		Run: func(_ *cobra.Command, args []string) {
 			cfg := config.Global()
 			oldName, newName := args[0], args[1]