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)
@@ -63,6 +64,6 @@ var allowCmd = &cobra.Command{
 }
 
 func init() {
-	allowCmd.Flags().AddFlagSet(common.SelectorNAFlags)
+	common.AddSelectorNAFlags(allowCmd)
 	allowCmd.Flags().AddFlagSet(common.TxFlags)
 }

cmd/account/amend_commission_schedule.go

@@ -174,7 +174,7 @@ func init() {
 			"The minimum rate is rate_min_numerator divided by %v, and the maximum rate is "+
 			"rate_max_numerator divided by %v", staking.CommissionRateDenominator, staking.CommissionRateDenominator,
 	))
-	amendCommissionScheduleCmd.Flags().AddFlagSet(common.SelectorNAFlags)
+	common.AddSelectorNAFlags(amendCommissionScheduleCmd)
 	amendCommissionScheduleCmd.Flags().AddFlagSet(common.TxFlags)
 	amendCommissionScheduleCmd.Flags().AddFlagSet(f)
 }

cmd/account/burn.go

@@ -53,6 +53,6 @@ var burnCmd = &cobra.Command{
 }
 
 func init() {
-	burnCmd.Flags().AddFlagSet(common.SelectorNAFlags)
+	common.AddSelectorNAFlags(burnCmd)
 	burnCmd.Flags().AddFlagSet(common.TxFlags)
 }

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)
@@ -122,6 +123,6 @@ var delegateCmd = &cobra.Command{
 }
 
 func init() {
-	delegateCmd.Flags().AddFlagSet(common.SelectorFlags)
+	common.AddSelectorFlags(delegateCmd)
 	delegateCmd.Flags().AddFlagSet(common.RuntimeTxFlags)
 }

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)
@@ -116,7 +117,7 @@ var depositCmd = &cobra.Command{
 }
 
 func init() {
-	depositCmd.Flags().AddFlagSet(common.SelectorFlags)
+	common.AddSelectorFlags(depositCmd)
 	depositCmd.Flags().AddFlagSet(common.RuntimeTxFlags)
 	depositCmd.Flags().AddFlagSet(common.ForceFlag)
 }

cmd/account/entity.go

@@ -235,10 +235,10 @@ func init() {
 	entityInitCmd.Flags().AddFlagSet(common.AccountFlag)
 	entityInitCmd.Flags().AddFlagSet(common.AnswerYesFlag)
 
-	entityRegisterCmd.Flags().AddFlagSet(common.SelectorNAFlags)
+	common.AddSelectorNAFlags(entityRegisterCmd)
 	entityRegisterCmd.Flags().AddFlagSet(common.TxFlags)
 
-	entityDeregisterCmd.Flags().AddFlagSet(common.SelectorNAFlags)
+	common.AddSelectorNAFlags(entityDeregisterCmd)
 	entityDeregisterCmd.Flags().AddFlagSet(common.TxFlags)
 
 	entityMetadataUpdateCmd.Flags().StringVarP(&registryPath, "registry-dir", "r", "", "path to the metadata registry directory")

cmd/account/node_unfreeze.go

@@ -53,6 +53,6 @@ var nodeUnfreezeCmd = &cobra.Command{
 }
 
 func init() {
-	nodeUnfreezeCmd.Flags().AddFlagSet(common.SelectorNAFlags)
+	common.AddSelectorNAFlags(nodeUnfreezeCmd)
 	nodeUnfreezeCmd.Flags().AddFlagSet(common.TxFlags)
 }

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)
@@ -241,7 +242,7 @@ var (
 func init() {
 	f := flag.NewFlagSet("", flag.ContinueOnError)
 	f.BoolVar(&showDelegations, "show-delegations", false, "show incoming and outgoing delegations")
-	Cmd.Flags().AddFlagSet(common.SelectorFlags)
+	common.AddSelectorFlags(Cmd)
 	Cmd.Flags().AddFlagSet(common.HeightFlag)
 	Cmd.Flags().AddFlagSet(f)
 }