Fixed a lot of i18n.Tr formatting errors

This commit fixes invalid calls to i18n.Tr.

1. Missing positional arguments, for example:

  return fmt.Errorf(i18n.Tr("installing %[1]s tool: %[2]s"), tool, err)

in the above case the positional arguments must be part of the Tr call:

-    return fmt.Errorf(i18n.Tr("installing %[1]s tool: %[2]s"), tool, err)
+    return fmt.Errorf(i18n.Tr("installing %[1]s tool: %[2]s", tool, err))

2. This also makes the fmt.Errorf call useless and it could be replaced by
the less expensive errors.New:

-    return fmt.Errorf(i18n.Tr("installing %[1]s tool: %[2]s", tool, err))
+    return errors.New(i18n.Tr("installing %[1]s tool: %[2]s", tool, err))

but we have cases of useless calls even when the string is a constant,
for example:

-    err := fmt.Errorf(i18n.Tr("no instance specified"))
+    err := errors.New(i18n.Tr("no instance specified"))

Unfortunately, this imperfection is not detected by the linter.

3. The "%w" directive is not supported directly in i18n.Tr, so we have
   to wrap it around another fmt.Errorf:

-    return nil, fmt.Errorf(i18n.Tr("reading library headers: %w"), err)
+    return nil, fmt.Errorf("%s: %w", i18n.Tr("reading library headers"), err)

Author: cmaglie

commands/instances.go

@@ -17,6 +17,7 @@ package commands
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"net/url"
 	"path/filepath"
@@ -51,11 +52,11 @@ func installTool(ctx context.Context, pm *packagemanager.PackageManager, tool *c
 
 	taskCB(&rpc.TaskProgress{Name: i18n.Tr("Downloading missing tool %s", tool)})
 	if err := pme.DownloadToolRelease(ctx, tool, downloadCB); err != nil {
-		return fmt.Errorf(i18n.Tr("downloading %[1]s tool: %[2]s"), tool, err)
+		return errors.New(i18n.Tr("downloading %[1]s tool: %[2]s", tool, err))
 	}
 	taskCB(&rpc.TaskProgress{Completed: true})
 	if err := pme.InstallTool(tool, taskCB, true); err != nil {
-		return fmt.Errorf(i18n.Tr("installing %[1]s tool: %[2]s"), tool, err)
+		return errors.New(i18n.Tr("installing %[1]s tool: %[2]s", tool, err))
 	}
 	return nil
 }
@@ -182,7 +183,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 			if err != nil {
 				e := &cmderrors.InitFailedError{
 					Code:   codes.InvalidArgument,
-					Cause:  fmt.Errorf(i18n.Tr("Invalid additional URL: %v", err)),
+					Cause:  errors.New(i18n.Tr("Invalid additional URL: %v", err)),
 					Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_INVALID_INDEX_URL,
 				}
 				responseError(e.GRPCStatus())
@@ -220,7 +221,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 				if err != nil {
 					e := &cmderrors.InitFailedError{
 						Code:   codes.FailedPrecondition,
-						Cause:  fmt.Errorf(i18n.Tr("Loading index file: %v", err)),
+						Cause:  errors.New(i18n.Tr("Loading index file: %v", err)),
 						Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR,
 					}
 					responseError(e.GRPCStatus())
@@ -231,7 +232,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 			if err := pmb.LoadPackageIndex(URL); err != nil {
 				e := &cmderrors.InitFailedError{
 					Code:   codes.FailedPrecondition,
-					Cause:  fmt.Errorf(i18n.Tr("Loading index file: %v", err)),
+					Cause:  errors.New(i18n.Tr("Loading index file: %v", err)),
 					Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_INDEX_LOAD_ERROR,
 				}
 				responseError(e.GRPCStatus())
@@ -271,7 +272,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 			if latest == nil {
 				e := &cmderrors.InitFailedError{
 					Code:   codes.Internal,
-					Cause:  fmt.Errorf(i18n.Tr("can't find latest release of tool %s", name)),
+					Cause:  errors.New(i18n.Tr("can't find latest release of tool %s", name)),
 					Reason: rpc.FailedInstanceInitReason_FAILED_INSTANCE_INIT_REASON_TOOL_LOAD_ERROR,
 				}
 				responseError(e.GRPCStatus())
@@ -341,7 +342,7 @@ func (s *arduinoCoreServerImpl) Init(req *rpc.InitRequest, stream rpc.ArduinoCor
 	logrus.WithField("index", indexFile).Info("Loading libraries index file")
 	li, err := librariesindex.LoadIndex(indexFile)
 	if err != nil {
-		s := status.Newf(codes.FailedPrecondition, i18n.Tr("Loading index file: %v"), err)
+		s := status.Newf(codes.FailedPrecondition, i18n.Tr("Loading index file: %v", err))
 		responseError(s)
 		li = librariesindex.EmptyIndex
 	}

commands/service_board_list.go

@@ -270,7 +270,7 @@ func BoardListWatchProxyToChan(ctx context.Context) (rpc.ArduinoCoreService_Boar
 func (s *arduinoCoreServerImpl) BoardListWatch(req *rpc.BoardListWatchRequest, stream rpc.ArduinoCoreService_BoardListWatchServer) error {
 	syncSend := NewSynchronizedSend(stream.Send)
 	if req.GetInstance() == nil {
-		err := fmt.Errorf(i18n.Tr("no instance specified"))
+		err := errors.New(i18n.Tr("no instance specified"))
 		syncSend.Send(&rpc.BoardListWatchResponse{
 			EventType: "error",
 			Error:     err.Error(),

commands/service_compile.go

@@ -118,7 +118,7 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 		if targetPlatform == nil {
 			return &cmderrors.PlatformNotFoundError{
 				Platform: fmt.Sprintf("%s:%s", fqbn.Package, fqbn.PlatformArch),
-				Cause:    fmt.Errorf(i18n.Tr("platform not installed")),
+				Cause:    errors.New(i18n.Tr("platform not installed")),
 			}
 		}
 		return &cmderrors.InvalidFQBNError{Cause: err}
@@ -152,7 +152,7 @@ func (s *arduinoCoreServerImpl) Compile(req *rpc.CompileRequest, stream rpc.Ardu
 	encryptProp := boardBuildProperties.ContainsKey("build.keys.encrypt_key")
 	// we verify that all the properties for the secure boot keys are defined or none of them is defined.
 	if !(keychainProp == signProp && signProp == encryptProp) {
-		return fmt.Errorf(i18n.Tr("Firmware encryption/signing requires all the following properties to be defined: %s", "build.keys.keychain, build.keys.sign_key, build.keys.encrypt_key"))
+		return errors.New(i18n.Tr("Firmware encryption/signing requires all the following properties to be defined: %s", "build.keys.keychain, build.keys.sign_key, build.keys.encrypt_key"))
 	}
 
 	// Generate or retrieve build path

commands/service_library_install.go

@@ -138,7 +138,7 @@ func (s *arduinoCoreServerImpl) LibraryInstall(req *rpc.LibraryInstallRequest, s
 
 		if req.GetNoOverwrite() {
 			if installTask.ReplacedLib != nil {
-				return fmt.Errorf(i18n.Tr("Library %[1]s is already installed, but with a different version: %[2]s", libRelease, installTask.ReplacedLib))
+				return errors.New(i18n.Tr("Library %[1]s is already installed, but with a different version: %[2]s", libRelease, installTask.ReplacedLib))
 			}
 		}
 		libReleasesToInstall[libRelease] = installTask

commands/service_upload.go

@@ -694,18 +694,18 @@ func detectUploadPort(
 func runTool(recipeID string, props *properties.Map, outStream, errStream io.Writer, verbose bool, dryRun bool, toolEnv []string) error {
 	recipe, ok := props.GetOk(recipeID)
 	if !ok {
-		return fmt.Errorf(i18n.Tr("recipe not found '%s'"), recipeID)
+		return errors.New(i18n.Tr("recipe not found '%s'", recipeID))
 	}
 	if strings.TrimSpace(recipe) == "" {
 		return nil // Nothing to run
 	}
 	if props.IsPropertyMissingInExpandPropsInString("serial.port", recipe) || props.IsPropertyMissingInExpandPropsInString("serial.port.file", recipe) {
-		return fmt.Errorf(i18n.Tr("no upload port provided"))
+		return errors.New(i18n.Tr("no upload port provided"))
 	}
 	cmdLine := props.ExpandPropsInString(recipe)
 	cmdArgs, err := properties.SplitQuotedString(cmdLine, `"'`, false)
 	if err != nil {
-		return fmt.Errorf(i18n.Tr("invalid recipe '%[1]s': %[2]s"), recipe, err)
+		return errors.New(i18n.Tr("invalid recipe '%[1]s': %[2]s", recipe, err))
 	}
 
 	// Run Tool
@@ -718,18 +718,18 @@ func runTool(recipeID string, props *properties.Map, outStream, errStream io.Wri
 	}
 	cmd, err := paths.NewProcess(toolEnv, cmdArgs...)
 	if err != nil {
-		return fmt.Errorf(i18n.Tr("cannot execute upload tool: %s"), err)
+		return errors.New(i18n.Tr("cannot execute upload tool: %s", err))
 	}
 
 	cmd.RedirectStdoutTo(outStream)
 	cmd.RedirectStderrTo(errStream)
 
 	if err := cmd.Start(); err != nil {
-		return fmt.Errorf(i18n.Tr("cannot execute upload tool: %s"), err)
+		return errors.New(i18n.Tr("cannot execute upload tool: %s", err))
 	}
 
 	if err := cmd.Wait(); err != nil {
-		return fmt.Errorf(i18n.Tr("uploading error: %s"), err)
+		return errors.New(i18n.Tr("uploading error: %s", err))
 	}
 
 	return nil
@@ -751,7 +751,7 @@ func determineBuildPathAndSketchName(importFile, importDir string, sk *sketch.Sk
 	// Case 1: importFile flag has been specified
 	if importFile != "" {
 		if importDir != "" {
-			return nil, "", fmt.Errorf(i18n.Tr("%s and %s cannot be used together", "importFile", "importDir"))
+			return nil, "", errors.New(i18n.Tr("%s and %s cannot be used together", "importFile", "importDir"))
 		}
 
 		// We have a path like "path/to/my/build/SketchName.ino.bin". We are going to
@@ -761,7 +761,7 @@ func determineBuildPathAndSketchName(importFile, importDir string, sk *sketch.Sk
 
 		importFilePath := paths.New(importFile)
 		if !importFilePath.Exist() {
-			return nil, "", fmt.Errorf(i18n.Tr("binary file not found in %s"), importFilePath)
+			return nil, "", errors.New(i18n.Tr("binary file not found in %s", importFilePath))
 		}
 		return importFilePath.Parent(), strings.TrimSuffix(importFilePath.Base(), importFilePath.Ext()), nil
 	}

internal/arduino/builder/builder.go

@@ -482,7 +482,7 @@ func (b *Builder) build() error {
 func (b *Builder) prepareCommandForRecipe(buildProperties *properties.Map, recipe string, removeUnsetProperties bool) (*paths.Process, error) {
 	pattern := buildProperties.Get(recipe)
 	if pattern == "" {
-		return nil, fmt.Errorf(i18n.Tr("%[1]s pattern is missing"), recipe)
+		return nil, errors.New(i18n.Tr("%[1]s pattern is missing", recipe))
 	}
 
 	commandLine := buildProperties.ExpandPropsInString(pattern)

internal/arduino/builder/core.go

@@ -19,7 +19,6 @@ import (
 	"crypto/md5"
 	"encoding/hex"
 	"errors"
-	"fmt"
 	"os"
 	"strings"
 
@@ -93,7 +92,7 @@ func (b *Builder) compileCore() (*paths.Path, paths.PathList, error) {
 		targetArchivedCore = b.coreBuildCachePath.Join(archivedCoreName, "core.a")
 
 		if _, err := buildcache.New(b.coreBuildCachePath).GetOrCreate(archivedCoreName); errors.Is(err, buildcache.CreateDirErr) {
-			return nil, nil, fmt.Errorf(i18n.Tr("creating core cache folder: %s", err))
+			return nil, nil, errors.New(i18n.Tr("creating core cache folder: %s", err))
 		}
 
 		var canUseArchivedCore bool

internal/arduino/builder/sizer.go

@@ -212,7 +212,7 @@ func (b *Builder) checkSize() (ExecutablesFileSections, error) {
 func (b *Builder) execSizeRecipe(properties *properties.Map) (textSize int, dataSize int, eepromSize int, resErr error) {
 	command, err := b.prepareCommandForRecipe(properties, "recipe.size.pattern", false)
 	if err != nil {
-		resErr = fmt.Errorf(i18n.Tr("Error while determining sketch size: %s"), err)
+		resErr = errors.New(i18n.Tr("Error while determining sketch size: %s", err))
 		return
 	}
 	if b.logger.Verbose() {
@@ -222,11 +222,11 @@ func (b *Builder) execSizeRecipe(properties *properties.Map) (textSize int, data
 	command.RedirectStdoutTo(commandStdout)
 	command.RedirectStderrTo(b.logger.Stderr())
 	if err := command.Start(); err != nil {
-		resErr = fmt.Errorf(i18n.Tr("Error while determining sketch size: %s"), err)
+		resErr = errors.New(i18n.Tr("Error while determining sketch size: %s", err))
 		return
 	}
 	if err := command.Wait(); err != nil {
-		resErr = fmt.Errorf(i18n.Tr("Error while determining sketch size: %s"), err)
+		resErr = errors.New(i18n.Tr("Error while determining sketch size: %s", err))
 		return
 	}
 
@@ -237,7 +237,7 @@ func (b *Builder) execSizeRecipe(properties *properties.Map) (textSize int, data
 
 	textSize, err = computeSize(properties.Get("recipe.size.regex"), out)
 	if err != nil {
-		resErr = fmt.Errorf(i18n.Tr("Invalid size regexp: %s"), err)
+		resErr = errors.New(i18n.Tr("Invalid size regexp: %s", err))
 		return
 	}
 	if textSize == -1 {
@@ -247,13 +247,13 @@ func (b *Builder) execSizeRecipe(properties *properties.Map) (textSize int, data
 
 	dataSize, err = computeSize(properties.Get("recipe.size.regex.data"), out)
 	if err != nil {
-		resErr = fmt.Errorf(i18n.Tr("Invalid data size regexp: %s"), err)
+		resErr = errors.New(i18n.Tr("Invalid data size regexp: %s", err))
 		return
 	}
 
 	eepromSize, err = computeSize(properties.Get("recipe.size.regex.eeprom"), out)
 	if err != nil {
-		resErr = fmt.Errorf(i18n.Tr("Invalid eeprom size regexp: %s"), err)
+		resErr = errors.New(i18n.Tr("Invalid eeprom size regexp: %s", err))
 		return
 	}
 

internal/arduino/builder/sketch.go

@@ -78,7 +78,7 @@ func (b *Builder) sketchMergeSources(overrides map[string]string) (int, string,
 		}
 		data, err := f.ReadFile()
 		if err != nil {
-			return "", fmt.Errorf(i18n.Tr("reading file %[1]s: %[2]s"), f, err)
+			return "", errors.New(i18n.Tr("reading file %[1]s: %[2]s", f, err))
 		}
 		return string(data), nil
 	}

internal/arduino/cores/board.go

@@ -16,7 +16,7 @@
 package cores
 
 import (
-	"fmt"
+	"errors"
 	"strings"
 	"sync"
 
@@ -140,14 +140,14 @@ func (b *Board) GetBuildProperties(fqbn *FQBN) (*properties.Map, error) {
 	// Check for residual invalid options...
 	for option, value := range config.AsMap() {
 		if option == "" {
-			return nil, fmt.Errorf(i18n.Tr("invalid empty option found"))
+			return nil, errors.New(i18n.Tr("invalid empty option found"))
 		}
 		if _, ok := b.configOptions.GetOk(option); !ok {
-			return nil, fmt.Errorf(i18n.Tr("invalid option '%s'"), option)
+			return nil, errors.New(i18n.Tr("invalid option '%s'", option))
 		}
 		optionsConf, ok := b.configOptionProperties[option+"="+value]
 		if !ok {
-			return nil, fmt.Errorf(i18n.Tr("invalid value '%[1]s' for option '%[2]s'"), value, option)
+			return nil, errors.New(i18n.Tr("invalid value '%[1]s' for option '%[2]s'", value, option))
 		}
 		buildProperties.Merge(optionsConf)
 	}
@@ -163,7 +163,7 @@ func (b *Board) GetBuildProperties(fqbn *FQBN) (*properties.Map, error) {
 func (b *Board) GeneratePropertiesForConfiguration(config string) (*properties.Map, error) {
 	fqbn, err := ParseFQBN(b.String() + ":" + config)
 	if err != nil {
-		return nil, fmt.Errorf(i18n.Tr("parsing fqbn: %s"), err)
+		return nil, errors.New(i18n.Tr("parsing fqbn: %s", err))
 	}
 	return b.GetBuildProperties(fqbn)
 }

internal/arduino/cores/fqbn.go

@@ -16,7 +16,7 @@
 package cores
 
 import (
-	"fmt"
+	"errors"
 	"regexp"
 	"strings"
 
@@ -47,7 +47,7 @@ func ParseFQBN(fqbnIn string) (*FQBN, error) {
 	// Split fqbn
 	fqbnParts := strings.Split(fqbnIn, ":")
 	if len(fqbnParts) < 3 || len(fqbnParts) > 4 {
-		return nil, fmt.Errorf("not an FQBN: %s", fqbnIn)
+		return nil, errors.New(i18n.Tr("not an FQBN: %s", fqbnIn))
 	}
 
 	fqbn := &FQBN{
@@ -57,33 +57,33 @@ func ParseFQBN(fqbnIn string) (*FQBN, error) {
 		Configs:      properties.NewMap(),
 	}
 	if fqbn.BoardID == "" {
-		return nil, fmt.Errorf(i18n.Tr("empty board identifier"))
+		return nil, errors.New(i18n.Tr("empty board identifier"))
 	}
 	// Check if the fqbn contains invalid characters
 	fqbnValidationRegex := regexp.MustCompile(`^[a-zA-Z0-9_.-]*$`)
 	for i := 0; i < 3; i++ {
 		if !fqbnValidationRegex.MatchString(fqbnParts[i]) {
-			return nil, fmt.Errorf(i18n.Tr("fqbn's field %s contains an invalid character"), fqbnParts[i])
+			return nil, errors.New(i18n.Tr("fqbn's field %s contains an invalid character", fqbnParts[i]))
 		}
 	}
 	if len(fqbnParts) > 3 {
 		for _, pair := range strings.Split(fqbnParts[3], ",") {
 			parts := strings.SplitN(pair, "=", 2)
 			if len(parts) != 2 {
-				return nil, fmt.Errorf(i18n.Tr("invalid config option: %s"), pair)
+				return nil, errors.New(i18n.Tr("invalid config option: %s", pair))
 			}
 			k := strings.TrimSpace(parts[0])
 			v := strings.TrimSpace(parts[1])
 			if k == "" {
-				return nil, fmt.Errorf(i18n.Tr("invalid config option: %s"), pair)
+				return nil, errors.New(i18n.Tr("invalid config option: %s", pair))
 			}
 			if !fqbnValidationRegex.MatchString(k) {
-				return nil, fmt.Errorf(i18n.Tr("config key %s contains an invalid character"), k)
+				return nil, errors.New(i18n.Tr("config key %s contains an invalid character", k))
 			}
 			// The config value can also contain the = symbol
 			valueValidationRegex := regexp.MustCompile(`^[a-zA-Z0-9=_.-]*$`)
 			if !valueValidationRegex.MatchString(v) {
-				return nil, fmt.Errorf(i18n.Tr("config value %s contains an invalid character"), v)
+				return nil, errors.New(i18n.Tr("config value %s contains an invalid character", v))
 			}
 			fqbn.Configs.Set(k, v)
 		}

internal/arduino/cores/packageindex/index.go

@@ -17,6 +17,7 @@ package packageindex
 
 import (
 	"encoding/json"
+	"errors"
 	"fmt"
 
 	"github.com/arduino/arduino-cli/internal/arduino/cores"
@@ -273,7 +274,7 @@ func (inPlatformRelease indexPlatformRelease) extractPlatformIn(outPackage *core
 
 	size, err := inPlatformRelease.Size.Int64()
 	if err != nil {
-		return fmt.Errorf(i18n.Tr("invalid platform archive size: %s"), err)
+		return errors.New(i18n.Tr("invalid platform archive size: %s", err))
 	}
 	outPlatformRelease := outPlatform.GetOrCreateRelease(inPlatformRelease.Version)
 	outPlatformRelease.Name = inPlatformRelease.Name