feat(json-tags): Add case style config option #905
Conversation
There was a problem hiding this comment.
First off, the code looks great. Thank you for updating the documentation as well as writing tests.
However, this change includes two breaking chages.
First, sqlc currently doesn't format the JSON tags in any particular case. The default is to just use the name of the column in the database. This behavior needs to stay the default.
Second, renames do not currently apply to JSON tags. I don't think we should start doing that now.
If you could fix up these two things, I can merge this.
This feature allows users to choose which case style will be used to generate JSON tags. The style can be selected by adding the `json_tags_case_style` setting key. - camelCase - "camel" - PascalCase - "pascal" - snake_case - "snake" - column name in the DB - "none" (default) Changes (in `internal/`): - Add `JSONTagsCaseStyle` field to package settings. - Implement `SetCaseStyle` function which converts the tag name to the specified case style. - Wrap JSON tags definition with the `JSONTagName` function which applies `SetCaseStyle` if `json_tags_case_style` key is set. - Add test for each case style. - Add `json_tags_case_style` key to documentation. Resolve #878
I removed the renames, a sure thing, I totally agree.
I added a wrapper which applies the case style formatter only if the Changes:
func JSONTagName(name string, settings config.CombinedSettings) string {
style := settings.Go.JSONTagsCaseStyle
if style == "" || style == "none" {
return name
} else {
return SetCaseStyle(name, style)
}
}
- func SetCaseStyle(name string, settings config.CombinedSettings) string {
+ func SetCaseStyle(name string, style string) string {
|
This PR allows users to choose which case style will be used to generate JSON tags.
The style can be selected by adding the
json_tags_case_stylesetting key.Changes
Add
JSONTagsCaseStylefield to package settings and set its default value tosnake.config/config.goconfig/v_one.goImplement
SetCaseStylefunction which converts the tag name to the specified case style.codegen/golang/field.goWrap JSON tags name with the
SetCaseStylefunction.Add test for each case style.
endtoend/testdata/camel_case/...endtoend/testdata/pascal_case/...endtoend/testdata/snake_case/...Add
json_tags_case_stylekey to the documentation.Resolve #878