refactor: move utils to separate file

* rename writeHookFile to WriteHookToFile
* move WriteConfToFile to file.go
* move WriteHookToFile to file.go
* move IsFileExists to util.go

Author: muthukrishnan24

cmd/commitlint/main.go

@@ -55,7 +55,7 @@ func initHookCallback(ctx *cli.Context) (retErr error) {
 
 	// create hook file
 	hookFile := filepath.Join(hookDir, commitMsgHook)
-	err = writeHookFile(hookFile)
+	err = commitlint.WriteHookToFile(hookFile)
 	if err != nil {
 		return err
 	}
@@ -104,28 +104,6 @@ func setGitConf(hookDir string, isGlobal bool) error {
 	return cmd.Run()
 }
 
-func writeHookFile(hookFilePath string) (retErr error) {
-	// if commit-msg already exists skip creating or overwriting it
-	if isFileExists(hookFilePath) {
-		return nil
-	}
-	// commit-msg needs to be executable
-	file, err := os.OpenFile(hookFilePath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0700)
-	if err != nil {
-		return err
-	}
-	defer func() {
-		err1 := file.Close()
-		if retErr == nil && err1 != nil {
-			retErr = err1
-		}
-	}()
-
-	commitHook := commitlint.CommitMsgHook()
-	_, err = file.WriteString(commitHook)
-	return err
-}
-
 func getLinter(confFilePath string) (*commitlint.Linter, error) {
 	// Config Precedence
 	// 	1. Check for conf in current directory
@@ -139,7 +117,7 @@ func getLinter(confFilePath string) (*commitlint.Linter, error) {
 
 	// check if conf file exists in current directory
 	currentDirConf := filepath.Join(currentDir, defConfFileName)
-	if isFileExists(currentDirConf) {
+	if commitlint.IsFileExists(currentDirConf) {
 		confFilePath = currentDirConf
 	}
 
@@ -189,8 +167,3 @@ func readStdIn() string {
 	s := string(readBytes)
 	return strings.TrimSpace(s)
 }
-
-func isFileExists(filename string) bool {
-	_, err := os.Stat(filename)
-	return !os.IsNotExist(err)
-}

default.go

@@ -1,12 +1,5 @@
 package commitlint
 
-import (
-	"bufio"
-	"os"
-
-	"gopkg.in/yaml.v3"
-)
-
 var defConf = &Config{
 	Header: Header{
 		MinLength: IntConf{Enabled: true, Type: ErrorType, Value: 10},
@@ -54,28 +47,3 @@ func NewDefaultLinter() *Linter {
 func DefaultConfToFile(confPath string) error {
 	return WriteConfToFile(confPath, defConf)
 }
-
-// WriteConfToFile util func to write config object to given file
-func WriteConfToFile(confPath string, conf *Config) (retErr error) {
-	file, err := os.Create(confPath)
-	if err != nil {
-		return err
-	}
-	defer func() {
-		err1 := file.Close()
-		if retErr == nil && err1 != nil {
-			retErr = err1
-		}
-	}()
-
-	w := bufio.NewWriter(file)
-	defer func() {
-		err1 := w.Flush()
-		if retErr == nil && err1 != nil {
-			retErr = err1
-		}
-	}()
-
-	enc := yaml.NewEncoder(w)
-	return enc.Encode(conf)
-}

file.go

@@ -0,0 +1,56 @@
+package commitlint
+
+import (
+	"bufio"
+	"os"
+
+	"gopkg.in/yaml.v3"
+)
+
+// WriteConfToFile util func to write config object to given file
+func WriteConfToFile(confPath string, conf *Config) (retErr error) {
+	file, err := os.Create(confPath)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		err1 := file.Close()
+		if retErr == nil && err1 != nil {
+			retErr = err1
+		}
+	}()
+
+	w := bufio.NewWriter(file)
+	defer func() {
+		err1 := w.Flush()
+		if retErr == nil && err1 != nil {
+			retErr = err1
+		}
+	}()
+
+	enc := yaml.NewEncoder(w)
+	return enc.Encode(conf)
+}
+
+// WriteHookToFile util func to write commit-msg hook to given file
+func WriteHookToFile(hookFilePath string) (retErr error) {
+	// if commit-msg already exists skip creating or overwriting it
+	if IsFileExists(hookFilePath) {
+		return nil
+	}
+	// commit-msg needs to be executable
+	file, err := os.OpenFile(hookFilePath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0700)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		err1 := file.Close()
+		if retErr == nil && err1 != nil {
+			retErr = err1
+		}
+	}()
+
+	commitHook := CommitMsgHook()
+	_, err = file.WriteString(commitHook)
+	return err
+}

util.go

@@ -0,0 +1,9 @@
+package commitlint
+
+import "os"
+
+// IsFileExists checks if given file exists
+func IsFileExists(fileName string) bool {
+	_, err := os.Stat(fileName)
+	return !os.IsNotExist(err)
+}