Moved a batch of function from commands/* subpackage to commands (part 4)

cmaglie · cmaglie · commit a2d9f80559d0 · 2024-03-13T11:36:31.000+01:00
diff --git a/commands/service.go b/commands/service.go
@@ -23,8 +23,6 @@ import (
 	"sync/atomic"
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
-	"github.com/arduino/arduino-cli/commands/monitor"
-	"github.com/arduino/arduino-cli/commands/sketch"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/sirupsen/logrus"
 	"google.golang.org/grpc/metadata"
@@ -154,19 +152,19 @@ func (s *ArduinoCoreServerImpl) Version(ctx context.Context, req *rpc.VersionReq
 
 // NewSketch FIXMEDOC
 func (s *ArduinoCoreServerImpl) NewSketch(ctx context.Context, req *rpc.NewSketchRequest) (*rpc.NewSketchResponse, error) {
-	resp, err := sketch.NewSketch(ctx, req)
+	resp, err := NewSketch(ctx, req)
 	return resp, convertErrorToRPCStatus(err)
 }
 
 // LoadSketch FIXMEDOC
 func (s *ArduinoCoreServerImpl) LoadSketch(ctx context.Context, req *rpc.LoadSketchRequest) (*rpc.LoadSketchResponse, error) {
-	resp, err := sketch.LoadSketch(ctx, req)
+	resp, err := LoadSketch(ctx, req)
 	return &rpc.LoadSketchResponse{Sketch: resp}, convertErrorToRPCStatus(err)
 }
 
 // SetSketchDefaults FIXMEDOC
 func (s *ArduinoCoreServerImpl) SetSketchDefaults(ctx context.Context, req *rpc.SetSketchDefaultsRequest) (*rpc.SetSketchDefaultsResponse, error) {
-	resp, err := sketch.SetSketchDefaults(ctx, req)
+	resp, err := SetSketchDefaults(ctx, req)
 	return resp, convertErrorToRPCStatus(err)
 }
 
@@ -429,7 +427,7 @@ func (s *ArduinoCoreServerImpl) LibraryList(ctx context.Context, req *rpc.Librar
 
 // ArchiveSketch FIXMEDOC
 func (s *ArduinoCoreServerImpl) ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchRequest) (*rpc.ArchiveSketchResponse, error) {
-	resp, err := sketch.ArchiveSketch(ctx, req)
+	resp, err := ArchiveSketch(ctx, req)
 	return resp, convertErrorToRPCStatus(err)
 }
 
@@ -455,7 +453,7 @@ func (s *ArduinoCoreServerImpl) GitLibraryInstall(req *rpc.GitLibraryInstallRequ
 
 // EnumerateMonitorPortSettings FIXMEDOC
 func (s *ArduinoCoreServerImpl) EnumerateMonitorPortSettings(ctx context.Context, req *rpc.EnumerateMonitorPortSettingsRequest) (*rpc.EnumerateMonitorPortSettingsResponse, error) {
-	resp, err := monitor.EnumerateMonitorPortSettings(ctx, req)
+	resp, err := EnumerateMonitorPortSettings(ctx, req)
 	return resp, convertErrorToRPCStatus(err)
 }
 
@@ -473,7 +471,7 @@ func (s *ArduinoCoreServerImpl) Monitor(stream rpc.ArduinoCoreService_MonitorSer
 	if openReq == nil {
 		return &cmderrors.InvalidInstanceError{}
 	}
-	portProxy, _, err := monitor.Monitor(stream.Context(), openReq)
+	portProxy, _, err := Monitor(stream.Context(), openReq)
 	if err != nil {
 		return err
 	}
diff --git a/commands/service_monitor.go b/commands/service_monitor.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package monitor
+package commands
 
 import (
 	"context"
@@ -25,42 +25,39 @@ import (
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
 	"github.com/arduino/arduino-cli/internal/arduino/cores/packagemanager"
 	pluggableMonitor "github.com/arduino/arduino-cli/internal/arduino/monitor"
-	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	"github.com/arduino/go-properties-orderedmap"
 	"github.com/sirupsen/logrus"
 )
 
-var tr = i18n.Tr
-
-// PortProxy is an io.ReadWriteCloser that maps into the monitor port of the board
-type PortProxy struct {
+// portProxy is an io.ReadWriteCloser that maps into the monitor port of the board
+type portProxy struct {
 	rw               io.ReadWriter
 	changeSettingsCB func(setting, value string) error
 	closeCB          func() error
 }
 
-func (p *PortProxy) Read(buff []byte) (int, error) {
+func (p *portProxy) Read(buff []byte) (int, error) {
 	return p.rw.Read(buff)
 }
 
-func (p *PortProxy) Write(buff []byte) (int, error) {
+func (p *portProxy) Write(buff []byte) (int, error) {
 	return p.rw.Write(buff)
 }
 
 // Config sets the port configuration setting to the specified value
-func (p *PortProxy) Config(setting, value string) error {
+func (p *portProxy) Config(setting, value string) error {
 	return p.changeSettingsCB(setting, value)
 }
 
 // Close the port
-func (p *PortProxy) Close() error {
+func (p *portProxy) Close() error {
 	return p.closeCB()
 }
 
 // Monitor opens a communication port. It returns a PortProxy to communicate with the port and a PortDescriptor
 // that describes the available configuration settings.
-func Monitor(ctx context.Context, req *rpc.MonitorPortOpenRequest) (*PortProxy, *pluggableMonitor.PortDescriptor, error) {
+func Monitor(ctx context.Context, req *rpc.MonitorPortOpenRequest) (*portProxy, *pluggableMonitor.PortDescriptor, error) {
 	pme, release, err := instances.GetPackageManagerExplorer(req.GetInstance())
 	if err != nil {
 		return nil, nil, err
@@ -103,7 +100,7 @@ func Monitor(ctx context.Context, req *rpc.MonitorPortOpenRequest) (*PortProxy,
 	}
 
 	logrus.Infof("Port %s successfully opened", req.GetPort().GetAddress())
-	return &PortProxy{
+	return &portProxy{
 		rw:               monIO,
 		changeSettingsCB: m.Configure,
 		closeCB: func() error {
diff --git a/commands/service_monitor_settings.go b/commands/service_monitor_settings.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package monitor
+package commands
 
 import (
 	"context"
diff --git a/commands/service_set_sketch_defaults.go b/commands/service_set_sketch_defaults.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package sketch
+package commands
 
 import (
 	"context"
diff --git a/commands/service_sketch_archive.go b/commands/service_sketch_archive.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package sketch
+package commands
 
 import (
 	"archive/zip"
@@ -24,13 +24,10 @@ import (
 
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/internal/arduino/sketch"
-	"github.com/arduino/arduino-cli/internal/i18n"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 	paths "github.com/arduino/go-paths-helper"
 )
 
-var tr = i18n.Tr
-
 // ArchiveSketch FIXMEDOC
 func ArchiveSketch(ctx context.Context, req *rpc.ArchiveSketchRequest) (*rpc.ArchiveSketchResponse, error) {
 	// sketchName is the name of the sketch without extension, for example "MySketch"
diff --git a/commands/service_sketch_load.go b/commands/service_sketch_load.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package sketch
+package commands
 
 import (
 	"context"
diff --git a/commands/service_sketch_load_test.go b/commands/service_sketch_load_test.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package sketch
+package commands
 
 import (
 	"context"
diff --git a/commands/service_sketch_new.go b/commands/service_sketch_new.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package sketch
+package commands
 
 import (
 	"context"
diff --git a/commands/service_sketch_new_test.go b/commands/service_sketch_new_test.go
@@ -13,7 +13,7 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to license@arduino.cc.
 
-package sketch
+package commands
 
 import (
 	"context"
diff --git a/commands/testdata/sketch_with_profile/sketch.yml b/commands/testdata/sketch_with_profile/sketch.yml
diff --git a/commands/testdata/sketch_with_profile/sketch_with_profile.ino b/commands/testdata/sketch_with_profile/sketch_with_profile.ino
diff --git a/internal/cli/arguments/sketch.go b/internal/cli/arguments/sketch.go
@@ -18,7 +18,7 @@ package arguments
 import (
 	"context"
 
-	"github.com/arduino/arduino-cli/commands/sketch"
+	"github.com/arduino/arduino-cli/commands"
 	f "github.com/arduino/arduino-cli/internal/algorithms"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -52,7 +52,7 @@ func GetSketchProfiles(sketchPath string) []string {
 			return nil
 		}
 	}
-	sk, err := sketch.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath})
+	sk, err := commands.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath})
 	if err != nil {
 		return nil
 	}
diff --git a/internal/cli/board/attach.go b/internal/cli/board/attach.go
@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/arduino/arduino-cli/commands/sketch"
+	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -59,7 +59,7 @@ func runAttachCommand(path string, port *arguments.Port, fqbn string, programmer
 	sketchPath := arguments.InitSketchPath(path)
 
 	portAddress, portProtocol, _ := port.GetPortAddressAndProtocol(nil, "", "")
-	newDefaults, err := sketch.SetSketchDefaults(context.Background(), &rpc.SetSketchDefaultsRequest{
+	newDefaults, err := commands.SetSketchDefaults(context.Background(), &rpc.SetSketchDefaultsRequest{
 		SketchPath:          sketchPath.String(),
 		DefaultFqbn:         fqbn,
 		DefaultProgrammer:   programmer.GetProgrammer(),
diff --git a/internal/cli/compile/compile.go b/internal/cli/compile/compile.go
@@ -26,7 +26,6 @@ import (
 
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/commands/cmderrors"
-	"github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
 	"github.com/arduino/arduino-cli/internal/cli/configuration"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
@@ -159,7 +158,7 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 	}
 
 	sketchPath := arguments.InitSketchPath(path)
-	sk, err := sketch.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
+	sk, err := commands.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if err != nil {
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
diff --git a/internal/cli/debug/debug.go b/internal/cli/debug/debug.go
@@ -22,9 +22,9 @@ import (
 	"os"
 	"os/signal"
 
+	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/commands/cmderrors"
 	"github.com/arduino/arduino-cli/commands/debug"
-	"github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	"github.com/arduino/arduino-cli/internal/cli/feedback/table"
@@ -83,7 +83,7 @@ func runDebugCommand(args []string, portArgs *arguments.Port, fqbnArg *arguments
 	}
 
 	sketchPath := arguments.InitSketchPath(path)
-	sk, err := sketch.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
+	sk, err := commands.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if err != nil {
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
diff --git a/internal/cli/monitor/monitor.go b/internal/cli/monitor/monitor.go
@@ -26,8 +26,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/arduino/arduino-cli/commands/monitor"
-	sk "github.com/arduino/arduino-cli/commands/sketch"
+	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	"github.com/arduino/arduino-cli/internal/cli/feedback/result"
@@ -104,7 +103,7 @@ func runMonitorCmd(
 	// If only --port is set we read the fqbn in the following order: default_fqbn -> discovery
 	// If only --fqbn is set we read the port in the following order: default_port
 	sketchPath := arguments.InitSketchPath(sketchPathArg)
-	sketch, err := sk.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
+	sketch, err := commands.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if err != nil && !portArgs.IsPortFlagSet() {
 		feedback.Fatal(
 			tr("Error getting default port from `sketch.yaml`. Check if you're in the correct sketch folder or provide the --port flag: %s", err),
@@ -145,7 +144,7 @@ func runMonitorCmd(
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
 
-	enumerateResp, err := monitor.EnumerateMonitorPortSettings(context.Background(), &rpc.EnumerateMonitorPortSettingsRequest{
+	enumerateResp, err := commands.EnumerateMonitorPortSettings(context.Background(), &rpc.EnumerateMonitorPortSettingsRequest{
 		Instance:     inst,
 		PortProtocol: portProtocol,
 		Fqbn:         fqbn,
@@ -203,7 +202,7 @@ func runMonitorCmd(
 			}
 		}
 	}
-	portProxy, _, err := monitor.Monitor(context.Background(), &rpc.MonitorPortOpenRequest{
+	portProxy, _, err := commands.Monitor(context.Background(), &rpc.MonitorPortOpenRequest{
 		Instance:          inst,
 		Port:              &rpc.Port{Address: portAddress, Protocol: portProtocol},
 		Fqbn:              fqbn,
diff --git a/internal/cli/sketch/archive.go b/internal/cli/sketch/archive.go
@@ -20,7 +20,7 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/arduino/arduino-cli/commands/sketch"
+	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -66,13 +66,13 @@ func runArchiveCommand(args []string, includeBuildDir bool, overwrite bool) {
 	}
 
 	sketchPath := arguments.InitSketchPath(sketchPathArg)
-	sk, err := sketch.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
+	sk, err := commands.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if err != nil {
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
 	feedback.WarnAboutDeprecatedFiles(sk)
 
-	if _, err := sketch.ArchiveSketch(context.Background(),
+	if _, err := commands.ArchiveSketch(context.Background(),
 		&rpc.ArchiveSketchRequest{
 			SketchPath:      sketchPath.String(),
 			ArchivePath:     archivePathArg,
diff --git a/internal/cli/sketch/new.go b/internal/cli/sketch/new.go
@@ -20,7 +20,7 @@ import (
 	"os"
 	"strings"
 
-	sk "github.com/arduino/arduino-cli/commands/sketch"
+	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/internal/arduino/globals"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
@@ -72,7 +72,7 @@ func runNewCommand(args []string, overwrite bool) {
 		sketchName = sketchDirPath.Base()
 	}
 
-	_, err = sk.NewSketch(context.Background(), &rpc.NewSketchRequest{
+	_, err = commands.NewSketch(context.Background(), &rpc.NewSketchRequest{
 		SketchName: sketchName,
 		SketchDir:  sketchDir,
 		Overwrite:  overwrite,
diff --git a/internal/cli/upload/upload.go b/internal/cli/upload/upload.go
@@ -24,7 +24,6 @@ import (
 
 	"github.com/arduino/arduino-cli/commands"
 	"github.com/arduino/arduino-cli/commands/cmderrors"
-	sk "github.com/arduino/arduino-cli/commands/sketch"
 	"github.com/arduino/arduino-cli/internal/cli/arguments"
 	"github.com/arduino/arduino-cli/internal/cli/feedback"
 	"github.com/arduino/arduino-cli/internal/cli/feedback/result"
@@ -90,7 +89,7 @@ func runUploadCommand(args []string, uploadFieldsArgs map[string]string) {
 		path = args[0]
 	}
 	sketchPath := arguments.InitSketchPath(path)
-	sketch, err := sk.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
+	sketch, err := commands.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if importDir == "" && importFile == "" {
 		if err != nil {
 			feedback.Fatal(tr("Error during Upload: %v", err), feedback.ErrGeneric)
