This repository has been archived by the owner on Oct 10, 2024. It is now read-only.
Add ability to insert comment inside class scope #887
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
Motivation: When generating code it maybe useful to insert comments as anchors for post processing and further extension by other code generation tools. However this is not easy to achieve with the existing API. Modifications: - Add a `TypeSpec.addRawInitializerBlock` method which is treated the same as `addInitializerBlock` without type restrictions and additional scope block.
|
apple/servicetalk#2160 -> to work around not being able to insert comments outside pre-defined scopes we have to do regex on the resulting generated code string. please advise if there is a more preferred way todo this, and if not this PR provides a way. There is somewhat of an escape hatch but the users of javapoet can already generate invalid code in other scenarios so I think something similar would be reasonable. |
Scottmitch
commented
Apr 29, 2022
| @@ -626,6 +626,11 @@ public Builder addInitializerBlock(CodeBlock block) { | |||
| return this; | |||
| } | |||
|
|
|||
| public Builder addRawInitializerBlock(CodeBlock block) { | |||
There was a problem hiding this comment.
happy to change the name if maintainers prefer (e.g. addRawCodeBlock as suggested by @bondolo)
|
closing in favor of #967 (more constrained approach) |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Motivation:
When generating code it maybe useful to insert
comments as anchors for post processing and further
extension by other code generation tools. However
this is not easy to achieve with the existing API.
Modifications:
TypeSpec.addRawInitializerBlockmethod whichis treated the same as
addInitializerBlockwithouttype restrictions and additional scope block.