refactor: rename version to min-version to avoid confusions

muthukrishnan24 · muthukrishnan24 · commit 01ce1606f79c · 2026-02-21T18:29:42.000+05:30
diff --git a/README.md b/README.md
@@ -147,7 +147,7 @@ To lint a message, you can use any one of the following
 ## Default Config
 
 ```yaml
-version: v0.9.0
+min-version: v0.9.0
 formatter: default
 rules:
 - header-min-length
diff --git a/config/config.go b/config/config.go
@@ -26,8 +26,7 @@ func Parse(confPath string) (*lint.Config, error) {
 	}
 
 	conf := &lint.Config{
-		MinVersion: internal.Version(),
-		Formatter:  (&formatter.DefaultFormatter{}).Name(),
+		Formatter: (&formatter.DefaultFormatter{}).Name(),
 		Severity: lint.SeverityConfig{
 			Default: lint.SeverityError,
 		},
@@ -38,6 +37,17 @@ func Parse(confPath string) (*lint.Config, error) {
 		return nil, fmt.Errorf("config file error: %w", err)
 	}
 
+	// Backward compatibility: accept old "version" key
+	if conf.MinVersion == "" && conf.DeprecatedVersion != "" {
+		conf.MinVersion = conf.DeprecatedVersion
+	}
+	conf.DeprecatedVersion = ""
+
+	// Default to current version if neither key was provided
+	if conf.MinVersion == "" {
+		conf.MinVersion = internal.Version()
+	}
+
 	if conf.Formatter == "" {
 		return nil, errors.New("config error: formatter is empty")
 	}
diff --git a/lint/config.go b/lint/config.go
@@ -16,7 +16,11 @@ type SeverityConfig struct {
 type Config struct {
 	// MinVersion is the minimum version of commitlint required
 	// should be in semver format
-	MinVersion string `yaml:"version"`
+	MinVersion string `yaml:"min-version"`
+
+	// DeprecatedVersion is the old "version" key, kept for backward compatibility.
+	// Use MinVersion ("min-version") in new config files.
+	DeprecatedVersion string `yaml:"version,omitempty"`
 
 	// Formatter of the lint result
 	Formatter string `yaml:"formatter"`
