Create feedback package for user feedback

Moving the error logging helper function to a dedicated internal package will make it avaiable for use by any of the
module's packages.

Author: per1234

internal/feedback/feedback.go

@@ -0,0 +1,38 @@
+// This file is part of libraries-repository-engine.
+//
+// Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published
+// by the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+//
+// You can be released from the requirements of the above licenses by purchasing
+// a commercial license. Buying such a license is mandatory if you want to
+// modify or otherwise use the software for commercial activities involving the
+// Arduino software without disclosing the source code of your own applications.
+// To purchase a commercial license, send an email to license@arduino.cc.
+
+// Package feedback provides feedback to the user.
+package feedback
+
+import (
+	"log"
+)
+
+// LogError logs non-nil errors and returns whether the error was nil.
+func LogError(err error) bool {
+	if err != nil {
+		log.Println(err)
+		return true
+	}
+	return false
+}

sync_libraries.go

@@ -33,6 +33,7 @@ import (
 	"path/filepath"
 
 	cc "github.com/arduino/golang-concurrent-workers"
+	"github.com/arduino/libraries-repository-engine/internal/feedback"
 	"github.com/arduino/libraries-repository-engine/internal/libraries"
 	"github.com/arduino/libraries-repository-engine/internal/libraries/db"
 	"github.com/arduino/libraries-repository-engine/internal/libraries/gitutils"
@@ -52,14 +53,6 @@ type Config struct {
 	ArduinoLintPath string
 }
 
-func logError(err error) bool {
-	if err != nil {
-		log.Println(err)
-		return true
-	}
-	return false
-}
-
 var config *Config
 
 func main() {
@@ -86,13 +79,13 @@ func main() {
 
 func syncLibraries(reposFile string) {
 	if _, err := os.Stat(reposFile); os.IsNotExist(err) {
-		logError(err)
+		feedback.LogError(err)
 		os.Exit(1)
 	}
 
 	log.Println("Synchronizing libraries...")
 	repos, err := libraries.ListRepos(reposFile)
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 
@@ -142,11 +135,11 @@ func syncLibraries(reposFile string) {
 	}()
 
 	for err := range pool.Errors {
-		logError(err)
+		feedback.LogError(err)
 	}
 
 	libraryIndex, err := libraryDb.OutputLibraryIndex()
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 
@@ -157,48 +150,48 @@ func syncLibraries(reposFile string) {
 
 func serializeLibraryIndex(libraryIndex interface{}, libraryIndexFile string) {
 	file, err := os.Create(libraryIndexFile)
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 	defer file.Close()
 
 	b, err := json.MarshalIndent(libraryIndex, "", "  ")
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 
 	_, err = file.Write(b)
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 }
 
 func readConf(configFile string) *Config {
 	if _, err := os.Stat(configFile); os.IsNotExist(err) {
-		logError(err)
+		feedback.LogError(err)
 		os.Exit(1)
 	}
 
 	file, err := os.Open(configFile)
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 	decoder := json.NewDecoder(file)
 	config := Config{}
 	err = decoder.Decode(&config)
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 	return &config
 }
 
 func setup(config *Config) {
 	err := os.MkdirAll(config.GitClonesFolder, os.FileMode(0777))
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 	err = os.MkdirAll(config.LibrariesFolder, os.FileMode(0777))
-	if logError(err) {
+	if feedback.LogError(err) {
 		os.Exit(1)
 	}
 }