Merge pull request #63 from shipengqi/feat/dependson

shipengqi · web-flow · commit d3914f00606c · 2024-04-27T15:36:01.000+08:00
fix(list): remove unused list options
diff --git a/internal/errors/missing.go b/internal/errors/missing.go
@@ -0,0 +1,23 @@
+package errors
+
+import "fmt"
+
+type MissingErr struct {
+	name  string
+	field string
+}
+
+func (e MissingErr) Error() string {
+	if e.name == "" {
+		return fmt.Sprintf("missing required field `%s`", e.field)
+	}
+	return fmt.Sprintf("'%s' missing required field: %s", e.name, e.field)
+}
+
+func NewMissingErr(field string, name ...string) error {
+	err := MissingErr{field: field}
+	if len(name) > 0 {
+		err.name = name[0]
+	}
+	return err
+}
diff --git a/internal/parameter/integer/int.go b/internal/parameter/integer/int.go
@@ -26,7 +26,7 @@ func (p Param) Render() huh.Field {
 
 	param.Value(&p.DefaultValue)
 
-	var group []validators.Validator
+	var group []validators.Validator[string]
 	if p.Required {
 		group = append(group, validators.Required(p.Name, true))
 	}
diff --git a/internal/parameter/list/list.go b/internal/parameter/list/list.go
@@ -19,7 +19,7 @@ type Param struct {
 func (p Param) Validate() []error {
 	errs := p.Parameter.Validate()
 	if len(p.Options) < 1 {
-		errs = append(errs, errors.NewRequiredErr("parameter.options"))
+		errs = append(errs, errors.NewMissingErr("options", p.Name))
 	}
 	return errs
 }
@@ -34,7 +34,7 @@ func (p Param) Render() huh.Field {
 
 	param.Value(&p.DefaultValue)
 
-	var group []validators.Validator
+	var group []validators.Validator[string]
 	if p.Required {
 		group = append(group, validators.Required(p.Name, false))
 	}
diff --git a/internal/parameter/multilist/list.go b/internal/parameter/multilist/list.go
@@ -14,12 +14,13 @@ type Param struct {
 	Options      []huh.Option[string] `yaml:"options"       json:"options"       mapstructure:"options"`
 	DefaultValue []string             `yaml:"default_value" json:"default_value" mapstructure:"default_value"`
 	Required     bool                 `yaml:"required"      json:"required"      mapstructure:"required"`
+	Limit        *int                 `yaml:"limit"         json:"limit"         mapstructure:"limit"`
 }
 
 func (p Param) Validate() []error {
 	errs := p.Parameter.Validate()
 	if len(p.Options) < 1 {
-		errs = append(errs, errors.NewRequiredErr("parameter.options"))
+		errs = append(errs, errors.NewMissingErr("options", p.Name))
 	}
 	return errs
 }
@@ -32,10 +33,18 @@ func (p Param) Render() huh.Field {
 		param.Description(p.Description)
 	}
 
+	if p.Limit != nil {
+		param.Limit(*p.Limit)
+	}
 	param.Value(&p.DefaultValue)
 
+	var group []validators.Validator[[]string]
+	if p.Required {
+		group = append(group, validators.MultiRequired(p.Name))
+	}
+
 	if p.Required {
-		param.Validate(validators.MultiRequired(p.Name))
+		param.Validate(validators.Group(group...))
 	}
 
 	return param
diff --git a/internal/parameter/param.go b/internal/parameter/param.go
@@ -33,13 +33,13 @@ func (p Parameter) Render() huh.Field {
 func (p Parameter) Validate() []error {
 	var errs []error
 	if strutil.IsEmpty(p.Name) {
-		errs = append(errs, errors.NewRequiredErr("parameter.name"))
+		errs = append(errs, errors.NewMissingErr("parameter.name"))
 	}
 	if strutil.IsEmpty(p.Label) {
-		errs = append(errs, errors.NewRequiredErr("parameter.label"))
+		errs = append(errs, errors.NewMissingErr("label", p.Name))
 	}
 	if strutil.IsEmpty(p.Type) {
-		errs = append(errs, errors.NewRequiredErr("parameter.type"))
+		errs = append(errs, errors.NewMissingErr("type", p.Name))
 	}
 	return errs
 }
diff --git a/internal/parameter/str/str.go b/internal/parameter/str/str.go
@@ -35,7 +35,7 @@ func (p Param) RenderInput() *huh.Input {
 
 	param.Value(&p.DefaultValue)
 
-	var group []validators.Validator
+	var group []validators.Validator[string]
 	if p.Required {
 		group = append(group, validators.Required(p.Name, p.Trim))
 	}
diff --git a/internal/parameter/text/text.go b/internal/parameter/text/text.go
@@ -16,19 +16,24 @@ type Param struct {
 	RegexMessage string `yaml:"regex_message" json:"regex_message" mapstructure:"regex_message"`
 	MinLength    *int   `yaml:"min_length"    json:"min_length"    mapstructure:"min_length"`
 	MaxLength    *int   `yaml:"max_length"    json:"max_length"    mapstructure:"max_length"`
+	Height       *int   `yaml:"height"        json:"height"        mapstructure:"height"`
 }
 
 func (p Param) Render() huh.Field {
 	param := huh.NewText().Key(p.Name).
 		Title(p.Label)
 
+	if p.Height != nil {
+		param.Lines(*p.Height)
+	}
+
 	if len(p.Description) > 0 {
 		param.Description(p.Description)
 	}
 
 	param.Value(&p.DefaultValue)
 
-	var group []validators.Validator
+	var group []validators.Validator[string]
 	if p.Required {
 		group = append(group, validators.Required(p.Name, false))
 	}
diff --git a/internal/parameter/validators/required.go b/internal/parameter/validators/required.go
@@ -3,8 +3,6 @@ package validators
 import (
 	"fmt"
 	"strings"
-
-	"github.com/shipengqi/commitizen/internal/errors"
 )
 
 func Required(name string, trim bool) func(string) error {
@@ -18,12 +16,3 @@ func Required(name string, trim bool) func(string) error {
 		return nil
 	}
 }
-
-func MultiRequired(name string) func([]string) error {
-	return func(strs []string) error {
-		if len(strs) == 0 {
-			return errors.NewRequiredErr(name)
-		}
-		return nil
-	}
-}
diff --git a/internal/parameter/validators/slice.go b/internal/parameter/validators/slice.go
@@ -0,0 +1,12 @@
+package validators
+
+import "github.com/shipengqi/commitizen/internal/errors"
+
+func MultiRequired(name string) func([]string) error {
+	return func(vals []string) error {
+		if len(vals) == 0 {
+			return errors.NewRequiredErr(name)
+		}
+		return nil
+	}
+}
diff --git a/internal/parameter/validators/validators.go b/internal/parameter/validators/validators.go
@@ -1,11 +1,11 @@
 package validators
 
-type Validator func(string) error
+type Validator[T string | []string] func(T) error
 
-func Group(validators ...Validator) Validator {
-	return func(str string) error {
+func Group[T string | []string](validators ...Validator[T]) Validator[T] {
+	return func(t T) error {
 		for _, validator := range validators {
-			if err := validator(str); err != nil {
+			if err := validator(t); err != nil {
 				return err
 			}
 		}
diff --git a/internal/templates/template.go b/internal/templates/template.go
@@ -2,8 +2,8 @@ package templates
 
 import (
 	"bytes"
+	standarderrs "errors"
 	"fmt"
-	"strings"
 	"text/template"
 
 	"github.com/charmbracelet/huh"
@@ -23,23 +23,6 @@ import (
 
 const UnknownGroup = "unknown"
 
-type Option struct {
-	Name string
-	Desc string
-}
-
-func (o *Option) String() string {
-	var b strings.Builder
-	ml := len(o.Name)
-	pl := 12 - ml - 2
-	padding := strings.Repeat(" ", pl)
-	b.WriteString(o.Name)
-	b.WriteString(": ")
-	b.WriteString(padding)
-	b.WriteString(o.Desc)
-	return b.String()
-}
-
 type Template struct {
 	Name    string
 	Desc    string
@@ -52,7 +35,7 @@ type Template struct {
 
 func (t *Template) Initialize() error {
 	if strutil.IsEmpty(t.Format) {
-		return errors.NewRequiredErr("format")
+		return errors.NewMissingErr("format")
 	}
 
 	groups := NewSortedGroupMap()
@@ -105,6 +88,10 @@ func (t *Template) Initialize() error {
 		if err != nil {
 			return err
 		}
+		errs := param.Validate()
+		if len(errs) > 0 {
+			return standarderrs.Join(errs...)
+		}
 		group = param.GetGroup()
 		field = param.Render()
 		t.fields = append(t.fields, field)
@@ -165,7 +152,7 @@ func GetValueFromYAML[T any](data map[string]interface{}, key string) (T, error)
 
 	v, ok = data[key]
 	if !ok {
-		return res, errors.NewRequiredErr(key)
+		return res, errors.NewMissingErr(key)
 	}
 	res, ok = v.(T)
 	if !ok {

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ func (p Param) Render() huh.Field {`
`26`	`26`
`27`	`27`	`param.Value(&p.DefaultValue)`
`28`	`28`
`29`		`- var group []validators.Validator`
	`29`	`+ var group []validators.Validator[string]`
`30`	`30`	`if p.Required {`
`31`	`31`	`group = append(group, validators.Required(p.Name, true))`
`32`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ type Param struct {`
`19`	`19`	`func (p Param) Validate() []error {`
`20`	`20`	`errs := p.Parameter.Validate()`
`21`	`21`	`if len(p.Options) < 1 {`
`22`		`- errs = append(errs, errors.NewRequiredErr("parameter.options"))`
	`22`	`+ errs = append(errs, errors.NewMissingErr("options", p.Name))`
`23`	`23`	`}`
`24`	`24`	`return errs`
`25`	`25`	`}`
`@@ -34,7 +34,7 @@ func (p Param) Render() huh.Field {`
`34`	`34`
`35`	`35`	`param.Value(&p.DefaultValue)`
`36`	`36`
`37`		`- var group []validators.Validator`
	`37`	`+ var group []validators.Validator[string]`
`38`	`38`	`if p.Required {`
`39`	`39`	`group = append(group, validators.Required(p.Name, false))`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,13 +33,13 @@ func (p Parameter) Render() huh.Field {`
`33`	`33`	`func (p Parameter) Validate() []error {`
`34`	`34`	`var errs []error`
`35`	`35`	`if strutil.IsEmpty(p.Name) {`
`36`		`- errs = append(errs, errors.NewRequiredErr("parameter.name"))`
	`36`	`+ errs = append(errs, errors.NewMissingErr("parameter.name"))`
`37`	`37`	`}`
`38`	`38`	`if strutil.IsEmpty(p.Label) {`
`39`		`- errs = append(errs, errors.NewRequiredErr("parameter.label"))`
	`39`	`+ errs = append(errs, errors.NewMissingErr("label", p.Name))`
`40`	`40`	`}`
`41`	`41`	`if strutil.IsEmpty(p.Type) {`
`42`		`- errs = append(errs, errors.NewRequiredErr("parameter.type"))`
	`42`	`+ errs = append(errs, errors.NewMissingErr("type", p.Name))`
`43`	`43`	`}`
`44`	`44`	`return errs`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ func (p Param) RenderInput() *huh.Input {`
`35`	`35`
`36`	`36`	`param.Value(&p.DefaultValue)`
`37`	`37`
`38`		`- var group []validators.Validator`
	`38`	`+ var group []validators.Validator[string]`
`39`	`39`	`if p.Required {`
`40`	`40`	`group = append(group, validators.Required(p.Name, p.Trim))`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,11 @@`
`1`	`1`	`package validators`
`2`	`2`
`3`		`-type Validator func(string) error`
	`3`	`+type Validator[T string \| []string] func(T) error`
`4`	`4`
`5`		`-func Group(validators ...Validator) Validator {`
`6`		`- return func(str string) error {`
	`5`	`+func Group[T string \| []string](validators ...Validator[T]) Validator[T] {`
	`6`	`+ return func(t T) error {`
`7`	`7`	`for _, validator := range validators {`
`8`		`- if err := validator(str); err != nil {`
	`8`	`+ if err := validator(t); err != nil {`
`9`	`9`	`return err`
`10`	`10`	`}`
`11`	`11`	`}`