feat: write only enabled to config by default

muthukrishnan24 · muthukrishnan24 · commit f219063560fd · 2026-02-21T20:03:02.000+05:30
diff --git a/config/config.go b/config/config.go
@@ -159,7 +159,8 @@ func LookupAndParse() (*lint.Config, error) {
 	return conf, nil
 }
 
-// WriteTo writes config in yaml format to given io.Writer
+// WriteTo writes config in yaml format to given io.Writer, including all
+// settings and every field even if empty or zero-valued.
 func WriteTo(w io.Writer, conf *lint.Config) (retErr error) {
 	enc := yaml.NewEncoder(w)
 	defer func() {
@@ -171,6 +172,30 @@ func WriteTo(w io.Writer, conf *lint.Config) (retErr error) {
 	return enc.Encode(conf)
 }
 
+// WriteCompactTo writes config in yaml format to given io.Writer.
+// Only settings for enabled rules are written, keeping the output compact.
+func WriteCompactTo(w io.Writer, conf *lint.Config) error {
+	// Build a compact copy: only settings for enabled rules
+	compact := *conf
+	if len(compact.Rules) > 0 && len(compact.Settings) > 0 {
+		enabled := make(map[string]struct{}, len(compact.Rules))
+		for _, r := range compact.Rules {
+			enabled[r] = struct{}{}
+		}
+		filtered := make(map[string]lint.RuleSetting, len(compact.Rules))
+		for name, setting := range compact.Settings {
+			if _, ok := enabled[name]; ok {
+				filtered[name] = setting
+			}
+		}
+		compact.Settings = filtered
+	}
+
+	enc := yaml.NewEncoder(w)
+	defer enc.Close()
+	return enc.Encode(&compact)
+}
+
 func isValidVersion(versionNo string) error {
 	if versionNo == "" {
 		return errors.New("version is empty")
diff --git a/internal/cmd/cmd.go b/internal/cmd/cmd.go
@@ -121,11 +121,16 @@ func newConfigCmd() *cli.Command {
 				Usage: "Output file name",
 				Value: ".commitlint.yaml",
 			},
+			&cli.BoolFlag{
+				Name:  "all",
+				Usage: "Write all settings (not just enabled rules)",
+			},
 		},
 		Action: func(ctx *cli.Context) error {
 			isReplace := ctx.Bool("replace")
 			fileName := ctx.String("file")
-			err := configCreate(fileName, isReplace)
+			all := ctx.Bool("all")
+			err := configCreate(fileName, isReplace, all)
 			if err != nil {
 				if isConfExists(err) {
 					fmt.Println("config file already exists")
diff --git a/internal/cmd/config.go b/internal/cmd/config.go
@@ -9,7 +9,7 @@ import (
 )
 
 // configCreate is the callback function for create config command
-func configCreate(fileName string, isReplace bool) (retErr error) {
+func configCreate(fileName string, isReplace bool, all bool) (retErr error) {
 	outPath := filepath.Join(".", fileName)
 	// if config file already exists skip creating or overwriting it
 	if _, err := os.Stat(outPath); !os.IsNotExist(err) {
@@ -39,7 +39,10 @@ func configCreate(fileName string, isReplace bool) (retErr error) {
 	}()
 
 	defConf := config.NewDefault()
-	return config.WriteTo(w, defConf)
+	if all {
+		return config.WriteTo(w, defConf)
+	}
+	return config.WriteCompactTo(w, defConf)
 }
 
 // configCheck is the callback function for check/verify command
diff --git a/lint/config.go b/lint/config.go
@@ -3,13 +3,13 @@ package lint
 // RuleSetting represent config for a rule
 type RuleSetting struct {
 	Argument interface{}            `yaml:"argument"`
-	Flags    map[string]interface{} `yaml:"flags,omitempty"`
+	Flags    map[string]interface{} `yaml:"flags"`
 }
 
 // SeverityConfig represent severity levels for rules
 type SeverityConfig struct {
 	Default Severity            `yaml:"default"`
-	Rules   map[string]Severity `yaml:"rules,omitempty"`
+	Rules   map[string]Severity `yaml:"rules"`
 }
 
 // Config represent linter config
@@ -36,13 +36,13 @@ type Config struct {
 
 	// DisableDefaultIgnores disables the built-in ignore patterns
 	// (merge, revert, fixup, squash, etc.) when set to true.
-	DisableDefaultIgnores bool `yaml:"disable-default-ignores,omitempty"`
+	DisableDefaultIgnores bool `yaml:"disable-default-ignores"`
 
 	// IgnorePatterns is a list of user-defined regex patterns.
 	// If the first line of the commit message matches any pattern,
 	// linting is skipped. These are added on top of the default
 	// patterns (unless DisableDefaultIgnores is true).
-	IgnorePatterns []string `yaml:"ignores,omitempty"`
+	IgnorePatterns []string `yaml:"ignores"`
 
 	// DefaultIgnorePatterns holds the built-in patterns (set by config package).
 	// Not serialized to YAML - users never set this directly.
