Add emit_sql_as_comment
option to Go code plugin
#2735
Merged
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 option adds the raw SQL query as a comment to the generated query function, defaulted to false.
This is useful when working in an IDE that displays comments over functions, you are able to glance at the actual SQL query that will be executed without having to lose context of where you are in the current file you are working on.
If you have a query with comments already, it will add the query as a Code Block underneath
Input:
Output:
Example of how this shows up in VS Code when referencing the function:
If you haven't already got a comment, it will add the name of the function - I wasn't 100% sure about this but it allows the godoc comment to still have valid formatting when running
gofmt
Input:
Output:
Example of how this shows up in VS Code when referencing the function: