feat!: add Flags in rule

Author: muthukrishnan24

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.Apply(ruleConfig.Argument)
+			err := r.Apply(ruleConfig.Argument, ruleConfig.Flags)
 			if err != nil {
 				return nil, err
 			}

lint/config.go

@@ -17,6 +17,9 @@ type RuleConfig struct {
 	Enabled  bool        `yaml:"enabled"`
 	Severity string      `yaml:"severity"`
 	Argument interface{} `yaml:"argument"`
+
+	// Optional flags
+	Flags map[string]interface{} `yaml:"flags"`
 }
 
 // GetRule returns RuleConfig for given ruleName

lint/rule.go

@@ -7,10 +7,10 @@ type Rule interface {
 	// Name returns name of the rule, it should be a unique identifier
 	Name() string
 
-	// Apply sets the argument to the rule from config file
-	// if args are invalid or not expected return an error
+	// Apply calls with arguments and flags for the rule from config file
+	// if flags or arguments are invalid or not expected return an error
 	// Apply is called before Validate
-	Apply(arg interface{}) error
+	Apply(arg interface{}, flags map[string]interface{}) error
 
 	// Validate validates the rule for given message
 	Validate(msg *message.Commit) (result string, isValid bool)

rule/charset.go

@@ -26,7 +26,7 @@ func (r *ScopeCharsetRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *ScopeCharsetRule) Apply(arg interface{}) error {
+func (r *ScopeCharsetRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setStringArg(&r.Charset, arg, r.Name())
 }
 
@@ -49,7 +49,7 @@ func (r *TypeCharsetRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *TypeCharsetRule) Apply(arg interface{}) error {
+func (r *TypeCharsetRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setStringArg(&r.Charset, arg, r.Name())
 }
 

rule/enum.go

@@ -26,7 +26,7 @@ func (r *ScopeEnumRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *ScopeEnumRule) Apply(arg interface{}) error {
+func (r *ScopeEnumRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	err := setStringArrArg(&r.Scopes, arg, r.Name())
 	if err != nil {
 		return err
@@ -55,7 +55,7 @@ func (r *TypeEnumRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *TypeEnumRule) Apply(arg interface{}) error {
+func (r *TypeEnumRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	err := setStringArrArg(&r.Types, arg, r.Name())
 	if err != nil {
 		return err

rule/max_length.go

@@ -20,7 +20,7 @@ func (r *HeadMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *HeadMaxLenRule) Apply(arg interface{}) error {
+func (r *HeadMaxLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -38,7 +38,7 @@ func (r *BodyMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *BodyMaxLenRule) Apply(arg interface{}) error {
+func (r *BodyMaxLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -56,7 +56,7 @@ func (r *FooterMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *FooterMaxLenRule) Apply(arg interface{}) error {
+func (r *FooterMaxLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -74,7 +74,7 @@ func (r *TypeMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *TypeMaxLenRule) Apply(arg interface{}) error {
+func (r *TypeMaxLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -92,7 +92,7 @@ func (r *ScopeMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *ScopeMaxLenRule) Apply(arg interface{}) error {
+func (r *ScopeMaxLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -110,7 +110,7 @@ func (r *DescriptionMaxLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *DescriptionMaxLenRule) Apply(arg interface{}) error {
+func (r *DescriptionMaxLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 

rule/max_line_length.go

@@ -21,7 +21,7 @@ func (r *BodyMaxLineLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *BodyMaxLineLenRule) Apply(arg interface{}) error {
+func (r *BodyMaxLineLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -39,7 +39,7 @@ func (r *FooterMaxLineLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *FooterMaxLineLenRule) Apply(arg interface{}) error {
+func (r *FooterMaxLineLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 

rule/min_length.go

@@ -20,7 +20,7 @@ func (r *HeadMinLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *HeadMinLenRule) Apply(arg interface{}) error {
+func (r *HeadMinLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -38,7 +38,7 @@ func (r *BodyMinLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *BodyMinLenRule) Apply(arg interface{}) error {
+func (r *BodyMinLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -56,7 +56,7 @@ func (r *FooterMinLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *FooterMinLenRule) Apply(arg interface{}) error {
+func (r *FooterMinLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -74,7 +74,7 @@ func (r *TypeMinLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *TypeMinLenRule) Apply(arg interface{}) error {
+func (r *TypeMinLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -92,7 +92,7 @@ func (r *ScopeMinLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *ScopeMinLenRule) Apply(arg interface{}) error {
+func (r *ScopeMinLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }
 
@@ -110,7 +110,7 @@ func (r *DescriptionMinLenRule) Validate(msg *message.Commit) (string, bool) {
 }
 
 // Apply sets the needed argument for the rule
-func (r *DescriptionMinLenRule) Apply(arg interface{}) error {
+func (r *DescriptionMinLenRule) Apply(arg interface{}, flags map[string]interface{}) error {
 	return setIntArg(&r.CheckLen, arg, r.Name())
 }