feature: improve logger initialization and usability - Add explicit logger initialization at startup - Make logger fields parameter optional for all log levels - Enable debug level logging by default - Remove console logging fallback for cleaner behavior (#102)

Author: andrzej-janczak

cli-v2.go

@@ -4,14 +4,25 @@ import (
 	"codacy/cli-v2/cmd"
 	"codacy/cli-v2/config"
 	config_file "codacy/cli-v2/config-file"
+	"codacy/cli-v2/utils/logger"
 	"fmt"
 	"os"
+
+	"github.com/sirupsen/logrus"
 )
 
 func main() {
 	// Initialize config global object
 	config.Init()
 
+	// Initialize logger
+	if err := logger.Initialize(&config.Config); err != nil {
+		fmt.Printf("Failed to initialize logger: %v\n", err)
+	}
+
+	// Log startup message
+	logger.Debug("Starting Codacy CLI.", logrus.Fields{})
+
 	// This also setup the config global !
 	configErr := config_file.ReadConfigFile(config.Config.ProjectConfigFile())
 
@@ -31,7 +42,17 @@ func main() {
 
 	// All other commands require a configuration file
 	if configErr != nil && len(os.Args) > 1 {
-		fmt.Println("No configuration file was found, execute init command first.")
+		if os.IsNotExist(configErr) {
+			message := "No configuration file was found, execute init command first."
+			logger.Info(message)
+			fmt.Println(message)
+		} else {
+			logger.Error("Configuration error", logrus.Fields{
+				"error": configErr.Error(),
+			})
+			fmt.Printf("Failed to parse configuration file: %v\n", configErr)
+			fmt.Println("Please check the file format and try again, or run init command to create a new configuration.")
+		}
 		return
 	}
 

utils/logger/logger.go

@@ -75,6 +75,13 @@ func Initialize(conf *config.ConfigType) error {
 	// Set up log rotation using lumberjack
 	logFile := filepath.Join(logsDir, "codacy-cli.log")
 
+	// Try to create/open the log file to test permissions
+	f, err := os.OpenFile(logFile, os.O_WRONLY|os.O_CREATE|os.O_APPEND, utils.DefaultFilePerms)
+	if err != nil {
+		return fmt.Errorf("failed to create/open log file: %w", err)
+	}
+	f.Close()
+
 	lumberjackLogger := &lumberjack.Logger{
 		Filename:   logFile,
 		MaxSize:    10,   // megabytes
@@ -86,7 +93,7 @@ func Initialize(conf *config.ConfigType) error {
 	// Configure logrus to use our custom formatter
 	fileLogger.SetFormatter(&CustomTextFormatter{})
 	fileLogger.SetOutput(lumberjackLogger)
-	fileLogger.SetLevel(logrus.InfoLevel)
+	fileLogger.SetLevel(logrus.DebugLevel)
 
 	// Enable caller information for file location
 	fileLogger.SetReportCaller(true)
@@ -103,21 +110,37 @@ func Log(level logrus.Level, msg string, fields logrus.Fields) {
 }
 
 // Info logs an info level message
-func Info(msg string, fields logrus.Fields) {
-	Log(logrus.InfoLevel, msg, fields)
+func Info(msg string, fields ...logrus.Fields) {
+	var f logrus.Fields
+	if len(fields) > 0 {
+		f = fields[0]
+	}
+	Log(logrus.InfoLevel, msg, f)
 }
 
 // Error logs an error level message
-func Error(msg string, fields logrus.Fields) {
-	Log(logrus.ErrorLevel, msg, fields)
+func Error(msg string, fields ...logrus.Fields) {
+	var f logrus.Fields
+	if len(fields) > 0 {
+		f = fields[0]
+	}
+	Log(logrus.ErrorLevel, msg, f)
 }
 
 // Debug logs a debug level message
-func Debug(msg string, fields logrus.Fields) {
-	Log(logrus.DebugLevel, msg, fields)
+func Debug(msg string, fields ...logrus.Fields) {
+	var f logrus.Fields
+	if len(fields) > 0 {
+		f = fields[0]
+	}
+	Log(logrus.DebugLevel, msg, f)
 }
 
 // Warn logs a warning level message
-func Warn(msg string, fields logrus.Fields) {
-	Log(logrus.WarnLevel, msg, fields)
+func Warn(msg string, fields ...logrus.Fields) {
+	var f logrus.Fields
+	if len(fields) > 0 {
+		f = fields[0]
+	}
+	Log(logrus.WarnLevel, msg, f)
 }