refactor: unify error handling in internal/cmd

Added `handleError` utility function to standardize error handling

Author: ashwingopalsamy-solaris

go.mod

@@ -1,16 +1,16 @@
 module github.com/conventionalcommit/commitlint
 
-go 1.17
+go 1.23.0
 
 require (
 	github.com/conventionalcommit/parser v0.7.1
-	github.com/urfave/cli/v2 v2.11.1
-	golang.org/x/mod v0.5.1
+	github.com/urfave/cli/v2 v2.27.5
+	golang.org/x/mod v0.21.0
 	gopkg.in/yaml.v2 v2.4.0
 )
 
 require (
-	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
+	github.com/cpuguy83/go-md2man/v2 v2.0.5 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
-	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
+	github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 // indirect
 )

go.sum

@@ -3,16 +3,24 @@ github.com/conventionalcommit/parser v0.7.1 h1:oAzcrEqyyGnzCeNOBqGx2qnxISxneUuBi
 github.com/conventionalcommit/parser v0.7.1/go.mod h1:k3teTA7nWpRrk7sjAihpAXm+1QLu1OscGrxclMHgEyc=
 github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/cpuguy83/go-md2man/v2 v2.0.5 h1:ZtcqGrnekaHpVLArFSe4HK5DoKx1T0rq2DwVB0alcyc=
+github.com/cpuguy83/go-md2man/v2 v2.0.5/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/urfave/cli/v2 v2.11.1 h1:UKK6SP7fV3eKOefbS87iT9YHefv7iB/53ih6e+GNAsE=
 github.com/urfave/cli/v2 v2.11.1/go.mod h1:f8iq5LtQ/bLxafbdBSLPPNsgaW0l/2fYYEHhAyPlwvo=
+github.com/urfave/cli/v2 v2.27.5 h1:WoHEJLdsXr6dDWoJgMq/CboDmyY/8HMMH1fTECbih+w=
+github.com/urfave/cli/v2 v2.27.5/go.mod h1:3Sevf16NykTbInEnD0yKkjDAeZDS0A6bzhBH5hrMvTQ=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
 github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
+github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1 h1:gEOO8jv9F4OT7lGCjxCBTO/36wtF6j2nSip77qHd4x4=
+github.com/xrash/smetrics v0.0.0-20240521201337-686a1a2994c1/go.mod h1:Ohn+xnUBiLI6FVj/9LpzZWtj1/D6lUovWYBkxHVV3aM=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
 golang.org/x/mod v0.5.1 h1:OJxoQ/rynoF0dcCdI7cLPktw/hR2cueqYfjm43oqK38=
 golang.org/x/mod v0.5.1/go.mod h1:5OXOZSfqPIIbmVBIIKWRFfZjPR0E5r58TLhUjH0a2Ro=
+golang.org/x/mod v0.21.0 h1:vvrHzRwRfVKSiLrG+d4FMl/Qi4ukBCE6kZlTUkDYRT0=
+golang.org/x/mod v0.21.0/go.mod h1:6SkKJ3Xj0I0BrPOZoBy3bdMptDDU9oJrpohJ3eWZ1fY=
 golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=

internal/cmd/cli.go

@@ -4,7 +4,7 @@ package cmd
 import (
 	"fmt"
 
-	cli "github.com/urfave/cli/v2"
+	"github.com/urfave/cli/v2"
 
 	"github.com/conventionalcommit/commitlint/internal"
 )
@@ -49,7 +49,8 @@ func newLintCmd() *cli.Command {
 		Action: func(ctx *cli.Context) error {
 			confFilePath := ctx.String("config")
 			fileInput := ctx.String("message")
-			return lintMsg(confFilePath, fileInput)
+			err := lintMsg(confFilePath, fileInput)
+			return handleError(err, "Failed to run lint command")
 		},
 	}
 }
@@ -76,7 +77,7 @@ func newInitCmd() *cli.Command {
 			hooksPath := ctx.String("hookspath")
 
 			err := initLint(confPath, hooksPath, isGlobal, isReplace)
-			if err != nil {
+			if handleError(err, "Failed to initialize commitlint") != nil {
 				if isHookExists(err) {
 					fmt.Println("commitlint init failed")
 					fmt.Println("run with --replace to replace existing files")
@@ -112,7 +113,7 @@ func newConfigCmd() *cli.Command {
 			isReplace := ctx.Bool("replace")
 			fileName := ctx.String("file")
 			err := configCreate(fileName, isReplace)
-			if err != nil {
+			if handleError(err, "Failed to create config file") != nil {
 				if isConfExists(err) {
 					fmt.Println("config create failed")
 					fmt.Println("run with --replace to replace existing file")
@@ -144,10 +145,10 @@ func newConfigCmd() *cli.Command {
 				return nil
 			}
 			if len(errs) == 1 {
-				return errs[0]
+				return handleError(errs[0], "Config check failed")
 			}
 			merr := multiError(errs)
-			return &merr
+			return handleError(&merr, "Config check failed")
 		},
 	}
 
@@ -170,9 +171,9 @@ func newHookCmd() *cli.Command {
 			isReplace := ctx.Bool("replace")
 			hooksPath := ctx.String("hookspath")
 			err := hookCreate(hooksPath, isReplace)
-			if err != nil {
+			if handleError(err, "Failed to create hooks") != nil {
 				if isHookExists(err) {
-					fmt.Println("create failed. hook files already exists")
+					fmt.Println("create failed. hook files already exist")
 					fmt.Println("run with --replace to replace existing hook files")
 					return nil
 				}
@@ -195,7 +196,7 @@ func newDebugCmd() *cli.Command {
 		Name:  "debug",
 		Usage: "prints useful information for debugging",
 		Action: func(ctx *cli.Context) error {
-			return printDebug()
+			return handleError(printDebug(), "Debugging information failed")
 		},
 	}
 }

internal/cmd/cmd.go

@@ -7,7 +7,8 @@ import (
 
 // Run runs commitlint cli with os.Args
 func Run() error {
-	return newCliApp().Run(os.Args)
+	err := newCliApp().Run(os.Args)
+	return handleError(err, "Failed to run commitlint CLI")
 }
 
 type multiError []error

internal/cmd/config.go

@@ -11,41 +11,42 @@ import (
 // configCreate is the callback function for create config command
 func configCreate(fileName string, isReplace bool) (retErr error) {
 	outPath := filepath.Join(".", fileName)
+
 	// if config file already exists skip creating or overwriting it
 	if _, err := os.Stat(outPath); !os.IsNotExist(err) {
 		if !isReplace {
-			return errConfigExist
+			return handleError(errConfigExist, "Config file already exists")
 		}
 	}
 
 	outFilePath := filepath.Clean(outPath)
 	f, err := os.Create(outFilePath)
-	if err != nil {
+	if handleError(err, "Failed to create config file") != nil {
 		return err
 	}
 	defer func() {
 		err := f.Close()
 		if retErr == nil && err != nil {
-			retErr = err
+			retErr = handleError(err, "Failed to close config file")
 		}
 	}()
 
 	w := bufio.NewWriter(f)
 	defer func() {
 		err := w.Flush()
 		if retErr == nil && err != nil {
-			retErr = err
+			retErr = handleError(err, "Failed to flush writer")
 		}
 	}()
 
 	defConf := config.NewDefault()
-	return config.WriteTo(w, defConf)
+	return handleError(config.WriteTo(w, defConf), "Failed to write config to file")
 }
 
 // configCheck is the callback function for check/verify command
 func configCheck(confPath string) []error {
 	conf, err := config.Parse(confPath)
-	if err != nil {
+	if handleError(err, "Failed to parse configuration file") != nil {
 		return []error{err}
 	}
 	return config.Validate(conf)

internal/cmd/debug.go

@@ -17,22 +17,22 @@ func printDebug() error {
 	w.WriteByte('\n')
 
 	gitVer, err := getGitVersion()
-	if err != nil {
+	if handleError(err, "Failed to get Git version") != nil {
 		return err
 	}
 
 	localConf, err := getGitHookConfig(false)
-	if err != nil {
+	if handleError(err, "Failed to get local Git hook configuration") != nil {
 		return err
 	}
 
 	globalConf, err := getGitHookConfig(true)
-	if err != nil {
+	if handleError(err, "Failed to get global Git hook configuration") != nil {
 		return err
 	}
 
 	confFile, confType, err := internal.LookupConfigPath()
-	if err != nil {
+	if handleError(err, "Failed to lookup configuration path") != nil {
 		return err
 	}
 
@@ -67,7 +67,7 @@ func getGitVersion() (string, error) {
 	cmd.Stdout = b
 	cmd.Stderr = os.Stderr
 	err := cmd.Run()
-	if err != nil {
+	if handleError(err, "Failed to execute 'git version' command") != nil {
 		return "", err
 	}
 
@@ -90,7 +90,7 @@ func getGitHookConfig(isGlobal bool) (string, error) {
 	cmd.Stdout = b
 
 	err := cmd.Run()
-	if err != nil {
+	if handleError(err, "Failed to execute 'git config core.hooksPath' command") != nil {
 		return "", err
 	}
 

internal/cmd/error.go

@@ -0,0 +1,17 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/urfave/cli/v2"
+)
+
+// handleError handles and logs errors in a consistent way
+func handleError(err error, customMessage string) error {
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "ERROR: %s - %v\n", customMessage, err)
+		return cli.Exit(customMessage, 1)
+	}
+	return nil
+}

internal/cmd/hook.go

@@ -25,54 +25,58 @@ func hookCreate(hooksPath string, isReplace bool) error {
 		hooksPath = filepath.Join(".", defaultHooksPath)
 	}
 	hooksPath = filepath.Clean(hooksPath)
-	return createHooks(hooksPath, isReplace)
+	return handleError(createHooks(hooksPath, isReplace), "Failed to create hooks")
 }
 
 func initHooks(confPath, hookFlag string, isGlobal, isReplace bool) (string, error) {
 	hookDir, err := getHookDir(hookFlag, isGlobal)
-	if err != nil {
+	if handleError(err, "Failed to get hook directory") != nil {
 		return "", err
 	}
 
 	err = writeHooks(hookDir, isReplace)
-	if err != nil {
+	if handleError(err, "Failed to write hooks") != nil {
 		return "", err
 	}
 	return hookDir, nil
 }
 
 func createHooks(hookBaseDir string, isReplace bool) error {
-	return writeHooks(hookBaseDir, isReplace)
+	return handleError(writeHooks(hookBaseDir, isReplace), "Failed to write hooks to base directory")
 }
 
 func writeHooks(hookDir string, isReplace bool) error {
 	// if commit-msg already exists skip creating or overwriting it
 	if _, err := os.Stat(hookDir); !os.IsNotExist(err) {
 		if !isReplace {
-			return errHooksExist
+			return handleError(errHooksExist, "Hook already exists and replace option not set")
 		}
 	}
 
 	err := os.MkdirAll(hookDir, os.ModePerm)
-	if err != nil {
+	if handleError(err, "Failed to create hook directory") != nil {
 		return err
 	}
 
 	// create hook file
-	return hook.WriteHooks(hookDir)
+	return handleError(hook.WriteHooks(hookDir), "Failed to write hooks to directory")
 }
 
 func getHookDir(hookFlag string, isGlobal bool) (string, error) {
 	if hookFlag != "" {
-		return filepath.Abs(hookFlag)
+		absPath, err := filepath.Abs(hookFlag)
+		if handleError(err, "Failed to get absolute path for hook directory") != nil {
+			return "", err
+		}
+		return absPath, nil
 	}
 
 	hookFlag = defaultHooksPath
 
 	if isGlobal {
 		// get user home dir
 		homeDir, err := os.UserHomeDir()
-		if err != nil {
+		if handleError(err, "Failed to get user home directory") != nil {
 			return "", err
 		}
 
@@ -82,7 +86,7 @@ func getHookDir(hookFlag string, isGlobal bool) (string, error) {
 	}
 
 	gitDir, err := getRepoRootDir()
-	if err != nil {
+	if handleError(err, "Failed to get repository root directory") != nil {
 		return "", err
 	}
 	return filepath.Join(gitDir, hookFlag), nil
@@ -96,7 +100,7 @@ func getRepoRootDir() (string, error) {
 	cmd.Stderr = os.Stderr
 
 	err := cmd.Run()
-	if err != nil {
+	if handleError(err, "Failed to get repository root directory with git command") != nil {
 		return "", err
 	}
 
@@ -109,9 +113,9 @@ func getRepoRootDir() (string, error) {
 }
 
 func isHookExists(err error) bool {
-	return err == errHooksExist
+	return errors.Is(err, errHooksExist)
 }
 
 func isConfExists(err error) bool {
-	return err == errConfigExist
+	return errors.Is(err, errConfigExist)
 }

internal/cmd/init.go

@@ -5,13 +5,13 @@ import (
 	"os/exec"
 )
 
-// initLint is the callback function for init command
+// initLint is the callback function for the init command
 func initLint(confPath, hooksPath string, isGlobal, isReplace bool) error {
 	hookDir, err := initHooks(confPath, hooksPath, isGlobal, isReplace)
-	if err != nil {
+	if handleError(err, "Failed to initialize hooks") != nil {
 		return err
 	}
-	return setGitConf(hookDir, isGlobal)
+	return handleError(setGitConf(hookDir, isGlobal), "Failed to set git configuration")
 }
 
 func setGitConf(hookDir string, isGlobal bool) error {
@@ -23,5 +23,5 @@ func setGitConf(hookDir string, isGlobal bool) error {
 
 	cmd := exec.Command("git", args...)
 	cmd.Stderr = os.Stderr
-	return cmd.Run()
+	return handleError(cmd.Run(), "Failed to execute git config command")
 }