Java recipe to reorder annotations

[greg-at-moderne]

What problem are you trying to solve?

I'd like to be able to tackle inconsistent order of frequently used annotations in the code.

e.g.

    @Issue("https://github.com/openrewrite/rewrite/issues/2973")
    @Test
    @ExpectedToFail
    void explicitImplementationClassInApi() {

vs.

        @Issue("https://github.com/openrewrite/rewrite-static-analysis/issues/112")
        @ExpectedToFail("only directly returned ternaries are taken into account")
        @Test
        void doReplaceNestedOrAssignmentTernaryWithIfElse() {

in our own code, etc. There are other combinations.

Describe the solution you'd like

Maybe a recipe to instil some deterministic order (alphabetic) or maybe some smart way of passing priorities/orders - e.g. @Test should always come first, etc.

[greg-at-moderne]

Marking as good-first-issue as I believe this should be quite easy for beginners to implement. Whoever does it, please come up with the description of the interface of the recipe (what arguments) first, so that we can pick whatever makes the most sense.

[mghildiy]

I can give t a try. Please assign it to me.

[mghildiy]

I guess this work would need working in modules rewrite-java and rewrite-java-test, and so I can comment our other modules in IDE.properties.

[timtebeek]

@mghildiy we tend to assign issues to folks the moment they open up a draft pull request with tests; that way issues are only assigned when there's work in progress.

On our side we also have @steve-aom-elliott looking to get started with recipe development, and figured this could be a good one to start with.

I'd implement this as a recipe with a static nested JavaIsoVisitor class that takes an optional Comparator<J.Annotation> argument to define the order in which annotations should appear. The Recipe class can then by default pass in a comparator to the visitor that only looks at the annotation name. That should be good enough to get started, and folks that want something else can implement their own recipe reusing that same visitor.

[mghildiy]

@mghildiy we tend to assign issues to folks the moment they open up a draft pull request with tests; that way issues are only assigned when there's work in progress.

On our side we also have @steve-aom-elliott looking to get started with recipe development, and figured this could be a good one to start with.

I'd implement this as a recipe with a static nested JavaIsoVisitor class that takes an optional Comparator<J.Annotation> argument to define the order in which annotations should appear. The Recipe class can then by default pass in a comparator to the visitor that only looks at the annotation name. That should be good enough to get started, and folks that want something else can implement their own recipe reusing that same visitor.

Hi Tim, I am in process of configuring my system for recipe writing as explained here. So yes, I am working on this task. But if there is another person who can immediately start working on it, I am fine with that. I can pick up another beginner task then.

[timtebeek]

Appreciate the offer to help @mghildiy ; perhaps best to avoid conflicts then if you start with any of the other good first issues.

[Stephan202]

In case you plan to lexicographically order all annotations: this Error Prone code can serve as inspiration. Note that it sorts declaration annotations before type annotations; see also PicnicSupermarket/error-prone-support#182.

[keerthivasan91]

@test
@issue
@ExpectedToFail
@OtherAnnotations
void testMethod() { ... }