feature: enhance command handling and configuration validation

- Updated command handling to include 'version' and 'help' in the list of commands that do not require configuration.
- Refactored codacy.yaml validation logic to ensure it is performed for all commands except 'init', 'help', and 'version'.
- Introduced a new validation function to check for the existence and validity of the codacy.yaml file, improving error handling and user feedback.

Author: andrzej-janczak

cli-v2.go

@@ -39,10 +39,13 @@ func main() {
 		}
 	}
 
-	// Check if command is init/update
-	if len(os.Args) > 1 && (os.Args[1] == "init" || os.Args[1] == "update") {
-		cmd.Execute()
-		return
+	// Check if command is init/update/version/help - these don't require configuration
+	if len(os.Args) > 1 {
+		cmdName := os.Args[1]
+		if cmdName == "init" || cmdName == "update" || cmdName == "version" || cmdName == "help" {
+			cmd.Execute()
+			return
+		}
 	}
 
 	// All other commands require a configuration file

cmd/config.go

@@ -341,25 +341,14 @@ func updateLanguagesConfig(detectedLanguages map[string]struct{}, toolsConfigDir
 func updateCodacyYAML(detectedLanguages map[string]struct{}, codacyYAMLPath string, defaultToolLangMap map[string]domain.ToolLanguageInfo, initFlags domain.InitFlags, cliMode string) error {
 	var configData map[string]interface{}
 
-	if _, err := os.Stat(codacyYAMLPath); err == nil {
-		content, err := os.ReadFile(codacyYAMLPath)
-		if err != nil {
-			return fmt.Errorf("error reading %s: %w", codacyYAMLPath, err)
-		}
-		if err := yaml.Unmarshal(content, &configData); err != nil {
-			if strings.Contains(err.Error(), "cannot unmarshal") {
-				return fmt.Errorf(
-					"❌ Fatal: %s contains invalid configuration - run 'codacy-cli config reset' to fix: %v",
-					filepath.Base(codacyYAMLPath), err)
-			}
-			return fmt.Errorf(
-				"❌ Fatal: %s is broken or has invalid YAML format - run 'codacy-cli config reset' to reinitialize your configuration",
-				filepath.Base(codacyYAMLPath))
-		}
-	} else if os.IsNotExist(err) {
-		return fmt.Errorf("codacy.yaml file not found")
-	} else {
-		return fmt.Errorf("error accessing %s: %w", codacyYAMLPath, err)
+	// Read and parse codacy.yaml (validation is done globally in PersistentPreRun)
+	content, err := os.ReadFile(codacyYAMLPath)
+	if err != nil {
+		return fmt.Errorf("error reading %s: %w", codacyYAMLPath, err)
+	}
+
+	if err := yaml.Unmarshal(content, &configData); err != nil {
+		return fmt.Errorf("error parsing %s: %w", codacyYAMLPath, err)
 	}
 
 	toolsRaw, _ := configData["tools"].([]interface{})

cmd/root.go

@@ -36,6 +36,18 @@ var rootCmd = &cobra.Command{
 			"full_command": maskedArgs,
 			"args":         args,
 		})
+
+		// Validate codacy.yaml for all commands except init, help, and version
+		if !shouldSkipValidation(cmd.Name()) {
+			if err := validateCodacyYAML(); err != nil {
+				logger.Error("Global validation failed", logrus.Fields{
+					"command": cmd.Name(),
+					"error":   err.Error(),
+				})
+				fmt.Println(err)
+				os.Exit(1)
+			}
+		}
 	},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check if .codacy directory exists

cmd/validation.go

@@ -0,0 +1,94 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"codacy/cli-v2/config"
+	"codacy/cli-v2/utils/logger"
+
+	"github.com/sirupsen/logrus"
+	"gopkg.in/yaml.v3"
+)
+
+// validateCodacyYAML validates that codacy.yaml exists and is not empty
+// Returns an error if validation fails, nil if validation passes
+func validateCodacyYAML() error {
+	codacyYAMLPath := config.Config.ProjectConfigFile()
+
+	// Check if file exists
+	if _, err := os.Stat(codacyYAMLPath); os.IsNotExist(err) {
+		logger.Error("codacy.yaml file not found", logrus.Fields{
+			"file": codacyYAMLPath,
+		})
+		return fmt.Errorf("❌ Fatal: codacy.yaml file not found. Please run 'codacy-cli init' to initialize your configuration first")
+	} else if err != nil {
+		logger.Error("Error accessing codacy.yaml file", logrus.Fields{
+			"file":  codacyYAMLPath,
+			"error": err,
+		})
+		return fmt.Errorf("error accessing %s: %w", codacyYAMLPath, err)
+	}
+
+	// Read file content
+	content, err := os.ReadFile(codacyYAMLPath)
+	if err != nil {
+		logger.Error("Failed to read codacy.yaml file", logrus.Fields{
+			"file":  codacyYAMLPath,
+			"error": err,
+		})
+		return fmt.Errorf("error reading %s: %w", codacyYAMLPath, err)
+	}
+
+	// Check if file is empty or contains only whitespace
+	if len(strings.TrimSpace(string(content))) == 0 {
+		logger.Error("codacy.yaml file is empty", logrus.Fields{
+			"file": codacyYAMLPath,
+		})
+		return fmt.Errorf("❌ Fatal: %s is empty. Please run 'codacy-cli init' to initialize your configuration first", filepath.Base(codacyYAMLPath))
+	}
+
+	// Try to parse YAML to ensure it's valid
+	var configData map[string]interface{}
+	if err := yaml.Unmarshal(content, &configData); err != nil {
+		logger.Error("Failed to parse codacy.yaml file", logrus.Fields{
+			"file":  codacyYAMLPath,
+			"error": err,
+		})
+		if strings.Contains(err.Error(), "cannot unmarshal") {
+			return fmt.Errorf("❌ Fatal: %s contains invalid configuration - run 'codacy-cli config reset' to fix: %v", filepath.Base(codacyYAMLPath), err)
+		}
+		return fmt.Errorf("❌ Fatal: %s is broken or has invalid YAML format - run 'codacy-cli config reset' to reinitialize your configuration", filepath.Base(codacyYAMLPath))
+	}
+
+	// Ensure configData is not nil after unmarshaling
+	if configData == nil {
+		logger.Error("codacy.yaml unmarshaled to nil data", logrus.Fields{
+			"file": codacyYAMLPath,
+		})
+		return fmt.Errorf("❌ Fatal: %s contains no valid configuration. Please run 'codacy-cli init' to initialize your configuration first", filepath.Base(codacyYAMLPath))
+	}
+
+	return nil
+}
+
+// shouldSkipValidation checks if the current command should skip codacy.yaml validation
+func shouldSkipValidation(cmdName string) bool {
+	skipCommands := []string{
+		"init",
+		"help",
+		"version",
+		"reset",      // config reset should work even with empty/invalid codacy.yaml
+		"codacy-cli", // root command when called without subcommands
+	}
+
+	for _, skipCmd := range skipCommands {
+		if cmdName == skipCmd {
+			return true
+		}
+	}
+
+	return false
+}