feat(comment): add comment flag #90
Closed
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
chore: add generator file feat: add comment
jmattheis
reviewed
Oct 5, 2023
| @@ -14,6 +14,7 @@ func main() { | |||
| output := flag.String("output", "./generated/generated.go", "") | |||
| extends := flag.String("extends", "", "comma separated list of local or package extends") | |||
| packagePath := flag.String("packagePath", "", "optional full package path for the generated code") | |||
| commentOnStruct := flag.String("commentOnStruct", "", "optional comment on the generated struct") | |||
There was a problem hiding this comment.
I rather not have this as a cli flag, it should be a comment that can be added to the converter interface. Something like goverter:structComment and it should be possible to apply this multiple times like
// goverter:converter
// goverter:structComment MyConverterImpl
// goverter:structComment
// goverter:structComment More detailed description
// goverter:structComment @autowire(set=converter)
type Converter interface {
Convert(source []Input) []Output
}Furthermore this feature requires some tests scenarios defined in the scenario directory and docs in docs/conversion/misc.md
Merged
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.
What I did.
This pull request introduces a new feature to the Goverter library: the -commentOnStruct flag. This feature allows users to add comments above generated structs, which can be especially useful when working with other code generation tools like Autowire.
Changes Made
I have introduced a new command-line flag, -commentOnStruct, which, when enabled, will add a comment above each generated struct. These comments can provide valuable information about the struct's purpose, source, or usage.
Example Usage
result