remove the toComplete parameter from all the completion functions

as of now this parameter is useless because if a string is typed in the terminal it cannot be swapped with a different one. For example if I write `arduino-cli compile -b avr<TAB><TAB>` the completion function returns all elements starting with `arduino:avr...`. So the completions are not showed because they cannot be swapped with a string that starts differently. The only shell which seems to support this seems to be zsh
arduino · umbynos · Oct 18, 2021 · Oct 18, 2021 · Oct 18, 2021 · Oct 5, 2021
commit fe2cf6522809e15aaa7cef3744f4b5c3e5e97e93
diff --git a/cli/arguments/completion.go b/cli/arguments/completion.go
@@ -15,7 +15,7 @@ import (
 // GetInstalledBoards is an helper function useful to autocomplete.
 // It returns a list of fqbn
 // it's taken from cli/board/listall.go
-func GetInstalledBoards(toComplete string) []string {
+func GetInstalledBoards() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 
 	list, _ := board.ListAll(context.Background(), &rpc.BoardListAllRequest{
@@ -33,7 +33,7 @@ func GetInstalledBoards(toComplete string) []string {
 
 // GetInstalledProtocols is an helper function useful to autocomplete.
 // It returns a list of protocols available based on the installed boards
-func GetInstalledProtocols(toComplete string) []string {
+func GetInstalledProtocols() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 	pm := commands.GetPackageManager(inst.Id)
 	boards := pm.InstalledBoards()
@@ -60,7 +60,7 @@ func GetInstalledProtocols(toComplete string) []string {
 
 // GetInstalledProgrammers is an helper function useful to autocomplete.
 // It returns a list of programmers available based on the installed boards
-func GetInstalledProgrammers(toComplete string) []string {
+func GetInstalledProgrammers() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 	pm := commands.GetPackageManager(inst.Id)
 
@@ -91,7 +91,7 @@ func GetInstalledProgrammers(toComplete string) []string {
 
 // GetUninstallableCores is an helper function useful to autocomplete.
 // It returns a list of cores which can be uninstalled
-func GetUninstallableCores(toComplete string) []string {
+func GetUninstallableCores() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 
 	platforms, _ := core.GetPlatforms(&rpc.PlatformListRequest{
@@ -109,7 +109,7 @@ func GetUninstallableCores(toComplete string) []string {
 
 // GetInstallableCores is an helper function useful to autocomplete.
 // It returns a list of cores which can be installed/downloaded
-func GetInstallableCores(toComplete string) []string {
+func GetInstallableCores() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 
 	platforms, _ := core.PlatformSearch(&rpc.PlatformSearchRequest{
@@ -127,7 +127,7 @@ func GetInstallableCores(toComplete string) []string {
 
 // GetUninstallableLibs is an helper function useful to autocomplete.
 // It returns a list of libs which can be uninstalled
-func GetUninstallableLibs(toComplete string) []string {
+func GetUninstallableLibs() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 	libs, _ := lib.LibraryList(context.Background(), &rpc.LibraryListRequest{
 		Instance:  inst,
@@ -146,7 +146,7 @@ func GetUninstallableLibs(toComplete string) []string {
 
 // GetInstallableLibs is an helper function useful to autocomplete.
 // It returns a list of libs which can be installed/downloaded
-func GetInstallableLibs(toComplete string) []string {
+func GetInstallableLibs() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 
 	libs, _ := lib.LibrarySearch(context.Background(), &rpc.LibrarySearchRequest{
@@ -164,7 +164,7 @@ func GetInstallableLibs(toComplete string) []string {
 // GetConnectedBoards is an helper function useful to autocomplete.
 // It returns a list of boards which are currently connected
 // Obviously it does not suggests network ports because of the timeout
-func GetConnectedBoards(toComplete string) []string {
+func GetConnectedBoards() []string {
 	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
 
 	list, _ := board.List(&rpc.BoardListRequest{

diff --git a/cli/arguments/port.go b/cli/arguments/port.go
@@ -43,11 +43,11 @@ type Port struct {
 func (p *Port) AddToCommand(cmd *cobra.Command) {
 	cmd.Flags().StringVarP(&p.address, "port", "p", "", tr("Upload port address, e.g.: COM3 or /dev/ttyACM2"))
 	cmd.RegisterFlagCompletionFunc("port", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return GetConnectedBoards(toComplete), cobra.ShellCompDirectiveDefault
+		return GetConnectedBoards(), cobra.ShellCompDirectiveDefault
 	})
 	cmd.Flags().StringVarP(&p.protocol, "protocol", "l", "", tr("Upload port protocol, e.g: serial"))
 	cmd.RegisterFlagCompletionFunc("protocol", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return GetInstalledProtocols(toComplete), cobra.ShellCompDirectiveDefault
+		return GetInstalledProtocols(), cobra.ShellCompDirectiveDefault
 	})
 	cmd.Flags().DurationVar(&p.timeout, "discovery-timeout", 5*time.Second, tr("Max time to wait for port discovery, e.g.: 30s, 1m"))
 }

diff --git a/cli/board/details.go b/cli/board/details.go
@@ -50,7 +50,7 @@ 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
+		return arguments.GetInstalledBoards(), 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
@@ -52,14 +52,14 @@ 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
+		return arguments.GetInstalledBoards(), 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."))
 	burnBootloaderCommand.Flags().StringVarP(&programmer, "programmer", "P", "", tr("Use the specified programmer to upload."))
 	burnBootloaderCommand.RegisterFlagCompletionFunc("programmer", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return arguments.GetInstalledProgrammers(toComplete), cobra.ShellCompDirectiveDefault
+		return arguments.GetInstalledProgrammers(), cobra.ShellCompDirectiveDefault
 	})
 	burnBootloaderCommand.Flags().BoolVar(&dryRun, "dry-run", false, tr("Do not perform the actual upload, just log out actions"))
 	burnBootloaderCommand.Flags().MarkHidden("dry-run")

diff --git a/cli/compile/compile.go b/cli/compile/compile.go
@@ -83,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 arguments.GetInstalledBoards(toComplete), cobra.ShellCompDirectiveDefault
+		return arguments.GetInstalledBoards(), 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."))
@@ -110,7 +110,7 @@ func NewCommand() *cobra.Command {
 	command.Flags().BoolVar(&optimizeForDebug, "optimize-for-debug", false, tr("Optional, optimize compile output for debugging, rather than for release."))
 	command.Flags().StringVarP(&programmer, "programmer", "P", "", tr("Optional, use the specified programmer to upload."))
 	command.RegisterFlagCompletionFunc("programmer", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return arguments.GetInstalledProgrammers(toComplete), cobra.ShellCompDirectiveDefault
+		return arguments.GetInstalledProgrammers(), cobra.ShellCompDirectiveDefault
 	})
 	command.Flags().BoolVar(&compilationDatabaseOnly, "only-compilation-database", false, tr("Just produce the compilation database, without actually compiling."))
 	command.Flags().BoolVar(&clean, "clean", false, tr("Optional, cleanup the build folder and do not use any cached build."))

diff --git a/cli/config/add.go b/cli/config/add.go
@@ -36,7 +36,7 @@ func initAddCommand() *cobra.Command {
 		Args: cobra.MinimumNArgs(2),
 		Run:  runAddCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return GetConfigurationKeys(toComplete), cobra.ShellCompDirectiveDefault
+			return GetConfigurationKeys(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	return addCommand

diff --git a/cli/config/config.go b/cli/config/config.go
@@ -46,7 +46,7 @@ func NewCommand() *cobra.Command {
 
 // GetConfigurationKeys is an helper function useful to autocomplete.
 // It returns a list of configuration keys which can be changed
-func GetConfigurationKeys(toComplete string) []string {
+func GetConfigurationKeys() []string {
 	var res []string
 	keys := configuration.Settings.AllKeys()
 	for _, key := range keys {

diff --git a/cli/config/remove.go b/cli/config/remove.go
@@ -36,7 +36,7 @@ func initRemoveCommand() *cobra.Command {
 		Args: cobra.MinimumNArgs(2),
 		Run:  runRemoveCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return GetConfigurationKeys(toComplete), cobra.ShellCompDirectiveDefault
+			return GetConfigurationKeys(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	return addCommand

diff --git a/cli/core/download.go b/cli/core/download.go
@@ -42,7 +42,7 @@ func initDownloadCommand() *cobra.Command {
 		Args: cobra.MinimumNArgs(1),
 		Run:  runDownloadCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetInstallableCores(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetInstallableCores(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	return downloadCommand

diff --git a/cli/core/install.go b/cli/core/install.go
@@ -44,7 +44,7 @@ func initInstallCommand() *cobra.Command {
 		Args: cobra.MinimumNArgs(1),
 		Run:  runInstallCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetInstallableCores(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetInstallableCores(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	AddPostInstallFlagsToCommand(installCommand)

diff --git a/cli/core/uninstall.go b/cli/core/uninstall.go
@@ -40,7 +40,7 @@ func initUninstallCommand() *cobra.Command {
 		Args:    cobra.MinimumNArgs(1),
 		Run:     runUninstallCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetUninstallableCores(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetUninstallableCores(), cobra.ShellCompDirectiveDefault
 		},
 	}
 }

diff --git a/cli/debug/debug.go b/cli/debug/debug.go
@@ -60,12 +60,12 @@ 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
+		return arguments.GetInstalledBoards(), cobra.ShellCompDirectiveDefault
 	})
 	port.AddToCommand(debugCommand)
 	debugCommand.Flags().StringVarP(&programmer, "programmer", "P", "", tr("Programmer to use for debugging"))
 	debugCommand.RegisterFlagCompletionFunc("programmer", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return arguments.GetInstalledProgrammers(toComplete), cobra.ShellCompDirectiveDefault
+		return arguments.GetInstalledProgrammers(), cobra.ShellCompDirectiveDefault
 	})
 	debugCommand.Flags().StringVar(&interpreter, "interpreter", "console", tr("Debug interpreter e.g.: %s", "console, mi, mi1, mi2, mi3"))
 	debugCommand.Flags().StringVarP(&importDir, "input-dir", "", "", tr("Directory containing binaries for debug."))

diff --git a/cli/lib/check_deps.go b/cli/lib/check_deps.go
@@ -41,7 +41,7 @@ func initDepsCommand() *cobra.Command {
 		Args: cobra.ExactArgs(1),
 		Run:  runDepsCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetUninstallableLibs(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetUninstallableLibs(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	return depsCommand

diff --git a/cli/lib/download.go b/cli/lib/download.go
@@ -41,7 +41,7 @@ func initDownloadCommand() *cobra.Command {
 		Args: cobra.MinimumNArgs(1),
 		Run:  runDownloadCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetInstallableLibs(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetInstallableLibs(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	return downloadCommand

diff --git a/cli/lib/examples.go b/cli/lib/examples.go
@@ -43,12 +43,12 @@ func initExamplesCommand() *cobra.Command {
 		Args:    cobra.MaximumNArgs(1),
 		Run:     runExamplesCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetUninstallableLibs(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetUninstallableLibs(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	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 arguments.GetInstalledBoards(), cobra.ShellCompDirectiveDefault
 	})
 	return examplesCommand
 }

diff --git a/cli/lib/install.go b/cli/lib/install.go
@@ -48,7 +48,7 @@ func initInstallCommand() *cobra.Command {
 		Args: cobra.MinimumNArgs(1),
 		Run:  runInstallCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetInstallableLibs(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetInstallableLibs(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	installCommand.Flags().BoolVar(&installFlags.noDeps, "no-deps", false, tr("Do not install dependencies."))

diff --git a/cli/lib/uninstall.go b/cli/lib/uninstall.go
@@ -40,7 +40,7 @@ func initUninstallCommand() *cobra.Command {
 		Args:    cobra.MinimumNArgs(1),
 		Run:     runUninstallCommand,
 		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-			return arguments.GetUninstallableLibs(toComplete), cobra.ShellCompDirectiveDefault
+			return arguments.GetUninstallableLibs(), cobra.ShellCompDirectiveDefault
 		},
 	}
 	return uninstallCommand

diff --git a/cli/upload/upload.go b/cli/upload/upload.go
@@ -56,7 +56,7 @@ 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
+		return arguments.GetInstalledBoards(), cobra.ShellCompDirectiveDefault
 	})
 	port.AddToCommand(uploadCommand)
 	uploadCommand.Flags().StringVarP(&importDir, "input-dir", "", "", tr("Directory containing binaries to upload."))
@@ -65,7 +65,7 @@ func NewCommand() *cobra.Command {
 	uploadCommand.Flags().BoolVarP(&verbose, "verbose", "v", false, tr("Optional, turns on verbose mode."))
 	uploadCommand.Flags().StringVarP(&programmer, "programmer", "P", "", tr("Optional, use the specified programmer to upload."))
 	uploadCommand.RegisterFlagCompletionFunc("programmer", func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
-		return arguments.GetInstalledProgrammers(toComplete), cobra.ShellCompDirectiveDefault
+		return arguments.GetInstalledProgrammers(), cobra.ShellCompDirectiveDefault
 	})
 	uploadCommand.Flags().BoolVar(&dryRun, "dry-run", false, tr("Do not perform the actual upload, just log out actions"))
 	uploadCommand.Flags().MarkHidden("dry-run")