feat: allow overriding config path using LEFTHOOK_CONFIG env (#1072)

Author: TECHNOFAB11

internal/config/load.go

@@ -57,20 +57,36 @@ func (err ConfigNotFoundError) Error() string {
 	return err.message
 }
 
+func loadConfig(k *koanf.Koanf, filesystem afero.Fs, config string) error {
+	extension := filepath.Ext(config)
+	log.Debug("loading config: ", config)
+	if err := k.Load(kfs.Provider(newIOFS(filesystem), config), parsers[extension], mergeJobsOption); err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func loadOne(k *koanf.Koanf, filesystem afero.Fs, root string, names []string) error {
+	configPathOverride := os.Getenv("LEFTHOOK_CONFIG")
+	if configPathOverride != "" {
+		if !filepath.IsAbs(configPathOverride) {
+			configPathOverride = filepath.Join(root, configPathOverride)
+		}
+		if ok, _ := afero.Exists(filesystem, configPathOverride); !ok {
+			return ConfigNotFoundError{fmt.Sprintf("Config file \"%s\" not found!", configPathOverride)}
+		}
+		return loadConfig(k, filesystem, configPathOverride)
+	}
+
 	for _, extension := range extensions {
 		for _, name := range names {
 			config := filepath.Join(root, name+extension)
 			if ok, _ := afero.Exists(filesystem, config); !ok {
 				continue
 			}
 
-			log.Debug("loading config: ", config)
-			if err := k.Load(kfs.Provider(newIOFS(filesystem), config), parsers[extension], mergeJobsOption); err != nil {
-				return err
-			}
-
-			return nil
+			return loadConfig(k, filesystem, config)
 		}
 	}
 

internal/config/load_test.go

@@ -21,6 +21,7 @@ func TestLoad(t *testing.T) {
 		files            map[string]string
 		remote           string
 		remoteConfigPath string
+		pathOverride     string
 		result           *Config
 	}{
 		"with .lefthook.yml": {
@@ -841,7 +842,7 @@ pre-commit:
 				},
 			},
 		},
-		"with .cofig/lefthook.yml": {
+		"with .config/lefthook.yml": {
 			files: map[string]string{
 				filepath.Join(".config", "lefthook.yml"): `
 pre-commit:
@@ -933,6 +934,32 @@ pre-commit:
 				},
 			},
 		},
+		"custom config path": {
+			files: map[string]string{
+				"lefthook_custom.yml": `
+pre-commit:
+  commands:
+    tests:
+      run: yarn test
+`,
+			},
+			pathOverride: "lefthook_custom.yml",
+			result: &Config{
+				SourceDir:      DefaultSourceDir,
+				SourceDirLocal: DefaultSourceDirLocal,
+				Colors:         nil,
+				Hooks: map[string]*Hook{
+					"pre-commit": {
+						Parallel: false,
+						Commands: map[string]*Command{
+							"tests": {
+								Run: "yarn test",
+							},
+						},
+					},
+				},
+			},
+		},
 	} {
 		fs := afero.Afero{Fs: afero.NewMemMapFs()}
 		repo := &git.Repository{
@@ -960,6 +987,8 @@ pre-commit:
 				assert.NoError(fs.WriteFile(tt.remoteConfigPath, []byte(tt.remote), 0o644))
 			}
 
+			t.Setenv("LEFTHOOK_CONFIG", tt.pathOverride)
+
 			result, err := Load(fs.Fs, repo)
 			assert.NoError(err)
 			assert.Equal(tt.result, result)