refactor!: rename SetAndCheckArgument to Apply

muthukrishnan24 · muthukrishnan24 · commit f46b51c4bfbe · 2021-09-21T19:27:29.000+05:30
diff --git a/config/config.go b/config/config.go
@@ -119,7 +119,7 @@ func GetRules(conf *lint.Config) ([]lint.Rule, error) {
 			return nil, fmt.Errorf("unknown rule: %s", ruleName)
 		}
 		if ruleConfig.Enabled {
-			err := r.SetAndCheckArgument(ruleConfig.Argument)
+			err := r.Apply(ruleConfig.Argument)
 			if err != nil {
 				return nil, err
 			}
diff --git a/lint/rule.go b/lint/rule.go
@@ -6,10 +6,12 @@ import "github.com/conventionalcommit/commitlint/message"
 type Rule interface {
 	// Name returns name of the rule, it should be a unique identifier
 	Name() string
-	// SetAndCheckArgument sets the argument to the rule from config file
+
+	// Apply sets the argument to the rule from config file
 	// if args are invalid or not expected return an error
-	// SetAndCheckArgument is called before Validate
-	SetAndCheckArgument(arg interface{}) error
+	// Apply is called before Validate
+	Apply(arg interface{}) error
+
 	// Validate validates the rule for given message
 	Validate(msg *message.Commit) (result string, isValid bool)
 }
diff --git a/rule/charset.go b/rule/charset.go
@@ -25,8 +25,8 @@ func (r *ScopeCharsetRule) Validate(msg *message.Commit) (string, bool) {
 	return "", true
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *ScopeCharsetRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *ScopeCharsetRule) Apply(arg interface{}) error {
 	return setStringArg(&r.Charset, arg, r.Name())
 }
 
@@ -48,8 +48,8 @@ func (r *TypeCharsetRule) Validate(msg *message.Commit) (string, bool) {
 	return "", true
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *TypeCharsetRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *TypeCharsetRule) Apply(arg interface{}) error {
 	return setStringArg(&r.Charset, arg, r.Name())
 }
 
diff --git a/rule/enum.go b/rule/enum.go
@@ -25,8 +25,8 @@ func (r *ScopeEnumRule) Validate(msg *message.Commit) (string, bool) {
 	return "", true
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *ScopeEnumRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *ScopeEnumRule) Apply(arg interface{}) error {
 	err := setStringArrArg(&r.Scopes, arg, r.Name())
 	if err != nil {
 		return err
@@ -54,8 +54,8 @@ func (r *TypeEnumRule) Validate(msg *message.Commit) (string, bool) {
 	return "", true
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *TypeEnumRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *TypeEnumRule) Apply(arg interface{}) error {
 	err := setStringArrArg(&r.Types, arg, r.Name())
 	if err != nil {
 		return err
diff --git a/rule/max_length.go b/rule/max_length.go
@@ -19,8 +19,8 @@ func (r *HeadMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.FullHeader)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *HeadMaxLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *HeadMaxLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -37,8 +37,8 @@ func (r *BodyMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Body)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *BodyMaxLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *BodyMaxLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -55,8 +55,8 @@ func (r *FooterMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Footer.FullFooter)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *FooterMaxLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *FooterMaxLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -73,8 +73,8 @@ func (r *TypeMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.Type)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *TypeMaxLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *TypeMaxLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -91,8 +91,8 @@ func (r *ScopeMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.Scope)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *ScopeMaxLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *ScopeMaxLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -109,8 +109,8 @@ func (r *DescriptionMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLen(r.CheckLen, msg.Header.Description)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *DescriptionMaxLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *DescriptionMaxLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
diff --git a/rule/max_line_length.go b/rule/max_line_length.go
@@ -20,8 +20,8 @@ func (r *BodyMaxLineLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLineLength(r.CheckLen, msg.Body)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *BodyMaxLineLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *BodyMaxLineLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -38,8 +38,8 @@ func (r *FooterMaxLineLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMaxLineLength(r.CheckLen, msg.Footer.FullFooter)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *FooterMaxLineLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *FooterMaxLineLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
diff --git a/rule/min_length.go b/rule/min_length.go
@@ -19,8 +19,8 @@ func (r *HeadMinLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.FullHeader)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *HeadMinLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *HeadMinLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -37,8 +37,8 @@ func (r *BodyMinLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Body)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *BodyMinLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *BodyMinLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -55,8 +55,8 @@ func (r *FooterMinLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Footer.FullFooter)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *FooterMinLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *FooterMinLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -73,8 +73,8 @@ func (r *TypeMinLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.Type)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *TypeMinLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *TypeMinLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -91,8 +91,8 @@ func (r *ScopeMinLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.Scope)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *ScopeMinLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *ScopeMinLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -109,8 +109,8 @@ func (r *DescriptionMinLenRule) Validate(msg *message.Commit) (string, bool) {
 	return checkMinLen(r.CheckLen, msg.Header.Description)
 }
 
-// SetAndCheckArgument sets the needed argument for the rule
-func (r *DescriptionMinLenRule) SetAndCheckArgument(arg interface{}) error {
+// Apply sets the needed argument for the rule
+func (r *DescriptionMinLenRule) Apply(arg interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 

Original file line number	Diff line number	Diff line change
`@@ -119,7 +119,7 @@ func GetRules(conf *lint.Config) ([]lint.Rule, error) {`
`119`	`119`	`return nil, fmt.Errorf("unknown rule: %s", ruleName)`
`120`	`120`	`}`
`121`	`121`	`if ruleConfig.Enabled {`
`122`		`- err := r.SetAndCheckArgument(ruleConfig.Argument)`
	`122`	`+ err := r.Apply(ruleConfig.Argument)`
`123`	`123`	`if err != nil {`
`124`	`124`	`return nil, err`
`125`	`125`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,8 +25,8 @@ func (r ScopeCharsetRule) Validate(msg message.Commit) (string, bool) {`
`25`	`25`	`return "", true`
`26`	`26`	`}`
`27`	`27`
`28`		`-// SetAndCheckArgument sets the needed argument for the rule`
`29`		`-func (r *ScopeCharsetRule) SetAndCheckArgument(arg interface{}) error {`
	`28`	`+// Apply sets the needed argument for the rule`
	`29`	`+func (r *ScopeCharsetRule) Apply(arg interface{}) error {`
`30`	`30`	`return setStringArg(&r.Charset, arg, r.Name())`
`31`	`31`	`}`
`32`	`32`
`@@ -48,8 +48,8 @@ func (r TypeCharsetRule) Validate(msg message.Commit) (string, bool) {`
`48`	`48`	`return "", true`
`49`	`49`	`}`
`50`	`50`
`51`		`-// SetAndCheckArgument sets the needed argument for the rule`
`52`		`-func (r *TypeCharsetRule) SetAndCheckArgument(arg interface{}) error {`
	`51`	`+// Apply sets the needed argument for the rule`
	`52`	`+func (r *TypeCharsetRule) Apply(arg interface{}) error {`
`53`	`53`	`return setStringArg(&r.Charset, arg, r.Name())`
`54`	`54`	`}`
`55`	`55`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ func (r HeadMaxLenRule) Validate(msg message.Commit) (string, bool) {`
`19`	`19`	`return checkMaxLen(r.CheckLen, msg.Header.FullHeader)`
`20`	`20`	`}`
`21`	`21`
`22`		`-// SetAndCheckArgument sets the needed argument for the rule`
`23`		`-func (r *HeadMaxLenRule) SetAndCheckArgument(arg interface{}) error {`
	`22`	`+// Apply sets the needed argument for the rule`
	`23`	`+func (r *HeadMaxLenRule) Apply(arg interface{}) error {`
`24`	`24`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`25`	`25`	`}`
`26`	`26`
`@@ -37,8 +37,8 @@ func (r BodyMaxLenRule) Validate(msg message.Commit) (string, bool) {`
`37`	`37`	`return checkMaxLen(r.CheckLen, msg.Body)`
`38`	`38`	`}`
`39`	`39`
`40`		`-// SetAndCheckArgument sets the needed argument for the rule`
`41`		`-func (r *BodyMaxLenRule) SetAndCheckArgument(arg interface{}) error {`
	`40`	`+// Apply sets the needed argument for the rule`
	`41`	`+func (r *BodyMaxLenRule) Apply(arg interface{}) error {`
`42`	`42`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`43`	`43`	`}`
`44`	`44`
`@@ -55,8 +55,8 @@ func (r FooterMaxLenRule) Validate(msg message.Commit) (string, bool) {`
`55`	`55`	`return checkMaxLen(r.CheckLen, msg.Footer.FullFooter)`
`56`	`56`	`}`
`57`	`57`
`58`		`-// SetAndCheckArgument sets the needed argument for the rule`
`59`		`-func (r *FooterMaxLenRule) SetAndCheckArgument(arg interface{}) error {`
	`58`	`+// Apply sets the needed argument for the rule`
	`59`	`+func (r *FooterMaxLenRule) Apply(arg interface{}) error {`
`60`	`60`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`61`	`61`	`}`
`62`	`62`
`@@ -73,8 +73,8 @@ func (r TypeMaxLenRule) Validate(msg message.Commit) (string, bool) {`
`73`	`73`	`return checkMaxLen(r.CheckLen, msg.Header.Type)`
`74`	`74`	`}`
`75`	`75`
`76`		`-// SetAndCheckArgument sets the needed argument for the rule`
`77`		`-func (r *TypeMaxLenRule) SetAndCheckArgument(arg interface{}) error {`
	`76`	`+// Apply sets the needed argument for the rule`
	`77`	`+func (r *TypeMaxLenRule) Apply(arg interface{}) error {`
`78`	`78`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`79`	`79`	`}`
`80`	`80`
`@@ -91,8 +91,8 @@ func (r ScopeMaxLenRule) Validate(msg message.Commit) (string, bool) {`
`91`	`91`	`return checkMaxLen(r.CheckLen, msg.Header.Scope)`
`92`	`92`	`}`
`93`	`93`
`94`		`-// SetAndCheckArgument sets the needed argument for the rule`
`95`		`-func (r *ScopeMaxLenRule) SetAndCheckArgument(arg interface{}) error {`
	`94`	`+// Apply sets the needed argument for the rule`
	`95`	`+func (r *ScopeMaxLenRule) Apply(arg interface{}) error {`
`96`	`96`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`97`	`97`	`}`
`98`	`98`
`@@ -109,8 +109,8 @@ func (r DescriptionMaxLenRule) Validate(msg message.Commit) (string, bool) {`
`109`	`109`	`return checkMaxLen(r.CheckLen, msg.Header.Description)`
`110`	`110`	`}`
`111`	`111`
`112`		`-// SetAndCheckArgument sets the needed argument for the rule`
`113`		`-func (r *DescriptionMaxLenRule) SetAndCheckArgument(arg interface{}) error {`
	`112`	`+// Apply sets the needed argument for the rule`
	`113`	`+func (r *DescriptionMaxLenRule) Apply(arg interface{}) error {`
`114`	`114`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`115`	`115`	`}`
`116`	`116`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@ func (r BodyMaxLineLenRule) Validate(msg message.Commit) (string, bool) {`
`20`	`20`	`return checkMaxLineLength(r.CheckLen, msg.Body)`
`21`	`21`	`}`
`22`	`22`
`23`		`-// SetAndCheckArgument sets the needed argument for the rule`
`24`		`-func (r *BodyMaxLineLenRule) SetAndCheckArgument(arg interface{}) error {`
	`23`	`+// Apply sets the needed argument for the rule`
	`24`	`+func (r *BodyMaxLineLenRule) Apply(arg interface{}) error {`
`25`	`25`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`26`	`26`	`}`
`27`	`27`
`@@ -38,8 +38,8 @@ func (r FooterMaxLineLenRule) Validate(msg message.Commit) (string, bool) {`
`38`	`38`	`return checkMaxLineLength(r.CheckLen, msg.Footer.FullFooter)`
`39`	`39`	`}`
`40`	`40`
`41`		`-// SetAndCheckArgument sets the needed argument for the rule`
`42`		`-func (r *FooterMaxLineLenRule) SetAndCheckArgument(arg interface{}) error {`
	`41`	`+// Apply sets the needed argument for the rule`
	`42`	`+func (r *FooterMaxLineLenRule) Apply(arg interface{}) error {`
`43`	`43`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`44`	`44`	`}`
`45`	`45`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ func (r HeadMinLenRule) Validate(msg message.Commit) (string, bool) {`
`19`	`19`	`return checkMinLen(r.CheckLen, msg.Header.FullHeader)`
`20`	`20`	`}`
`21`	`21`
`22`		`-// SetAndCheckArgument sets the needed argument for the rule`
`23`		`-func (r *HeadMinLenRule) SetAndCheckArgument(arg interface{}) error {`
	`22`	`+// Apply sets the needed argument for the rule`
	`23`	`+func (r *HeadMinLenRule) Apply(arg interface{}) error {`
`24`	`24`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`25`	`25`	`}`
`26`	`26`
`@@ -37,8 +37,8 @@ func (r BodyMinLenRule) Validate(msg message.Commit) (string, bool) {`
`37`	`37`	`return checkMinLen(r.CheckLen, msg.Body)`
`38`	`38`	`}`
`39`	`39`
`40`		`-// SetAndCheckArgument sets the needed argument for the rule`
`41`		`-func (r *BodyMinLenRule) SetAndCheckArgument(arg interface{}) error {`
	`40`	`+// Apply sets the needed argument for the rule`
	`41`	`+func (r *BodyMinLenRule) Apply(arg interface{}) error {`
`42`	`42`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`43`	`43`	`}`
`44`	`44`
`@@ -55,8 +55,8 @@ func (r FooterMinLenRule) Validate(msg message.Commit) (string, bool) {`
`55`	`55`	`return checkMinLen(r.CheckLen, msg.Footer.FullFooter)`
`56`	`56`	`}`
`57`	`57`
`58`		`-// SetAndCheckArgument sets the needed argument for the rule`
`59`		`-func (r *FooterMinLenRule) SetAndCheckArgument(arg interface{}) error {`
	`58`	`+// Apply sets the needed argument for the rule`
	`59`	`+func (r *FooterMinLenRule) Apply(arg interface{}) error {`
`60`	`60`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`61`	`61`	`}`
`62`	`62`
`@@ -73,8 +73,8 @@ func (r TypeMinLenRule) Validate(msg message.Commit) (string, bool) {`
`73`	`73`	`return checkMinLen(r.CheckLen, msg.Header.Type)`
`74`	`74`	`}`
`75`	`75`
`76`		`-// SetAndCheckArgument sets the needed argument for the rule`
`77`		`-func (r *TypeMinLenRule) SetAndCheckArgument(arg interface{}) error {`
	`76`	`+// Apply sets the needed argument for the rule`
	`77`	`+func (r *TypeMinLenRule) Apply(arg interface{}) error {`
`78`	`78`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`79`	`79`	`}`
`80`	`80`
`@@ -91,8 +91,8 @@ func (r ScopeMinLenRule) Validate(msg message.Commit) (string, bool) {`
`91`	`91`	`return checkMinLen(r.CheckLen, msg.Header.Scope)`
`92`	`92`	`}`
`93`	`93`
`94`		`-// SetAndCheckArgument sets the needed argument for the rule`
`95`		`-func (r *ScopeMinLenRule) SetAndCheckArgument(arg interface{}) error {`
	`94`	`+// Apply sets the needed argument for the rule`
	`95`	`+func (r *ScopeMinLenRule) Apply(arg interface{}) error {`
`96`	`96`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`97`	`97`	`}`
`98`	`98`
`@@ -109,8 +109,8 @@ func (r DescriptionMinLenRule) Validate(msg message.Commit) (string, bool) {`
`109`	`109`	`return checkMinLen(r.CheckLen, msg.Header.Description)`
`110`	`110`	`}`
`111`	`111`
`112`		`-// SetAndCheckArgument sets the needed argument for the rule`
`113`		`-func (r *DescriptionMinLenRule) SetAndCheckArgument(arg interface{}) error {`
	`112`	`+// Apply sets the needed argument for the rule`
	`113`	`+func (r *DescriptionMinLenRule) Apply(arg interface{}) error {`
`114`	`114`	`return setIntArg(&r.CheckLen, arg, r.Name())`
`115`	`115`	`}`
`116`	`116`