add logging flag

Author: alessio-perugini

cli.go

@@ -18,20 +18,26 @@ package helper
 
 import (
 	"fmt"
+	"io"
 	"os"
 	"path/filepath"
 
 	"github.com/arduino/go-paths-helper"
 	"github.com/spf13/cobra"
+	"golang.org/x/exp/slog"
 	"gopkg.in/yaml.v3"
 )
 
 // RunPlugin runs the given plugin
 func RunPlugin(plugin Plugin) {
 	info := plugin.GetPluginInfo()
 
-	var portAddress string
-	var fqbn string
+	var (
+		fqbn        string
+		logLevel    string
+		verbose     bool
+		portAddress string
+	)
 
 	firmwareFlashCmd := &cobra.Command{
 		Use:   "flash",
@@ -117,6 +123,28 @@ func RunPlugin(plugin Plugin) {
 	cli := &cobra.Command{
 		Use:   appName,
 		Short: info.Name + " - This is an Arduino Firmware Uploader plugin.",
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			t, found := map[string]slog.Level{
+				"trace": slog.LevelDebug,
+				"debug": slog.LevelDebug,
+				"info":  slog.LevelInfo,
+				"warn":  slog.LevelWarn,
+				"error": slog.LevelError,
+				"fatal": slog.LevelError,
+				"panic": slog.LevelError,
+			}[logLevel]
+			if !found {
+				t = slog.LevelError
+			}
+
+			var w io.Writer
+			if !verbose {
+				w = io.Discard
+			} else {
+				w = os.Stdout
+			}
+			slog.SetDefault(slog.New(slog.NewTextHandler(w, &slog.HandlerOptions{Level: t})))
+		},
 	}
 	cli.AddCommand(firmwareCmd)
 	cli.AddCommand(certCmd)
@@ -125,6 +153,8 @@ func RunPlugin(plugin Plugin) {
 	// The fqbn is an optional flag that can be used by the plugin to do specific operations with a board.
 	// With this input we can support a family of boards and not only a single one per plugin
 	cli.PersistentFlags().StringVarP(&fqbn, "fqbn", "b", "", "Fully qualified board name")
+	cli.PersistentFlags().StringVar(&logLevel, "log-level", "info", "Messages with this level and above will be logged. Valid levels are: trace, debug, info, warn, error, fatal, panic")
+	cli.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "Print the logs on the standard output.")
 
 	if err := cli.Execute(); err != nil {
 		fatal(err.Error(), 1)

go.mod

@@ -6,6 +6,7 @@ require (
 	github.com/arduino/go-paths-helper v1.9.1
 	github.com/spf13/cobra v1.7.0
 	go.bug.st/relaxed-semver v0.11.0
+	golang.org/x/exp v0.0.0-20230711153332-06a737ee72cb
 	gopkg.in/yaml.v3 v3.0.1
 )
 

go.sum

@@ -19,6 +19,8 @@ github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UV
 github.com/stretchr/testify v1.7.1 h1:5TQK59W5E3v0r2duFAb7P95B6hEeOyEnHRa8MjYSMTY=
 go.bug.st/relaxed-semver v0.11.0 h1:ngzpUlBEZ5F9hJnMZP55LIFbgX3bCztBBufMhJViAsY=
 go.bug.st/relaxed-semver v0.11.0/go.mod h1:rqPEm+790OTQlAdfSJSHWwpKOg3A8UyvAWMZxYkQivc=
+golang.org/x/exp v0.0.0-20230711153332-06a737ee72cb h1:xIApU0ow1zwMa2uL1VDNeQlNVFTWMQxZUZCMDy0Q4Us=
+golang.org/x/exp v0.0.0-20230711153332-06a737ee72cb/go.mod h1:FXUEEKJgO7OQYeo8N01OfiKP8RXMtf6e8aTskBGqWdc=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=