Add ability to ignore fields that match given regex pattern(s) #199
Conversation
options.go
Outdated
| // | ||
| // Example: When referencing protoc generated structs, you will likely want to | ||
| // ignore/skip XXX_* fields. | ||
| func IgnoreFieldsRegex(regexes ...*regexp.Regexp) Option { |
There was a problem hiding this comment.
Please change this accept strings, and compile the regexes in the OptionFunc. It would be tedious to require users to compile their patterns.
build.go
Outdated
| for _, field := range fields { | ||
| for _, r := range k.ignoreFieldsRegex { | ||
| if r.Match([]byte(field.field.Name)) { |
There was a problem hiding this comment.
Use MatchString() instead of casting.
There was a problem hiding this comment.
Please match against v.Type().Name + "." + field.field.Name so that it can match against the containing struct as well. It's fairly common in deeply nested CLI structures to repeat fields and being able to discriminate by the containing "command" will future proof this.
build.go
Outdated
| for _, field := range fields { | ||
| for _, r := range k.ignoreFieldsRegex { | ||
| if r.Match([]byte(field.field.Name)) { | ||
| fmt.Println("skipping field: ", field.field.Name) |
|
Thanks for this, I love getting contributions! :) |
Thank YOU - you did all the hard work! I added an extra test for options - noticed something was untested when running a coverage report for my own stuff. All feedback should be addressed. |
@alecthomas this adds functionality to allow kong to ignore fields that match a certain pattern.
I needed this in order to be able to ensure that kong does not parse fields like
XXX_that are automatically generated via protoc.The regexp is kind of a big hammer but since this is for CLI generation, I figure the perf hit is OK. LMK.