feat(optiosn): add debug options

Author: shipengqi

cmd/cz/cz.go

@@ -25,13 +25,16 @@ func New() *cobra.Command {
 		Use:  "commitizen",
 		Long: `Command line utility to standardize git commit messages.`,
 		PreRun: func(cmd *cobra.Command, args []string) {
+			if !o.Debug {
+				return
+			}
 			opts := &log.Options{
 				DisableRotate:        true,
 				DisableFileCaller:    true,
 				DisableConsoleCaller: true,
 				DisableConsoleLevel:  true,
 				DisableConsoleTime:   true,
-				Output:               fmt.Sprintf("%s/commitizen/logs", os.TempDir()),
+				Output:               filepath.Join(os.TempDir(), "commitizen/logs"),
 				FileLevel:            log.DebugLevel.String(),
 				FilenameEncoder:      filenameEncoder,
 			}

internal/options/options.go

@@ -1,14 +1,18 @@
 package options
 
 import (
-	cliflag "github.com/shipengqi/component-base/cli/flag"
+	"fmt"
+	"os"
+	"path/filepath"
 
 	"github.com/shipengqi/commitizen/internal/git"
+	cliflag "github.com/shipengqi/component-base/cli/flag"
 )
 
 type Options struct {
 	DryRun     bool
 	Default    bool
+	Debug      bool
 	Template   string
 	GitOptions *git.Options
 }
@@ -21,12 +25,16 @@ func New() *Options {
 }
 
 func (o *Options) Flags() (fss cliflag.NamedFlagSets) {
+	dir := filepath.Join(os.TempDir(), "commitizen/logs")
+
 	o.GitOptions.AddFlags(fss.FlagSet("Git Commit"))
 
 	fs := fss.FlagSet("Commitizen")
 	fs.BoolVar(&o.DryRun, "dry-run", o.DryRun, "do not create a commit, but show the message and list of paths \nthat are to be committed.")
 	fs.StringVarP(&o.Template, "template", "t", o.Template, "template name to use when multiple templates exist.")
 	fs.BoolVarP(&o.Default, "default", "d", o.Default, "use the default template, '--default' has a higher priority than '--template'.")
+	fs.BoolVar(&o.Debug, "debug", o.Debug, fmt.Sprintf("enable debug mode, writing log file to the %s directory.", dir))
 
+	_ = fs.MarkHidden("debug")
 	return
 }

internal/parameter/group.go

@@ -2,6 +2,7 @@ package parameter
 
 import (
 	standarderrs "errors"
+
 	"github.com/charmbracelet/huh"
 	"github.com/shipengqi/golib/strutil"
 	"github.com/shipengqi/log"
@@ -114,12 +115,14 @@ func (c *Condition) Validate() []error {
 }
 
 func (c *Condition) Match() bool {
-	field, ok := c.fields[GetFiledKey(c.ParameterName)]
+	key := GetFiledKey(c.ParameterName)
+	log.Debugf("math field condition: %s", key)
+	field, ok := c.fields[key]
 	if !ok {
+		log.Debugf("cannot find field condition: %s", key)
 		return false
 	}
 	val := field.GetValue()
-
 	if c.ValueEmpty != nil {
 		return c.IsEmpty(*c.ValueEmpty, val)
 	}
@@ -133,32 +136,39 @@ func (c *Condition) Match() bool {
 		return c.Contains(val)
 	}
 	if c.ValueNotContains != nil {
+		log.Debugf("value not contains val: %v", val)
 		return c.NotContains(val)
 	}
 	return false
 }
 
 func (c *Condition) Equal(val interface{}) bool {
+	log.Debugf("%v contains match val: %v", c.ValueEquals, val)
 	return helpers.Equal(c.ValueEquals, val)
 }
 
 func (c *Condition) NotEqual(val interface{}) bool {
+	log.Debugf("%v not equals val: %v", c.ValueNotEquals, val)
 	return helpers.NotEqual(c.ValueNotEquals, val)
 }
 
 func (c *Condition) Contains(val interface{}) bool {
+	log.Debugf("%v contains val: %v", val, c.ValueContains)
 	return helpers.Contains(val, c.ValueContains)
 }
 
 func (c *Condition) NotContains(val interface{}) bool {
+	log.Debugf("%v not contains val: %v", val, c.ValueContains)
 	return helpers.NotContains(val, c.ValueNotContains)
 }
 
 func (c *Condition) IsEmpty(empty bool, val interface{}) bool {
 	if empty && helpers.Empty(val) {
+		log.Debugf("value is empty: %v", val)
 		return true
 	}
 	if !empty && helpers.NotEmpty(val) {
+		log.Debugf("value is not empty: %v", val)
 		return true
 	}
 	return false