Allow key-naming-case to support regular expression matching

[pedantic79]

I've using a customize version to find keys that don't match the convention I'm looking for, but have been trying to think of a more customizable way for this to be done.

For example, I'm okay with a key like externalATM, while the camel would want it to be externalAtm. My thought was to have key-naming-case support a "regex" setting, and have another parameter to set that regex.

So something like:

sloglint -key-naming-case regex -regex-naming-case '[a-z][a-zA-Z0-9]*' ./...

This would allow others more flexibility on how they want their keys name.

[tmzane]

I agree, this would be useful to have, key-naming-case is kinda limited at the moment. I can work on the implementation, thanks for the idea.

[stevehipwell]

Isn't externalATM the correct Go naming pattern?

[pedantic79]

Yes externalATM is correctly named for Go, as go recommends capitalizing acronyms. However, this isn't a variable name for go. This is a JSON key. In Javascript, some style-guides would recommend externalAtm. You can see this in something like requestId, however this is style-guide dependent as Javascript isn't as opinionated.

[stevehipwell]

@pedantic79 although this isn't a variable name for Go, it's in the Go context so I'd expect support for the Go naming conventions.

[pedantic79]

@stevehipwell I don’t disagree but I’m just suggesting a way for the rules to be more customizable via regEx. Whether this supports Go naming conventions is beyond the scope of this issue.

[stevehipwell]

@pedantic79 but would you need regex if camel worked with the Go naming conventions?

[pedantic79]

@stevehipwell you're missing the point. This issue is saying that an one size fits all approach isn't good enough. A Go naming convention compliant option is NOT the requirement I have for structured logging. As I have many logs from many different languages all logging into the same centralized place. All those logs are supposed to follow JSON logging format. It's not okay for requestID in some places and requestId in others.

[stevehipwell]

@pedantic79 I'm not missing the point, just trying to understand exactly what this issue was asking for. My issue would be fixed by regex, but it could also be fixed by making camel respect Go naming conventions, or even by adding a Go version of camel.

Out of interest what would your regex look like to guarantee consistent keys? It looks like the current camel implementation guarantees consistency, an inconsistent regex implementation to support the Go naming convention would be fairly simple; but to guarantee consistency I think you'd need a much more complex regex with explicit patterns (e.g. ID) using lookahead and lookbehind?