feat: custom config in hook, replace hook

Author: muthukrishnan24

cmd/callback.go

@@ -2,36 +2,20 @@ package cmd
 
 import (
 	"fmt"
-	"os"
 
 	"github.com/urfave/cli/v2"
 
 	"github.com/conventionalcommit/commitlint/config"
-	"github.com/conventionalcommit/commitlint/hook"
 )
 
 const (
 	// ErrExitCode represent error exit code
 	ErrExitCode = 1
-
-	// HookDir represent default hook directory
-	HookDir = ".commitlint/hooks"
 )
 
 // Init is the callback function for init command
-func Init(isGlobal bool) error {
-	hookDir, err := getHookDir(isGlobal)
-	if err != nil {
-		return err
-	}
-
-	err = os.MkdirAll(hookDir, os.ModePerm)
-	if err != nil {
-		return err
-	}
-
-	// create hook file
-	err = hook.WriteToFile(hookDir)
+func Init(confPath string, isGlobal, isReplace bool) error {
+	hookDir, err := initHooks(confPath, isGlobal, isReplace)
 	if err != nil {
 		return err
 	}
@@ -63,8 +47,8 @@ func Lint(confPath, msgPath string) error {
 }
 
 // CreateHook is the callback function for create hook command
-func CreateHook() (retErr error) {
-	return hook.WriteToFile(".")
+func CreateHook(confPath string, isReplace bool) error {
+	return createHooks(confPath, isReplace)
 }
 
 // CreateConfig is the callback function for create config command

cmd/cmd.go

@@ -2,6 +2,8 @@
 package cmd
 
 import (
+	"fmt"
+
 	"github.com/urfave/cli/v2"
 )
 
@@ -40,10 +42,29 @@ func initCmd() *cli.Command {
 				Aliases: []string{"g"},
 				Usage:   "sets git hook in global config",
 			},
+			&cli.StringFlag{
+				Name:    "config",
+				Aliases: []string{"c", "conf"},
+				Value:   "",
+				Usage:   "optional config file `conf.yaml`",
+			},
+			&cli.BoolFlag{
+				Name:  "replace",
+				Usage: "replace files if already exists",
+			},
 		},
 		Action: func(ctx *cli.Context) error {
+			confPath := ctx.String("config")
 			isGlobal := ctx.Bool("global")
-			return Init(isGlobal)
+			isReplace := ctx.Bool("replace")
+
+			err := Init(confPath, isGlobal, isReplace)
+			if isHookExists(err) {
+				fmt.Println("commitlint init failed")
+				fmt.Println("run with --replace to replace existing files")
+				return nil
+			}
+			return err
 		},
 	}
 }
@@ -69,8 +90,32 @@ func createCmd() *cli.Command {
 	hookCmd := &cli.Command{
 		Name:  "hook",
 		Usage: "creates commit-msg file in current directory",
+		Flags: []cli.Flag{
+			&cli.StringFlag{
+				Name:    "config",
+				Aliases: []string{"c", "conf"},
+				Value:   "",
+				Usage:   "optional config file `conf.yaml`",
+			},
+			&cli.BoolFlag{
+				Name:  "replace",
+				Usage: "replace hook files if already exists",
+			},
+		},
 		Action: func(ctx *cli.Context) error {
-			return CreateHook()
+			confPath := ctx.String("config")
+			isReplace := ctx.Bool("replace")
+			err := CreateHook(confPath, isReplace)
+			if err != nil {
+				if isHookExists(err) {
+					fmt.Println("create hook failed. files already exists")
+					fmt.Println("run with --replace to replace existing hook files")
+					return nil
+				}
+				return err
+			}
+			fmt.Println("hooks created")
+			return nil
 		},
 	}
 

cmd/hook.go

@@ -0,0 +1,76 @@
+package cmd
+
+import (
+	"errors"
+	"os"
+	"path/filepath"
+
+	"github.com/conventionalcommit/commitlint/hook"
+)
+
+const (
+	// hookBaseDir represent default hook directory
+	hookBaseDir = ".commitlint/hooks"
+)
+
+var errHooksExist = errors.New("hooks already exists")
+
+func initHooks(confPath string, isGlobal, isReplace bool) (string, error) {
+	hookDir, err := getHookDir(hookBaseDir, isGlobal)
+	if err != nil {
+		return "", err
+	}
+
+	err = writeHooks(hookDir, confPath, isReplace)
+	if err != nil {
+		return "", err
+	}
+	return hookDir, nil
+}
+
+func createHooks(confPath string, isReplace bool) error {
+	return writeHooks(hookBaseDir, confPath, isReplace)
+}
+
+func writeHooks(hookDir, confPath string, isReplace bool) error {
+	err := os.MkdirAll(hookDir, os.ModePerm)
+	if err != nil {
+		return err
+	}
+
+	// if commit-msg already exists skip creating or overwriting it
+	if _, err := os.Stat(hookDir); !os.IsNotExist(err) {
+		if !isReplace {
+			return errHooksExist
+		}
+	}
+
+	// create hook file
+	return hook.WriteHooks(hookDir, confPath)
+}
+
+func getHookDir(baseDir string, isGlobal bool) (string, error) {
+	baseDir = filepath.Clean(baseDir)
+
+	if isGlobal {
+		// get user home dir
+		homeDir, err := os.UserHomeDir()
+		if err != nil {
+			return "", err
+		}
+
+		// create hooks dir
+		hookDir := filepath.Join(homeDir, baseDir)
+		return hookDir, nil
+	}
+
+	gitDir, err := getRepoRootDir()
+	if err != nil {
+		return "", err
+	}
+	return filepath.Join(gitDir, baseDir), nil
+}
+
+func isHookExists(err error) bool {
+	return err == errHooksExist
+}

cmd/util.go

@@ -44,28 +44,6 @@ func readStdInPipe() (string, error) {
 	return strings.TrimSpace(s), nil
 }
 
-func getHookDir(isGlobal bool) (string, error) {
-	baseDir := filepath.Clean(HookDir)
-
-	if isGlobal {
-		// get user home dir
-		homeDir, err := os.UserHomeDir()
-		if err != nil {
-			return "", err
-		}
-
-		// create hooks dir
-		hookDir := filepath.Join(homeDir, baseDir)
-		return hookDir, nil
-	}
-
-	gitDir, err := getRepoRootDir()
-	if err != nil {
-		return "", err
-	}
-	return filepath.Join(gitDir, baseDir), nil
-}
-
 func getRepoRootDir() (string, error) {
 	byteOut := &bytes.Buffer{}
 

hook/hook.go

@@ -2,25 +2,18 @@
 package hook
 
 import (
+	"bufio"
+	"io"
 	"os"
 	"path/filepath"
+	"strings"
 )
 
-// CommitMsgHook represent commit-msg hook file name
-const CommitMsgHook = "commit-msg"
+// commitMsgHook represent commit-msg hook file name
+const commitMsgHook = "commit-msg"
 
-const hookFile = `#!/bin/sh
-
-commitlint lint --message $1
-`
-
-// WriteToFile util func to write commit-msg hook to given file
-func WriteToFile(hookDir string) (retErr error) {
-	hookFilePath := filepath.Join(hookDir, filepath.Clean(CommitMsgHook))
-	// if commit-msg already exists skip creating or overwriting it
-	if _, err := os.Stat(hookFilePath); !os.IsNotExist(err) {
-		return nil
-	}
+func WriteHooks(outDir string, confPath string) (retErr error) {
+	hookFilePath := filepath.Join(outDir, commitMsgHook)
 	// commit-msg needs to be executable
 	file, err := os.OpenFile(hookFilePath, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0700)
 	if err != nil {
@@ -32,7 +25,24 @@ func WriteToFile(hookDir string) (retErr error) {
 			retErr = err1
 		}
 	}()
+	return writeTo(file, confPath)
+}
+
+// writeTo util func to write commit-msg hook to given io.Writer
+func writeTo(wr io.Writer, confPath string) error {
+	w := bufio.NewWriter(wr)
+
+	w.WriteString("#!/bin/sh")
+	w.WriteString("\n\ncommitlint lint")
+
+	confPath = strings.TrimSpace(confPath)
+	if confPath != "" {
+		confPath = filepath.Clean(confPath)
+		w.WriteString(` --config "` + confPath + `"`)
+	}
+
+	w.WriteString(" --message $1")
+	w.WriteString("\n")
 
-	_, err = file.WriteString(hookFile)
-	return err
+	return w.Flush()
 }