Add @Generated annotation to generated Java types
#1075
Merged
+141
−4
Conversation
This file contains hidden or 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
bioball
requested changes
Jun 10, 2025
| import java.lang.annotation.RetentionPolicy; | ||
| import java.lang.annotation.Target; | ||
|
|
||
| /** Annotation marking this type as generated. */ |
There was a problem hiding this comment.
Suggested change
| /** Annotation marking this type as generated. */ | |
| /** Indicates that the annotated class was generated by Pkl. */ |
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.pkl.config.java.mapper; |
There was a problem hiding this comment.
Since this is not related to object mapping, let's move this up one level, to package org.pkl.config.java
| /** | ||
| * @return who generated the annotated type | ||
| */ | ||
| String value(); |
There was a problem hiding this comment.
I don't know if there's any purpose to this field. Remove?
| @@ -19,6 +19,8 @@ | |||
|
|
|||
| /** Configuration options for Java code generators. Documented in user manual. */ | |||
| public interface JavaCodeGenSpec extends CodeGenSpec { | |||
| Property<Boolean> getGeneratedAnnotation(); | |||
|
|
|||
There was a problem hiding this comment.
Can you move this to CodeGenSpec instead? This way, we can add this same flag to the kotlin code generator. And let's rename this to getAddGeneratedAnnotation. Same for JavaCodeGenTask.
MikeSchulze
force-pushed
the
generated-annotation
branch
from
d38549c to
36f4e27
Compare
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.
Why?
JaCoCo automatically excludes methods and classes annotated with
@Generatedfrom the coverage reports. This is very important to us as generated code should not normally be included in the coverage report. We want to measure the coverage of the code that we actually wrote and maintain, not the code that was automatically generated by tools.By introducing a property
generatedAnnotation(default valuefalse) one could enable writing@Generatedon Java types to be generated.