add support for custom Go struct tags #1569
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is equivalent and slightly simpler.
Rather than modeling when .Tag will be empty, check directly whether .Tag is empty. This simplifies the template and reduces the number of places that must be touched when adding new sources of struct tags.
Rather than inserting the colon at tag construction time, insert it at tag formatting time. This makes the input look a bit more natural. This matters more, as we are about to add another, more distant, place where we insert tags.
This change adds a new type of override: go_struct_tag. When provided for a field, it adds that struct tag to the generated code. The provided struct tag is parsed according to the standard package reflect rules, and its components are updated independently. This allows struct tag overrides to be compatible with (and optionally override) autogenerated json and db struct tags. Fixes sqlc-dev#534
The code uses some 1.18-only features, like strings.Cut and testing.F. The CI requires Go 1.18. Since Go 1.18 is now required, reflect that in the go.mod.
josharian
force-pushed
the
custom-go-struct-tag
branch
from
b016f14
to
9e00b39
Compare
|
Ping. |
|
Hi there, thank you for implementing this feature. I do not see this feature from documentation, and on original thread ( #534) there are two design that were discussed:
may I know which design actually implemented and some example ? Am hopeful it is the TS idea since it can really integrate well with validator library. |
|
@nahwinrajan search for |
|
How could a use it? Is there an example ❯ sqlc generate
error parsing sqlc.yaml: yaml: unmarshal errors:
line 12: field go_struct_tag not found in type config.SQLGosqlc.yaml version: "2"
sql:
- engine: "postgresql"
queries: "config/sqls"
schema: "config/schema.sql"
gen:
go:
emit_json_tags: true
json_tags_case_style: snake
package: "queries"
out: "config/queries"
go_struct_tag: 'a:"b" x:"y,z"'
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a new type of override: go_struct_tag.
When provided for a field, it adds that struct tag to the generated code.
The provided struct tag is parsed according to the standard
package reflect rules, and its components are updated independently.
This allows struct tag overrides to be compatible with (and optionally
override) autogenerated json and db struct tags.
This PR also includes some minor preparatory cleanup and fixes.
I recommend reviewing it one commit at a time.
The early commits are small and easy; the last commit contains the new feature.
Fixes #534