add completion for lib install, lib download

Author: umbynos

cli/arguments/completion.go

@@ -146,3 +146,19 @@ func GetUninstallableLibs(toComplete string) []string {
 	return res
 }
 
+// GetInstallableLibs is an helper function useful to autocomplete.
+// It returns a list of libs which can be installed/downloaded
+func GetInstallableLibs(toComplete string) []string {
+	inst := instance.CreateAndInit() // TODO optimize this: it does not make sense to create an instance everytime
+
+	libs, _ := lib.LibrarySearch(context.Background(), &rpc.LibrarySearchRequest{
+		Instance: inst,
+		Query:    "", // if no query is specified all the libs are returned
+	})
+	var res []string
+	// transform the data structure for the completion
+	for _, i := range libs.Libraries {
+		res = append(res, i.Name)
+	}
+	return res
+}

cli/lib/download.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"
@@ -39,6 +40,9 @@ func initDownloadCommand() *cobra.Command {
 			"  " + os.Args[0] + " lib download AudioZero@1.0.0 # " + tr("for a specific version."),
 		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 downloadCommand
 }

cli/lib/install.go

@@ -21,6 +21,7 @@ import (
 	"os"
 	"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/globals"
@@ -46,6 +47,9 @@ func initInstallCommand() *cobra.Command {
 			"  " + os.Args[0] + " lib install --zip-path /path/to/WiFi101.zip /path/to/ArduinoBLE.zip\n",
 		Args: cobra.MinimumNArgs(1),
 		Run:  runInstallCommand,
+		ValidArgsFunction: func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
+			return arguments.GetInstallableLibs(toComplete), cobra.ShellCompDirectiveDefault
+		},
 	}
 	installCommand.Flags().BoolVar(&installFlags.noDeps, "no-deps", false, tr("Do not install dependencies."))
 	installCommand.Flags().BoolVar(&installFlags.gitURL, "git-url", false, tr("Enter git url for libraries hosted on repositories"))

i18n/data/en.po

@@ -83,11 +83,11 @@ msgstr "(hidden)"
 msgid "(legacy)"
 msgstr "(legacy)"
 
-#: cli/lib/install.go:73
+#: cli/lib/install.go:77
 msgid "--git-url and --zip-path are disabled by default, for more information see: %v"
 msgstr "--git-url and --zip-path are disabled by default, for more information see: %v"
 
-#: cli/lib/install.go:76
+#: cli/lib/install.go:80
 msgid "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk."
 msgstr "--git-url and --zip-path flags allow installing untrusted files, use it at your own risk."
 
@@ -186,7 +186,7 @@ msgid "Arduino core operations."
 msgstr "Arduino core operations."
 
 #: cli/lib/check_deps.go:50
-#: cli/lib/install.go:119
+#: cli/lib/install.go:123
 msgid "Arguments error: %v"
 msgstr "Arguments error: %v"
 
@@ -453,7 +453,7 @@ msgid "Couldn't determine program size"
 msgstr "Couldn't determine program size"
 
 #: cli/arguments/sketch.go:36
-#: cli/lib/install.go:99
+#: cli/lib/install.go:103
 msgid "Couldn't get current working directory: %v"
 msgstr "Couldn't get current working directory: %v"
 
@@ -553,7 +553,7 @@ msgstr "Disconnected"
 msgid "Display only the provided gRPC calls"
 msgstr "Display only the provided gRPC calls"
 
-#: cli/lib/install.go:50
+#: cli/lib/install.go:54
 msgid "Do not install dependencies."
 msgstr "Do not install dependencies."
 
@@ -585,20 +585,20 @@ msgstr "Downloading packages"
 msgid "Downloads one or more cores and corresponding tool dependencies."
 msgstr "Downloads one or more cores and corresponding tool dependencies."
 
-#: cli/lib/download.go:35
 #: cli/lib/download.go:36
+#: cli/lib/download.go:37
 msgid "Downloads one or more libraries without installing them."
 msgstr "Downloads one or more libraries without installing them."
 
 #: cli/daemon/daemon.go:59
 msgid "Enable debug logging of gRPC calls"
 msgstr "Enable debug logging of gRPC calls"
 
-#: cli/lib/install.go:52
+#: cli/lib/install.go:56
 msgid "Enter a path to zip file"
 msgstr "Enter a path to zip file"
 
-#: cli/lib/install.go:51
+#: cli/lib/install.go:55
 msgid "Enter git url for libraries hosted on repositories"
 msgstr "Enter git url for libraries hosted on repositories"
 
@@ -654,7 +654,7 @@ msgid "Error detecting boards: %v"
 msgstr "Error detecting boards: %v"
 
 #: cli/core/download.go:71
-#: cli/lib/download.go:62
+#: cli/lib/download.go:66
 msgid "Error downloading %[1]s: %[2]v"
 msgstr "Error downloading %[1]s: %[2]v"
 
@@ -789,15 +789,15 @@ msgstr "Error in FQBN: %s"
 msgid "Error initializing instance: %v"
 msgstr "Error initializing instance: %v"
 
-#: cli/lib/install.go:132
+#: cli/lib/install.go:136
 msgid "Error installing %s: %v"
 msgstr "Error installing %s: %v"
 
-#: cli/lib/install.go:110
+#: cli/lib/install.go:114
 msgid "Error installing Git Library: %v"
 msgstr "Error installing Git Library: %v"
 
-#: cli/lib/install.go:87
+#: cli/lib/install.go:91
 msgid "Error installing Zip Library: %v"
 msgstr "Error installing Zip Library: %v"
 
@@ -1183,8 +1183,8 @@ msgstr "Installing platform %s"
 msgid "Installs one or more cores and corresponding tool dependencies."
 msgstr "Installs one or more cores and corresponding tool dependencies."
 
-#: cli/lib/install.go:40
 #: cli/lib/install.go:41
+#: cli/lib/install.go:42
 msgid "Installs one or more specified libraries into the system."
 msgstr "Installs one or more specified libraries into the system."
 
@@ -1220,7 +1220,7 @@ msgstr "Invalid additional URL: %v"
 #: cli/core/install.go:95
 #: cli/core/uninstall.go:54
 #: cli/core/upgrade.go:81
-#: cli/lib/download.go:50
+#: cli/lib/download.go:54
 #: cli/lib/uninstall.go:55
 msgid "Invalid argument passed: %v"
 msgstr "Invalid argument passed: %v"
@@ -1295,11 +1295,11 @@ msgid "LIBNAME"
 msgstr "LIBNAME"
 
 #: cli/lib/check_deps.go:34
-#: cli/lib/install.go:39
+#: cli/lib/install.go:40
 msgid "LIBRARY"
 msgstr "LIBRARY"
 
-#: cli/lib/download.go:34
+#: cli/lib/download.go:35
 #: cli/lib/examples.go:39
 #: cli/lib/search.go:39
 #: cli/lib/uninstall.go:36
@@ -2285,7 +2285,7 @@ msgid "VERSION"
 msgstr "VERSION"
 
 #: cli/lib/check_deps.go:34
-#: cli/lib/install.go:39
+#: cli/lib/install.go:40
 msgid "VERSION_NUMBER"
 msgstr "VERSION_NUMBER"
 
@@ -2624,18 +2624,18 @@ msgstr "flags"
 msgid "following possible symlink %[1]s: %[2]s"
 msgstr "following possible symlink %[1]s: %[2]s"
 
-#: cli/lib/download.go:39
+#: cli/lib/download.go:40
 msgid "for a specific version."
 msgstr "for a specific version."
 
 #: cli/lib/check_deps.go:38
-#: cli/lib/download.go:38
-#: cli/lib/install.go:43
+#: cli/lib/download.go:39
+#: cli/lib/install.go:44
 msgid "for the latest version."
 msgstr "for the latest version."
 
 #: cli/lib/check_deps.go:39
-#: cli/lib/install.go:44
+#: cli/lib/install.go:45
 msgid "for the specific version."
 msgstr "for the specific version."