Added lib examples command

Author: cmaglie

cli/lib/examples.go

@@ -0,0 +1,116 @@
+// This file is part of arduino-cli.
+//
+// Copyright 2020 ARDUINO SA (http://www.arduino.cc/)
+//
+// This software is released under the GNU General Public License version 3,
+// which covers the main part of arduino-cli.
+// The terms of this license can be found at:
+// https://www.gnu.org/licenses/gpl-3.0.en.html
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to [email protected].
+
+package lib
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/arduino/arduino-cli/cli/errorcodes"
+	"github.com/arduino/arduino-cli/cli/feedback"
+	"github.com/arduino/arduino-cli/cli/instance"
+	"github.com/arduino/arduino-cli/commands/lib"
+	rpc "github.com/arduino/arduino-cli/rpc/commands"
+	"github.com/arduino/go-paths-helper"
+	"github.com/fatih/color"
+	"github.com/sirupsen/logrus"
+	"github.com/spf13/cobra"
+	"golang.org/x/net/context"
+)
+
+func initExamplesCommand() *cobra.Command {
+	examplesCommand := &cobra.Command{
+		Use:     "examples LIBRARY_NAME",
+		Short:   "Shows the list of the examples for the given library.",
+		Long:    "Shows the list of the examples for the given library.",
+		Example: "  " + os.Args[0] + " lib examples Wire",
+		Args:    cobra.ExactArgs(1),
+		Run:     runExamplesCommand,
+	}
+	return examplesCommand
+}
+
+func runExamplesCommand(cmd *cobra.Command, args []string) {
+	instance := instance.CreateInstanceIgnorePlatformIndexErrors()
+	logrus.Info("Show examples for library")
+
+	res, err := lib.LibraryList(context.Background(), &rpc.LibraryListReq{
+		Instance: instance,
+		All:      true,
+	})
+	if err != nil {
+		feedback.Errorf("Error getting libraries info: %v", err)
+		os.Exit(errorcodes.ErrGeneric)
+	}
+
+	libs := res.GetInstalledLibrary()
+	found := []*libraryExamples{}
+	for _, lib := range libs {
+		if lib.Library.Name == args[0] {
+			found = append(found, &libraryExamples{
+				Library:  lib.Library,
+				Examples: lib.Library.Examples,
+			})
+		}
+	}
+
+	feedback.PrintResult(libraryExamplesResult{found})
+	logrus.Info("Done")
+}
+
+// output from this command requires special formatting, let's create a dedicated
+// feedback.Result implementation
+
+type libraryExamples struct {
+	Library  *rpc.Library
+	Examples []string
+}
+
+type libraryExamplesResult struct {
+	Examples []*libraryExamples
+}
+
+func (ir libraryExamplesResult) Data() interface{} {
+	return ir.Examples
+}
+
+func (ir libraryExamplesResult) String() string {
+	if ir.Examples == nil || len(ir.Examples) == 0 {
+		return "No libraries found."
+	}
+
+	res := []string{}
+	for _, lib := range ir.Examples {
+		name := lib.Library.Name
+		if lib.Library.ContainerPlatform != "" {
+			name += " (" + lib.Library.GetContainerPlatform() + ")"
+		} else if lib.Library.Location != rpc.LibraryLocation_user {
+			name += " (" + lib.Library.GetLocation().String() + ")"
+		}
+		r := fmt.Sprintf("Examples for library %s\n", color.GreenString("%s", name))
+		for _, example := range lib.Examples {
+			examplePath := paths.New(example)
+			r += fmt.Sprintf("  - %s%c%s\n",
+				color.New(color.Faint).Sprintf("%s", examplePath.Parent()),
+				os.PathSeparator,
+				color.HiWhiteString("%s", examplePath.Base()))
+		}
+		res = append(res, r)
+	}
+
+	return strings.Join(res, "\n")
+}

cli/lib/lib.go

@@ -35,6 +35,7 @@ func NewCommand() *cobra.Command {
 	libCommand.AddCommand(initDownloadCommand())
 	libCommand.AddCommand(initInstallCommand())
 	libCommand.AddCommand(initListCommand())
+	libCommand.AddCommand(initExamplesCommand())
 	libCommand.AddCommand(initSearchCommand())
 	libCommand.AddCommand(initUninstallCommand())
 	libCommand.AddCommand(initUpgradeCommand())