add completion for -b or --fqbn for every command

arduino · umbynos · Oct 18, 2021 · Oct 18, 2021 · Oct 18, 2021 · Oct 5, 2021
commit 9d61a6eac559432203e9fd9fa40ec47c15f076f5
diff --git a/cli/arguments/completion.go b/cli/arguments/completion.go
@@ -0,0 +1,28 @@
+package arguments
+
+import (
+	"context"
+
+	"github.com/arduino/arduino-cli/cli/instance"
+	"github.com/arduino/arduino-cli/commands/board"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
+)
+
+// GetInstalledBoards is an helper function usefull to autocomplete.
+// It returns a list of fqbn
+// it's taken from cli/board/listall.go
+func GetInstalledBoards(toComplete string) []string {
+	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
+
+	list, _ := board.ListAll(context.Background(), &rpc.BoardListAllRequest{
+		Instance:            inst,
+		SearchArgs:          nil,
+		IncludeHiddenBoards: false,
+	})
+	var res []string
+	// transform the data structure for the completion
+	for _, i := range list.GetBoards() {
+		res = append(res, i.Fqbn)
+	}
+	return res
+}
diff --git a/cli/board/details.go b/cli/board/details.go
@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
@@ -48,6 +49,9 @@ func initDetailsCommand() *cobra.Command {
 
 	detailsCommand.Flags().BoolVarP(&showFullDetails, "full", "f", false, tr("Show full board details"))
 	detailsCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", tr("Fully Qualified Board Name, e.g.: arduino:avr:uno"))
+	detailsCommand.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return arguments.GetInstalledBoards(toComplete), cobra.ShellCompDirectiveDefault
+	})
 	detailsCommand.Flags().BoolVarP(&listProgrammers, "list-programmers", "", false, tr("Show list of available programmers"))
 	// detailsCommand.MarkFlagRequired("fqbn") // enable once `board details <fqbn>` is removed
 

diff --git a/cli/burnbootloader/burnbootloader.go b/cli/burnbootloader/burnbootloader.go
@@ -51,6 +51,9 @@ func NewCommand() *cobra.Command {
 	}
 
 	burnBootloaderCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", tr("Fully Qualified Board Name, e.g.: arduino:avr:uno"))
+	burnBootloaderCommand.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return arguments.GetInstalledBoards(toComplete), cobra.ShellCompDirectiveDefault
+	})
 	port.AddToCommand(burnBootloaderCommand)
 	burnBootloaderCommand.Flags().BoolVarP(&verify, "verify", "t", false, tr("Verify uploaded binary after the upload."))
 	burnBootloaderCommand.Flags().BoolVarP(&verbose, "verbose", "v", false, tr("Turns on verbose mode."))

diff --git a/cli/compile/compile.go b/cli/compile/compile.go
@@ -31,7 +31,6 @@ import (
 
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/instance"
-	"github.com/arduino/arduino-cli/commands/board"
 	"github.com/arduino/arduino-cli/commands/compile"
 	"github.com/arduino/arduino-cli/commands/upload"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -84,7 +83,7 @@ func NewCommand() *cobra.Command {
 
 	command.Flags().StringVarP(&fqbn, "fqbn", "b", "", tr("Fully Qualified Board Name, e.g.: arduino:avr:uno"))
 	command.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return getBoards(toComplete), cobra.ShellCompDirectiveDefault
+		return arguments.GetInstalledBoards(toComplete), cobra.ShellCompDirectiveDefault
 	})
 	command.Flags().BoolVar(&showProperties, "show-properties", false, tr("Show all build properties used instead of compiling."))
 	command.Flags().BoolVar(&preprocess, "preprocess", false, tr("Print preprocessed code to stdout instead of compiling."))
@@ -276,19 +275,3 @@ func (r *compileResult) String() string {
 	// The output is already printed via os.Stdout/os.Stdin
 	return ""
 }
-
-func getBoards(toComplete string) []string {
-	// from listall.go TODO optimize
-	inst := instance.CreateAndInit()
-
-	list, _ := board.ListAll(context.Background(), &rpc.BoardListAllRequest{
-		Instance:            inst,
-		SearchArgs:          nil,
-		IncludeHiddenBoards: false,
-	})
-	var res []string
-	for _, i := range list.GetBoards() {
-		res = append(res, i.Fqbn)
-	}
-	return res
-}
diff --git a/cli/debug/debug.go b/cli/debug/debug.go
@@ -59,6 +59,9 @@ func NewCommand() *cobra.Command {
 	}
 
 	debugCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", tr("Fully Qualified Board Name, e.g.: arduino:avr:uno"))
+	debugCommand.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return arguments.GetInstalledBoards(toComplete), cobra.ShellCompDirectiveDefault
+	})
 	port.AddToCommand(debugCommand)
 	debugCommand.Flags().StringVarP(&programmer, "programmer", "P", "", tr("Programmer to use for debugging"))
 	debugCommand.Flags().StringVar(&interpreter, "interpreter", "console", tr("Debug interpreter e.g.: %s", "console, mi, mi1, mi2, mi3"))

diff --git a/cli/lib/examples.go b/cli/lib/examples.go
@@ -22,6 +22,7 @@ import (
 	"sort"
 	"strings"
 
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
 	"github.com/arduino/arduino-cli/cli/instance"
@@ -43,6 +44,9 @@ func initExamplesCommand() *cobra.Command {
 		Run:     runExamplesCommand,
 	}
 	examplesCommand.Flags().StringVarP(&examplesFlags.fqbn, "fqbn", "b", "", tr("Show libraries for the specified board FQBN."))
+	examplesCommand.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return arguments.GetInstalledBoards(toComplete), cobra.ShellCompDirectiveDefault
+	})
 	return examplesCommand
 }
 

diff --git a/cli/upload/upload.go b/cli/upload/upload.go
@@ -55,6 +55,9 @@ func NewCommand() *cobra.Command {
 	}
 
 	uploadCommand.Flags().StringVarP(&fqbn, "fqbn", "b", "", tr("Fully Qualified Board Name, e.g.: arduino:avr:uno"))
+	uploadCommand.RegisterFlagCompletionFunc("fqbn", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+		return arguments.GetInstalledBoards(toComplete), cobra.ShellCompDirectiveDefault
+	})
 	port.AddToCommand(uploadCommand)
 	uploadCommand.Flags().StringVarP(&importDir, "input-dir", "", "", tr("Directory containing binaries to upload."))
 	uploadCommand.Flags().StringVarP(&importFile, "input-file", "i", "", tr("Binary file to upload."))