Reordering Annotations

[steve-aom-elliott]

• Fixes Java recipe to reorder annotations #543

Reordering annotations (alphabetically only for now on method declarations alone).

Looking to define boundaries for what should be included in the changes for annotation reordering. As per the linked issue, the starting point would be a default alphabetical ordering of annotations (the ability to pass in what Comparator<J.Annotation> to use will be upcoming). It's been suggested to start with just method declarations and move on from there after, but I'm open to thoughts and suggestions.

What's changed?

• Added a ReorderAnnotations recipe for reordering annotations (default alphabetic) on J.MethodDeclaration
• Added simple tests for the reordering for method declarations (only using the default sorting)

Related issue with additional fixes that should be implemented first

• Implement missing annotation placement styles and formatting rewrite#5392

Anyone you would like to review specifically?

@timtebeek
@greg-at-moderne

Checklist

• I've added unit tests to cover both positive and negative cases for method declarations
• I've implemented handling of class declarations
• I've implemented handling of field declarations
• I've added unit tests to cover both positive and negative cases for class declarations
• I've added unit tests to cover both positive and negative cases for field declarations
• I've implemented the ability to provide what Comparator<J.Annotation> you would like to use to sort the annotations on a given LST entry point
• I've read and applied the recipe conventions and best practices
• I've used the IntelliJ IDEA auto-formatter on affected files

[Laurens-W]

Efforts here can be continued as openrewrite/rewrite#5392 has been completed

[timtebeek]

@Laurens-W no rush on this at all ofcourse, but it's odd to see that we introduce a newline for the simplest case, and there's weird indentation and shuffling of comments for the more complex case. The first I'd at least expect to be fixed; the second is optional.

[Laurens-W]

For the simple case I see this happen:

The newly added recipe here calls autoformat on the method
That ends up hitting this part of the autoformat visitor
https://github.com/openrewrite/rewrite/blob/32d30c0d9d15df09963fce9927ab242ee1ffdbe3/rewrite-java/src/main/java/org/openrewrite/java/format/AutoFormatVisitor.java#L58-L66

of which the NormalizeFormatVisitor does this upon visiting a method:
https://github.com/openrewrite/rewrite/blob/32d30c0d9d15df09963fce9927ab242ee1ffdbe3/rewrite-java/src/main/java/org/openrewrite/java/format/NormalizeFormatVisitor.java#L81-L87

Basically the NormalizeFormatVisitor grabs the prefix from an annotation that hasn't had it's wrapping adjusted yet, so it adds a newline.
We could circumvent this by only invoking the WrappingAndBraces visitor but I'm not sure we want to explicitly call that from a recipe.

[timtebeek]

Thanks for that context; in that case let's make it a little easier here and just keep whatever prefix was there before reshuffling. Would you agree?

[timtebeek]

Thanks all! I think this increment is ready to be merged, applied to all our projects, and enforced going forward. I'll wait for a second approval since I've made quite some changes still.

[Laurens-W]

LGTM

[timtebeek]

There's one change here that I'm not quite happy with, and was helpfully pointed out here:

• Java recipe to reorder annotations #543 (comment)