[jira] [Commented] (GROOVY-8352) Add a @Generated annotation to mark generated members

Previous Topic Next Topic
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[jira] [Commented] (GROOVY-8352) Add a @Generated annotation to mark generated members

JIRA jira@apache.org

    [ https://issues.apache.org/jira/browse/GROOVY-8352?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16202033#comment-16202033 ]

ASF GitHub Bot commented on GROOVY-8352:

Github user paulk-asert commented on a diff in the pull request:

    --- Diff: src/main/org/codehaus/groovy/classgen/Verifier.java ---
    @@ -384,6 +387,7 @@ public void visit(MethodVisitor mv) {
         protected void addGroovyObjectInterfaceAndMethods(ClassNode node, final String classInternalName) {
             if (!node.isDerivedFromGroovyObject()) node.addInterface(ClassHelper.make(GroovyObject.class));
             FieldNode metaClassField = getMetaClassField(node);
    +        AnnotationNode generatedAnnotation = new AnnotationNode(ClassHelper.make(GENERATED_ANNOTATION));
    --- End diff --
    I needed a guard on adding the annotation to keep the build happy:
    boolean shouldAnnotate = classNode.getModule().getContext() != null;

> Add a @Generated annotation to mark generated members
> -----------------------------------------------------
>                 Key: GROOVY-8352
>                 URL: https://issues.apache.org/jira/browse/GROOVY-8352
>             Project: Groovy
>          Issue Type: New Feature
>          Components: class generator
>    Affects Versions: 2.6.0-alpha-1
>            Reporter: Andres Almiray
> Rationale:
> Tooling support for Groovy may benefit from having additional information on generated members. We already provide some information by marking certain generated methods as synthetic, however tools such as IDEs hide these methods. The goal of `@Generated` is to mark members that are still visible to IDEs and other tools.
> Example:
> The JaCoCo and Lombok projects have agreed on an annotation named `@lombok.Generated`. This annotation serves as a hint to JaCoCo in order to skip coverage on the annotated elements; this helps JaCoCo in reporting more accurate coverage numbers for source code.
> What would be needed:
> An annotation in the groovy space named `@Generated` that can be used by JaCoCo (or any other tool). We can't use `@javax.annotation.Generated` because its retention policy is `SOURCE` and we need `CLASS` at the very least.
> Modify the Verifier to mark the 5 default GroovyObject methods with this annotation when the inspected class does not provide an implementation for any of these methods.
> Additionally, any AST transformation that creates additional methods/types/fields that should be marked can make use of the new annotation.
> The work required for JaCoCo has already been started and is tracked by https://github.com/jacoco/jacoco/pull/610

This message was sent by Atlassian JIRA