Skip to content

Commit 08a5162

Browse files
umbynosumbynos
committed
added info logging in every command for consistency
1 parent 3bf6c37 commit 08a5162

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+315
-262
lines changed

‎cli/board/attach.go

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727
"github.com/arduino/arduino-cli/cli/output"
2828
"github.com/arduino/arduino-cli/commands/board"
2929
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
30+
"github.com/sirupsen/logrus"
3031
"github.com/spf13/cobra"
3132
)
3233

@@ -51,6 +52,8 @@ func initAttachCommand() *cobra.Command {
5152
func runAttachCommand(cmd *cobra.Command, args []string) {
5253
instance := instance.CreateAndInit()
5354

55+
logrus.Info("Executing `arduino-cli board attach`")
56+
5457
path := ""
5558
if len(args) > 1 {
5659
path = args[1]

‎cli/board/details.go

+3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2929
"github.com/arduino/arduino-cli/table"
3030
"github.com/fatih/color"
31+
"github.com/sirupsen/logrus"
3132
"github.com/spf13/cobra"
3233
)
3334

@@ -58,6 +59,8 @@ func initDetailsCommand() *cobra.Command {
5859
func runDetailsCommand(cmd *cobra.Command, args []string) {
5960
inst := instance.CreateAndInit()
6061

62+
logrus.Info("Executing `arduino-cli board details`")
63+
6164
// remove once `board details <fqbn>` is removed
6265
if fqbn.GetFQBN() == "" && len(args) > 0 {
6366
fqbn.SetFQBN(args[0])

‎cli/board/list.go

+4
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"github.com/arduino/arduino-cli/commands/board"
2929
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3030
"github.com/arduino/arduino-cli/table"
31+
"github.com/sirupsen/logrus"
3132
"github.com/spf13/cobra"
3233
)
3334

@@ -57,6 +58,9 @@ func initListCommand() *cobra.Command {
5758
// runListCommand detects and lists the connected arduino boards
5859
func runListCommand(cmd *cobra.Command, args []string) {
5960
inst := instance.CreateAndInit()
61+
62+
logrus.Info("Executing `arduino-cli board list`")
63+
6064
if watch {
6165
watchList(cmd, inst)
6266
os.Exit(0)

‎cli/board/listall.go

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727
"github.com/arduino/arduino-cli/commands/board"
2828
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2929
"github.com/arduino/arduino-cli/table"
30+
"github.com/sirupsen/logrus"
3031
"github.com/spf13/cobra"
3132
)
3233

@@ -52,6 +53,8 @@ for a specific board if you specify the board name`),
5253
func runListAllCommand(cmd *cobra.Command, args []string) {
5354
inst := instance.CreateAndInit()
5455

56+
logrus.Info("Executing `arduino-cli board listall`")
57+
5558
list, err := board.ListAll(context.Background(), &rpc.BoardListAllRequest{
5659
Instance: inst,
5760
SearchArgs: args,

‎cli/board/search.go

+3
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import (
2828
"github.com/arduino/arduino-cli/commands/board"
2929
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3030
"github.com/arduino/arduino-cli/table"
31+
"github.com/sirupsen/logrus"
3132
"github.com/spf13/cobra"
3233
)
3334

@@ -50,6 +51,8 @@ for a specific board if you specify the board name`),
5051
func runSearchCommand(cmd *cobra.Command, args []string) {
5152
inst := instance.CreateAndInit()
5253

54+
logrus.Info("Executing `arduino-cli board search`")
55+
5356
res, err := board.Search(context.Background(), &rpc.BoardSearchRequest{
5457
Instance: inst,
5558
SearchArgs: strings.Join(args, " "),

‎cli/burnbootloader/burnbootloader.go

+3
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import (
2626
"github.com/arduino/arduino-cli/commands/upload"
2727
"github.com/arduino/arduino-cli/i18n"
2828
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
29+
"github.com/sirupsen/logrus"
2930
"github.com/spf13/cobra"
3031
)
3132

@@ -64,6 +65,8 @@ func NewCommand() *cobra.Command {
6465
func runBootloaderCommand(command *cobra.Command, args []string) {
6566
instance := instance.CreateAndInit()
6667

68+
logrus.Info("Executing `arduino-cli burn-bootloader`")
69+
6770
// We don't need a Sketch to upload a board's bootloader
6871
discoveryPort, err := port.GetPort(instance, nil)
6972
if err != nil {

‎cli/cache/clean.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func initCleanCommand() *cobra.Command {
3838
}
3939

4040
func runCleanCommand(cmd *cobra.Command, args []string) {
41-
logrus.Info("Executing `arduino cache clean`")
41+
logrus.Info("Executing `arduino-cli cache clean`")
4242

4343
cachePath := configuration.Settings.GetString("directories.Downloads")
4444
err := os.RemoveAll(cachePath)

‎cli/compile/compile.go

+3
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import (
2626
"github.com/arduino/arduino-cli/cli/output"
2727
"github.com/arduino/arduino-cli/configuration"
2828
"github.com/arduino/arduino-cli/i18n"
29+
"github.com/sirupsen/logrus"
2930

3031
"github.com/arduino/arduino-cli/cli/errorcodes"
3132
"github.com/arduino/arduino-cli/cli/instance"
@@ -123,6 +124,8 @@ func NewCommand() *cobra.Command {
123124
func runCompileCommand(cmd *cobra.Command, args []string) {
124125
inst := instance.CreateAndInit()
125126

127+
logrus.Info("Executing `arduino-cli compile`")
128+
126129
path := ""
127130
if len(args) > 0 {
128131
path = args[0]

‎cli/completion/completion.go

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import (
2121
"github.com/arduino/arduino-cli/cli/errorcodes"
2222
"github.com/arduino/arduino-cli/cli/feedback"
2323
"github.com/arduino/arduino-cli/i18n"
24+
"github.com/sirupsen/logrus"
2425
"github.com/spf13/cobra"
2526
)
2627

@@ -47,6 +48,7 @@ func NewCommand() *cobra.Command {
4748
}
4849

4950
func runCompletionCommand(cmd *cobra.Command, args []string) {
51+
logrus.Info("Executing `arduino-cli completion`")
5052
if completionNoDesc && (args[0] == "powershell") {
5153
feedback.Errorf(tr("Error: command description is not supported by %v"), args[0])
5254
os.Exit(errorcodes.ErrGeneric)

‎cli/config/add.go

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222
"github.com/arduino/arduino-cli/cli/errorcodes"
2323
"github.com/arduino/arduino-cli/cli/feedback"
2424
"github.com/arduino/arduino-cli/configuration"
25+
"github.com/sirupsen/logrus"
2526
"github.com/spf13/cobra"
2627
)
2728

@@ -43,6 +44,7 @@ func initAddCommand() *cobra.Command {
4344
}
4445

4546
func runAddCommand(cmd *cobra.Command, args []string) {
47+
logrus.Info("Executing `arduino-cli config add`")
4648
key := args[0]
4749
kind := validateKey(key)
4850

‎cli/config/delete.go

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222
"github.com/arduino/arduino-cli/cli/errorcodes"
2323
"github.com/arduino/arduino-cli/cli/feedback"
2424
"github.com/arduino/arduino-cli/configuration"
25+
"github.com/sirupsen/logrus"
2526
"github.com/spf13/cobra"
2627
"github.com/spf13/viper"
2728
)
@@ -44,6 +45,7 @@ func initDeleteCommand() *cobra.Command {
4445
}
4546

4647
func runDeleteCommand(cmd *cobra.Command, args []string) {
48+
logrus.Info("Executing `arduino-cli config delete`")
4749
toDelete := args[0]
4850

4951
keys := []string{}

‎cli/config/dump.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func initDumpCommand() *cobra.Command {
3838
}
3939

4040
func runDumpCommand(cmd *cobra.Command, args []string) {
41-
logrus.Info("Executing `arduino config dump`")
41+
logrus.Info("Executing `arduino-cli config dump`")
4242
feedback.PrintResult(dumpResult{configuration.Settings.AllSettings()})
4343
}
4444

‎cli/config/init.go

+1
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ func initInitCommand() *cobra.Command {
5959
}
6060

6161
func runInitCommand(cmd *cobra.Command, args []string) {
62+
logrus.Info("Executing `arduino-cli config init`")
6263

6364
var configFileAbsPath *paths.Path
6465
var absPath *paths.Path

‎cli/config/remove.go

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import (
2222
"github.com/arduino/arduino-cli/cli/errorcodes"
2323
"github.com/arduino/arduino-cli/cli/feedback"
2424
"github.com/arduino/arduino-cli/configuration"
25+
"github.com/sirupsen/logrus"
2526
"github.com/spf13/cobra"
2627
)
2728

@@ -43,6 +44,7 @@ func initRemoveCommand() *cobra.Command {
4344
}
4445

4546
func runRemoveCommand(cmd *cobra.Command, args []string) {
47+
logrus.Info("Executing `arduino-cli config remove`")
4648
key := args[0]
4749
kind := validateKey(key)
4850

‎cli/config/set.go

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ import (
2323
"github.com/arduino/arduino-cli/cli/errorcodes"
2424
"github.com/arduino/arduino-cli/cli/feedback"
2525
"github.com/arduino/arduino-cli/configuration"
26+
"github.com/sirupsen/logrus"
2627
"github.com/spf13/cobra"
2728
)
2829

@@ -46,6 +47,7 @@ func initSetCommand() *cobra.Command {
4647
}
4748

4849
func runSetCommand(cmd *cobra.Command, args []string) {
50+
logrus.Info("Executing `arduino-cli config set`")
4951
key := args[0]
5052
kind := validateKey(key)
5153

‎cli/core/download.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func initDownloadCommand() *cobra.Command {
5151
func runDownloadCommand(cmd *cobra.Command, args []string) {
5252
inst := instance.CreateAndInit()
5353

54-
logrus.Info("Executing `arduino core download`")
54+
logrus.Info("Executing `arduino-cli core download`")
5555

5656
platformsRefs, err := arguments.ParseReferences(args, true)
5757
if err != nil {

‎cli/core/install.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ func initInstallCommand() *cobra.Command {
5959

6060
func runInstallCommand(cmd *cobra.Command, args []string) {
6161
inst := instance.CreateAndInit()
62-
logrus.Info("Executing `arduino core install`")
62+
logrus.Info("Executing `arduino-cli core install`")
6363

6464
platformsRefs, err := arguments.ParseReferences(args, true)
6565
if err != nil {

‎cli/core/list.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func initListCommand() *cobra.Command {
5050

5151
func runListCommand(cmd *cobra.Command, args []string) {
5252
inst := instance.CreateAndInit()
53-
logrus.Info("Executing `arduino core list`")
53+
logrus.Info("Executing `arduino-cli core list`")
5454

5555
platforms, err := core.GetPlatforms(&rpc.PlatformListRequest{
5656
Instance: inst,

‎cli/core/search.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ func runSearchCommand(cmd *cobra.Command, args []string) {
8282
}
8383

8484
arguments := strings.ToLower(strings.Join(args, " "))
85-
logrus.Infof("Executing `arduino core search` with args: '%s'", arguments)
85+
logrus.Infof("Executing `arduino-cli core search` with args: '%s'", arguments)
8686

8787
resp, err := core.PlatformSearch(&rpc.PlatformSearchRequest{
8888
Instance: inst,

‎cli/core/uninstall.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ func initUninstallCommand() *cobra.Command {
4848

4949
func runUninstallCommand(cmd *cobra.Command, args []string) {
5050
inst := instance.CreateAndInit()
51-
logrus.Info("Executing `arduino core uninstall`")
51+
logrus.Info("Executing `arduino-cli core uninstall`")
5252

5353
platformsRefs, err := arguments.ParseReferences(args, true)
5454
if err != nil {

‎cli/core/update_index.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ func initUpdateIndexCommand() *cobra.Command {
4242
}
4343

4444
func runUpdateIndexCommand(cmd *cobra.Command, args []string) {
45-
logrus.Info("Executing `arduino core update-index`")
4645
inst := instance.CreateInstanceForUpdate()
46+
logrus.Info("Executing `arduino-cli core update-index`")
4747

4848
_, err := commands.UpdateIndex(context.Background(), &rpc.UpdateIndexRequest{
4949
Instance: inst,

‎cli/core/upgrade.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func initUpgradeCommand() *cobra.Command {
5151

5252
func runUpgradeCommand(cmd *cobra.Command, args []string) {
5353
inst := instance.CreateAndInit()
54-
logrus.Info("Executing `arduino core upgrade`")
54+
logrus.Info("Executing `arduino-cli core upgrade`")
5555

5656
// if no platform was passed, upgrade allthethings
5757
if len(args) == 0 {

‎cli/daemon/daemon.go

+1
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ func NewCommand() *cobra.Command {
6767
}
6868

6969
func runDaemonCommand(cmd *cobra.Command, args []string) {
70+
logrus.Info("Executing `arduino-cli daemon`")
7071

7172
if configuration.Settings.GetBool("metrics.enabled") {
7273
metrics.Activate("daemon")

‎cli/debug/debug.go

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import (
3131
"github.com/arduino/arduino-cli/table"
3232
"github.com/arduino/go-properties-orderedmap"
3333
"github.com/fatih/color"
34+
"github.com/sirupsen/logrus"
3435
"github.com/spf13/cobra"
3536
)
3637

@@ -67,6 +68,7 @@ func NewCommand() *cobra.Command {
6768

6869
func runDebugCommand(command *cobra.Command, args []string) {
6970
instance := instance.CreateAndInit()
71+
logrus.Info("Executing `arduino-cli debug`")
7072

7173
path := ""
7274
if len(args) > 0 {

‎cli/generatedocs/generatedocs.go

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ func NewCommand() *cobra.Command {
5858
}
5959

6060
func generateBashCompletions(cmd *cobra.Command, args []string) {
61+
logrus.Info("Executing `arduino-cli generate-docs`")
6162
if outputDir == "" {
6263
outputDir = "docs/bash_completions"
6364
}

‎cli/lib/check_deps.go

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727
"github.com/arduino/arduino-cli/commands/lib"
2828
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
2929
"github.com/fatih/color"
30+
"github.com/sirupsen/logrus"
3031
"github.com/spf13/cobra"
3132
)
3233

@@ -49,6 +50,7 @@ func initDepsCommand() *cobra.Command {
4950

5051
func runDepsCommand(cmd *cobra.Command, args []string) {
5152
instance := instance.CreateAndInit()
53+
logrus.Info("Executing `arduino-cli lib deps`")
5254
libRef, err := ParseLibraryReferenceArgAndAdjustCase(instance, args[0])
5355
if err != nil {
5456
feedback.Errorf(tr("Arguments error: %v"), err)

‎cli/lib/download.go

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727
"github.com/arduino/arduino-cli/cli/output"
2828
"github.com/arduino/arduino-cli/commands/lib"
2929
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
30+
"github.com/sirupsen/logrus"
3031
"github.com/spf13/cobra"
3132
)
3233

@@ -49,6 +50,7 @@ func initDownloadCommand() *cobra.Command {
4950

5051
func runDownloadCommand(cmd *cobra.Command, args []string) {
5152
instance := instance.CreateAndInit()
53+
logrus.Info("Executing `arduino-cli lib download`")
5254
refs, err := ParseLibraryReferenceArgsAndAdjustCase(instance, args)
5355
if err != nil {
5456
feedback.Errorf(tr("Invalid argument passed: %v"), err)

‎cli/lib/examples.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func initExamplesCommand() *cobra.Command {
5656

5757
func runExamplesCommand(cmd *cobra.Command, args []string) {
5858
instance := instance.CreateAndInit()
59-
logrus.Info("Show examples for library")
59+
logrus.Info("Executing `arduino-cli lib examples`")
6060

6161
name := ""
6262
if len(args) > 0 {

‎cli/lib/install.go

+2
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ import (
3131
"github.com/arduino/arduino-cli/configuration"
3232
rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
3333
"github.com/arduino/go-paths-helper"
34+
"github.com/sirupsen/logrus"
3435
"github.com/spf13/cobra"
3536
semver "go.bug.st/relaxed-semver"
3637
)
@@ -65,6 +66,7 @@ func initInstallCommand() *cobra.Command {
6566

6667
func runInstallCommand(cmd *cobra.Command, args []string) {
6768
instance := instance.CreateAndInit()
69+
logrus.Info("Executing `arduino-cli lib install`")
6870

6971
if zipPath || gitURL {
7072
if !configuration.Settings.GetBool("library.enable_unsafe_install") {

‎cli/lib/list.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ not listed, they can be listed by adding the --all flag.`),
5959

6060
func runListCommand(cmd *cobra.Command, args []string) {
6161
instance := instance.CreateAndInit()
62-
logrus.Info("Listing")
62+
logrus.Info("Executing `arduino-cli lib list`")
6363

6464
name := ""
6565
if len(args) > 0 {

0 commit comments

Comments
 (0)