Moved subroutine that warns about .pde files in feedback package

Author: cmaglie

internal/arduino/sketch/sketch_test.go

@@ -291,41 +291,6 @@ func TestGenBuildPath(t *testing.T) {
 	assert.Equal(t, "ACBD18DB4CC2F85CEDEF654FCCC4A4D8", (&Sketch{FullPath: paths.New("foo")}).Hash())
 }
 
-func TestCheckForPdeFiles(t *testing.T) {
-	sketchPath := paths.New("testdata", "SketchSimple")
-	files := CheckForPdeFiles(sketchPath)
-	require.Empty(t, files)
-
-	sketchPath = paths.New("testdata", "SketchPde")
-	files = CheckForPdeFiles(sketchPath)
-	require.Len(t, files, 1)
-	require.Equal(t, sketchPath.Join("SketchPde.pde"), files[0])
-
-	sketchPath = paths.New("testdata", "SketchMultipleMainFiles")
-	files = CheckForPdeFiles(sketchPath)
-	require.Len(t, files, 1)
-	require.Equal(t, sketchPath.Join("SketchMultipleMainFiles.pde"), files[0])
-
-	sketchPath = paths.New("testdata", "SketchSimple", "SketchSimple.ino")
-	files = CheckForPdeFiles(sketchPath)
-	require.Empty(t, files)
-
-	sketchPath = paths.New("testdata", "SketchPde", "SketchPde.pde")
-	files = CheckForPdeFiles(sketchPath)
-	require.Len(t, files, 1)
-	require.Equal(t, sketchPath.Parent().Join("SketchPde.pde"), files[0])
-
-	sketchPath = paths.New("testdata", "SketchMultipleMainFiles", "SketchMultipleMainFiles.ino")
-	files = CheckForPdeFiles(sketchPath)
-	require.Len(t, files, 1)
-	require.Equal(t, sketchPath.Parent().Join("SketchMultipleMainFiles.pde"), files[0])
-
-	sketchPath = paths.New("testdata", "SketchMultipleMainFiles", "SketchMultipleMainFiles.pde")
-	files = CheckForPdeFiles(sketchPath)
-	require.Len(t, files, 1)
-	require.Equal(t, sketchPath.Parent().Join("SketchMultipleMainFiles.pde"), files[0])
-}
-
 func TestNewSketchWithSymlink(t *testing.T) {
 	sketchPath, _ := paths.New("testdata", "SketchWithSymlink").Abs()
 	mainFilePath := sketchPath.Join("SketchWithSymlink.ino")

internal/cli/arguments/sketch.go

@@ -28,8 +28,7 @@ import (
 
 // InitSketchPath returns an instance of paths.Path pointing to sketchPath.
 // If sketchPath is an empty string returns the current working directory.
-// In both cases it warns the user if he's using deprecated files
-func InitSketchPath(path string, printWarnings bool) (sketchPath *paths.Path) {
+func InitSketchPath(path string) (sketchPath *paths.Path) {
 	if path != "" {
 		sketchPath = paths.New(path)
 	} else {
@@ -40,11 +39,6 @@ func InitSketchPath(path string, printWarnings bool) (sketchPath *paths.Path) {
 		logrus.Infof("Reading sketch from dir: %s", wd)
 		sketchPath = wd
 	}
-	if printWarnings {
-		if msg := sketch.WarnDeprecatedFiles(sketchPath); msg != "" {
-			feedback.Warning(msg)
-		}
-	}
 	return sketchPath
 }
 

internal/cli/board/attach.go

@@ -53,7 +53,7 @@ func initAttachCommand() *cobra.Command {
 }
 
 func runAttachCommand(path string, port *arguments.Port, fqbn string) {
-	sketchPath := arguments.InitSketchPath(path, true)
+	sketchPath := arguments.InitSketchPath(path)
 
 	portAddress, portProtocol, _ := port.GetPortAddressAndProtocol(nil, "", "")
 	newDefaults, err := sketch.SetSketchDefaults(context.Background(), &rpc.SetSketchDefaultsRequest{

internal/cli/compile/compile.go

@@ -158,12 +158,12 @@ func runCompileCommand(cmd *cobra.Command, args []string) {
 		path = args[0]
 	}
 
-	sketchPath := arguments.InitSketchPath(path, true)
-
+	sketchPath := arguments.InitSketchPath(path)
 	sk, err := sketch.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if err != nil {
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
+	feedback.WarnAboutDeprecatedFiles(sk)
 
 	var inst *rpc.Instance
 	var profile *rpc.Profile

internal/cli/debug/debug.go

@@ -81,11 +81,13 @@ func runDebugCommand(args []string, portArgs *arguments.Port, fqbnArg *arguments
 		path = args[0]
 	}
 
-	sketchPath := arguments.InitSketchPath(path, true)
+	sketchPath := arguments.InitSketchPath(path)
 	sk, err := sketch.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if err != nil {
 		feedback.FatalError(err, feedback.ErrGeneric)
 	}
+	feedback.WarnAboutDeprecatedFiles(sk)
+
 	fqbn, port := arguments.CalculateFQBNAndPort(portArgs, fqbnArg, instance, sk.GetDefaultFqbn(), sk.GetDefaultPort(), sk.GetDefaultProtocol())
 	debugConfigRequested := &rpc.GetDebugConfigRequest{
 		Instance:    instance,

commands/sketch/warn_deprecated.go renamed to internal/cli/feedback/warn_deprecated.go

@@ -13,33 +13,32 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to [email protected].
 
-package sketch
+package feedback
 
 import (
 	"fmt"
+	"strings"
 
-	paths "github.com/arduino/go-paths-helper"
+	rpc "github.com/arduino/arduino-cli/rpc/cc/arduino/cli/commands/v1"
 )
 
-// WarnDeprecatedFiles warns the user that a type of sketch files are deprecated
-func WarnDeprecatedFiles(sketchPath *paths.Path) string {
-	if sketchPath.IsNotDir() {
-		sketchPath = sketchPath.Parent()
+// WarnAboutDeprecatedFiles warns the user that a type of sketch files are deprecated
+func WarnAboutDeprecatedFiles(s *rpc.Sketch) {
+	var files []string
+	for _, f := range s.OtherSketchFiles {
+		if strings.HasSuffix(f, ".pde") {
+			files = append(files, f)
+		}
 	}
-
-	files, err := sketchPath.ReadDirRecursive()
-	if err != nil {
-		return ""
+	if strings.HasSuffix(s.MainFile, ".pde") {
+		files = append(files, s.MainFile)
 	}
-	files.FilterSuffix(".pde")
-
-	// .pde files are still supported but deprecated, this warning urges the user to rename them
 	if len(files) > 0 {
+		// .pde files are still supported but deprecated, this warning urges the user to rename them
 		msg := tr("Sketches with .pde extension are deprecated, please rename the following files to .ino:")
 		for _, f := range files {
 			msg += fmt.Sprintf("\n - %s", f)
 		}
-		return msg
+		Warning(msg)
 	}
-	return ""
 }

internal/cli/monitor/monitor.go

@@ -103,7 +103,7 @@ func runMonitorCmd(
 	// If both {--port --profile} are set we read the fqbn in the following order: profile -> default_fqbn -> discovery
 	// 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, false)
+	sketchPath := arguments.InitSketchPath(sketchPathArg)
 	sketch, err := sk.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
 	if err != nil && !portArgs.IsPortFlagSet() {
 		feedback.Fatal(

internal/cli/sketch/archive.go

@@ -60,10 +60,6 @@ func runArchiveCommand(args []string, includeBuildDir bool, overwrite bool) {
 		sketchPath = paths.New(args[0])
 	}
 
-	if msg := sk.WarnDeprecatedFiles(sketchPath); msg != "" {
-		feedback.Warning(msg)
-	}
-
 	archivePath := ""
 	if len(args) == 2 {
 		archivePath = args[1]

internal/cli/upload/upload.go

@@ -90,15 +90,13 @@ func runUploadCommand(args []string, uploadFieldsArgs map[string]string) {
 	if len(args) > 0 {
 		path = args[0]
 	}
-	sketchPath := arguments.InitSketchPath(path, true)
-
-	if msg := sk.WarnDeprecatedFiles(sketchPath); importDir == "" && importFile == "" && msg != "" {
-		feedback.Warning(msg)
-	}
-
+	sketchPath := arguments.InitSketchPath(path)
 	sketch, err := sk.LoadSketch(context.Background(), &rpc.LoadSketchRequest{SketchPath: sketchPath.String()})
-	if err != nil && importDir == "" && importFile == "" {
-		feedback.Fatal(tr("Error during Upload: %v", err), feedback.ErrGeneric)
+	if importDir == "" && importFile == "" {
+		if err != nil {
+			feedback.Fatal(tr("Error during Upload: %v", err), feedback.ErrGeneric)
+		}
+		feedback.WarnAboutDeprecatedFiles(sketch)
 	}
 
 	var inst *rpc.Instance