feat: add --hookspath flag to init, hook create command

Author: muthukrishnan24

README.md

@@ -66,9 +66,17 @@ commitlint init
 commitlint init --global
 ```
 
+- to customize hooks destination pass `--hookspath` with desired location
+
+```bash
+commitlint init --hookspath /path/to/hooks
+commitlint init --global --hookspath /path/to/hooks
+```
+
 ### Manual
 
 - run `commitlint hook create` to create `.commitlint/hooks` containing git hooks
+  - pass `--hookspath` to customize the hooks output path
 - To enable in single repo
   - run `git config core.hooksPath /path/to/.commitlint/hooks`
 - To enable globally

internal/cmd/cli.go

@@ -57,6 +57,7 @@ func newLintCmd() *cli.Command {
 func newInitCmd() *cli.Command {
 	confFlag := newConfFlag()
 	replaceFlag := newReplaceFlag()
+	hooksFlag := newHooksPathFlag()
 
 	globalFlag := &cli.BoolFlag{
 		Name:    "global",
@@ -67,13 +68,14 @@ func newInitCmd() *cli.Command {
 	return &cli.Command{
 		Name:  "init",
 		Usage: "Setup commitlint for git repos",
-		Flags: []cli.Flag{globalFlag, confFlag, replaceFlag},
+		Flags: []cli.Flag{globalFlag, confFlag, replaceFlag, hooksFlag},
 		Action: func(ctx *cli.Context) error {
 			confPath := ctx.String("config")
 			isGlobal := ctx.Bool("global")
 			isReplace := ctx.Bool("replace")
+			hooksPath := ctx.String("hookspath")
 
-			err := initLint(confPath, isGlobal, isReplace)
+			err := initLint(confPath, hooksPath, isGlobal, isReplace)
 			if err != nil {
 				if isHookExists(err) {
 					fmt.Println("commitlint init failed")
@@ -158,14 +160,16 @@ func newConfigCmd() *cli.Command {
 
 func newHookCmd() *cli.Command {
 	replaceFlag := newReplaceFlag()
+	hooksFlag := newHooksPathFlag()
 
 	createCmd := &cli.Command{
 		Name:  "create",
 		Usage: "Creates git hook files in current directory",
-		Flags: []cli.Flag{replaceFlag},
+		Flags: []cli.Flag{replaceFlag, hooksFlag},
 		Action: func(ctx *cli.Context) error {
 			isReplace := ctx.Bool("replace")
-			err := hookCreate(isReplace)
+			hooksPath := ctx.String("hookspath")
+			err := hookCreate(hooksPath, isReplace)
 			if err != nil {
 				if isHookExists(err) {
 					fmt.Println("create failed. hook files already exists")
@@ -205,6 +209,14 @@ func newConfFlag() *cli.StringFlag {
 	}
 }
 
+func newHooksPathFlag() *cli.StringFlag {
+	return &cli.StringFlag{
+		Name:  "hookspath",
+		Value: "",
+		Usage: "Optional hookspath to install git hooks",
+	}
+}
+
 func newReplaceFlag() *cli.BoolFlag {
 	return &cli.BoolFlag{
 		Name:  "replace",

internal/cmd/hook.go

@@ -11,20 +11,25 @@ import (
 )
 
 const (
-	// hookBaseDir represent default hook directory
-	hookBaseDir = ".commitlint/hooks"
+	defaultHooksPath = ".commitlint/hooks"
 )
 
-var errHooksExist = errors.New("hooks already exists")
-var errConfigExist = errors.New("config file already exists")
+var (
+	errHooksExist  = errors.New("hooks already exists")
+	errConfigExist = errors.New("config file already exists")
+)
 
 // hookCreate is the callback function for create hook command
-func hookCreate(isReplace bool) error {
-	return createHooks(isReplace)
+func hookCreate(hooksPath string, isReplace bool) error {
+	if hooksPath == "" {
+		hooksPath = filepath.Join(".", defaultHooksPath)
+	}
+	hooksPath = filepath.Clean(hooksPath)
+	return createHooks(hooksPath, isReplace)
 }
 
-func initHooks(confPath string, isGlobal, isReplace bool) (string, error) {
-	hookDir, err := getHookDir(hookBaseDir, isGlobal)
+func initHooks(confPath, hookFlag string, isGlobal, isReplace bool) (string, error) {
+	hookDir, err := getHookDir(hookFlag, isGlobal)
 	if err != nil {
 		return "", err
 	}
@@ -36,7 +41,7 @@ func initHooks(confPath string, isGlobal, isReplace bool) (string, error) {
 	return hookDir, nil
 }
 
-func createHooks(isReplace bool) error {
+func createHooks(hookBaseDir string, isReplace bool) error {
 	return writeHooks(hookBaseDir, isReplace)
 }
 
@@ -57,8 +62,12 @@ func writeHooks(hookDir string, isReplace bool) error {
 	return hook.WriteHooks(hookDir)
 }
 
-func getHookDir(baseDir string, isGlobal bool) (string, error) {
-	baseDir = filepath.Clean(baseDir)
+func getHookDir(hookFlag string, isGlobal bool) (string, error) {
+	if hookFlag != "" {
+		return filepath.Abs(hookFlag)
+	}
+
+	hookFlag = defaultHooksPath
 
 	if isGlobal {
 		// get user home dir
@@ -68,15 +77,15 @@ func getHookDir(baseDir string, isGlobal bool) (string, error) {
 		}
 
 		// create hooks dir
-		hookDir := filepath.Join(homeDir, baseDir)
+		hookDir := filepath.Join(homeDir, hookFlag)
 		return hookDir, nil
 	}
 
 	gitDir, err := getRepoRootDir()
 	if err != nil {
 		return "", err
 	}
-	return filepath.Join(gitDir, baseDir), nil
+	return filepath.Join(gitDir, hookFlag), nil
 }
 
 func getRepoRootDir() (string, error) {

internal/cmd/init.go

@@ -6,16 +6,16 @@ import (
 )
 
 // initLint is the callback function for init command
-func initLint(confPath string, isGlobal, isReplace bool) error {
-	hookDir, err := initHooks(confPath, isGlobal, isReplace)
+func initLint(confPath, hooksPath string, isGlobal, isReplace bool) error {
+	hookDir, err := initHooks(confPath, hooksPath, isGlobal, isReplace)
 	if err != nil {
 		return err
 	}
 	return setGitConf(hookDir, isGlobal)
 }
 
 func setGitConf(hookDir string, isGlobal bool) error {
-	var args = []string{"config"}
+	args := []string{"config"}
 	if isGlobal {
 		args = append(args, "--global")
 	}