Replace getDisplayName() and getDescription() methods with fields (#6530)

* Replace `getDisplayName()` and `getDescription()` methods with fields

Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.java.recipes.UseDisplayNameAndDescriptionFields?organizationId=QUxML01vZGVybmUvTW9kZXJuZSArIE9wZW5SZXdyaXRl

Co-authored-by: Moderne <team@moderne.io>

* Restore `Find.getDescription()` over conflicting option

---------

Co-authored-by: Moderne <team@moderne.io>

Author: timtebeek

rewrite-core/src/main/java/org/openrewrite/FindGitProvenance.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.marker.GitProvenance;
 import org.openrewrite.table.DistinctGitProvenance;
@@ -33,17 +34,13 @@ public class FindGitProvenance extends ScanningRecipe<Set<GitProvenance>> {
 
     private final DistinctGitProvenance distinct = new DistinctGitProvenance(this);
 
-    @Override
-    public String getDisplayName() {
-        return "Show Git source control metadata";
-    }
+    @Getter
+    final String displayName = "Show Git source control metadata";
 
-    @Override
-    public String getDescription() {
-        return "List out the contents of each unique `GitProvenance` marker in the set of source files. " +
-               "When everything is working correctly, exactly one such marker should be printed as all source files are " +
-               "expected to come from the same repository / branch / commit hash.";
-    }
+    @Getter
+    final String description = "List out the contents of each unique `GitProvenance` marker in the set of source files. " +
+        "When everything is working correctly, exactly one such marker should be printed as all source files are " +
+        "expected to come from the same repository / branch / commit hash.";
 
     @Override
     public Set<GitProvenance> getInitialValue(ExecutionContext ctx) {

rewrite-core/src/main/java/org/openrewrite/ListRuntimeClasspath.java

@@ -19,6 +19,7 @@
 import io.github.classgraph.Resource;
 import io.github.classgraph.ResourceList;
 import io.github.classgraph.ScanResult;
+import lombok.Getter;
 import org.openrewrite.table.ClasspathReport;
 
 import java.net.URI;
@@ -32,15 +33,11 @@
 public class ListRuntimeClasspath extends ScanningRecipe<Integer> {
     transient ClasspathReport report = new ClasspathReport(this);
 
-    @Override
-    public String getDisplayName() {
-        return "List runtime classpath";
-    }
+    @Getter
+    final String displayName = "List runtime classpath";
 
-    @Override
-    public String getDescription() {
-        return "A diagnostic utility which emits the runtime classpath to a data table.";
-    }
+    @Getter
+    final String description = "A diagnostic utility which emits the runtime classpath to a data table.";
 
     @Override
     public Integer getInitialValue(ExecutionContext ctx) {

rewrite-core/src/main/java/org/openrewrite/Recipe.java

@@ -26,6 +26,7 @@
 import com.fasterxml.jackson.databind.json.JsonMapper;
 import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
 import lombok.AccessLevel;
+import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import lombok.Setter;
 import lombok.experimental.FieldDefaults;
@@ -90,15 +91,11 @@ public static Recipe noop() {
     }
 
     static class Noop extends Recipe {
-        @Override
-        public String getDisplayName() {
-            return "Do nothing";
-        }
+        @Getter
+        final String displayName = "Do nothing";
 
-        @Override
-        public String getDescription() {
-            return "Default no-op test, does nothing.";
-        }
+        @Getter
+        final String description = "Default no-op test, does nothing.";
     }
 
     /**

rewrite-core/src/main/java/org/openrewrite/config/CompositeRecipe.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.config;
 
+import lombok.Getter;
 import lombok.RequiredArgsConstructor;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.Recipe;
@@ -36,10 +37,8 @@ public String getDisplayName() {
         return getName();
     }
 
-    @Override
-    public String getDescription() {
-        return "A recipe that consists of a list of other recipes.";
-    }
+    @Getter
+    final String description = "A recipe that consists of a list of other recipes.";
 
     @Override
     public @Nullable Duration getEstimatedEffortPerOccurrence() {

rewrite-core/src/main/java/org/openrewrite/search/FindParseToPrintInequality.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.search;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.ExecutionContext;
 import org.openrewrite.Recipe;
@@ -30,19 +31,15 @@
 public class FindParseToPrintInequality extends Recipe {
     transient ParseToPrintInequalities inequalities = new ParseToPrintInequalities(this);
 
-    @Override
-    public String getDisplayName() {
-        return "Find parse to print inequality";
-    }
+    @Getter
+    final String displayName = "Find parse to print inequality";
 
-    @Override
-    public String getDescription() {
-        return "OpenRewrite `Parser` implementations should produce `SourceFile` objects whose `printAll()` " +
-               "method should be byte-for-byte equivalent with the original source file. When this isn't true, " +
-               "recipes can still run on the `SourceFile` and even produce diffs, but the diffs would fail to " +
-               "apply as a patch to the original source file. Most `Parser` use `Parser#requirePrintEqualsInput` " +
-               "to produce a `ParseError` when they fail to produce a `SourceFile` that is print idempotent.";
-    }
+    @Getter
+    final String description = "OpenRewrite `Parser` implementations should produce `SourceFile` objects whose `printAll()` " +
+        "method should be byte-for-byte equivalent with the original source file. When this isn't true, " +
+        "recipes can still run on the `SourceFile` and even produce diffs, but the diffs would fail to " +
+        "apply as a patch to the original source file. Most `Parser` use `Parser#requirePrintEqualsInput` " +
+        "to produce a `ParseError` when they fail to produce a `SourceFile` that is print idempotent.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

rewrite-core/src/main/java/org/openrewrite/text/EndOfLineAtEndOfFile.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.text;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.*;
 import org.openrewrite.binary.Binary;
@@ -25,17 +26,13 @@
 
 public class EndOfLineAtEndOfFile extends Recipe {
 
-    @Override
-    public String getDisplayName() {
-        return "End of Line @ End of File (EOL @ EOF)";
-    }
+    @Getter
+    final String displayName = "End of Line @ End of File (EOL @ EOF)";
 
-    @Override
-    public String getDescription() {
-        return "Ensure that the file ends with the newline character.\n\n" +
-                "*Note*: If this recipe modifies a file, it converts the file into plain text. " +
-                "As such, this recipe should be run after any recipe that modifies the language-specific LST.";
-    }
+    @Getter
+    final String description = "Ensure that the file ends with the newline character.\n\n" +
+        "*Note*: If this recipe modifies a file, it converts the file into plain text. " +
+        "As such, this recipe should be run after any recipe that modifies the language-specific LST.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

rewrite-core/src/main/java/org/openrewrite/text/RemoveByteOrderMark.java

@@ -15,6 +15,7 @@
  */
 package org.openrewrite.text;
 
+import lombok.Getter;
 import org.jspecify.annotations.Nullable;
 import org.openrewrite.*;
 import org.openrewrite.binary.Binary;
@@ -25,16 +26,12 @@
 
 public class RemoveByteOrderMark extends Recipe {
 
-    @Override
-    public String getDisplayName() {
-        return "Remove byte order mark (BOM)";
-    }
+    @Getter
+    final String displayName = "Remove byte order mark (BOM)";
 
-    @Override
-    public String getDescription() {
-        return "Removes UTF-8 byte order marks from the beginning of files.\n\n" +
-                "The BOM character (U+FEFF) is generally unnecessary in UTF-8 files and can cause issues with some tools.";
-    }
+    @Getter
+    final String description = "Removes UTF-8 byte order marks from the beginning of files.\n\n" +
+        "The BOM character (U+FEFF) is generally unnecessary in UTF-8 files and can cause issues with some tools.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

rewrite-core/src/test/java/org/openrewrite/RecipeLifecycleTest.java

@@ -16,6 +16,7 @@
 package org.openrewrite;
 
 import lombok.EqualsAndHashCode;
+import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Value;
 import org.intellij.lang.annotations.Language;
@@ -479,15 +480,11 @@ void declarativeRecipeChainFromResourcesLongList() {
 
 @SuppressWarnings("unused") // referenced in yaml
 class DefaultConstructorRecipe extends Recipe {
-    @Override
-    public String getDisplayName() {
-        return "DefaultConstructorRecipe";
-    }
+    @Getter
+    final String displayName = "DefaultConstructorRecipe";
 
-    @Override
-    public String getDescription() {
-        return "DefaultConstructorRecipe.";
-    }
+    @Getter
+    final String description = "DefaultConstructorRecipe.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
@@ -506,15 +503,11 @@ public PlainText visitText(PlainText text, ExecutionContext ctx) {
 @NoArgsConstructor // referenced in yaml
 @SuppressWarnings("unused")
 class NoArgRecipe extends Recipe {
-    @Override
-    public String getDisplayName() {
-        return "NoArgRecipe";
-    }
+    @Getter
+    final String displayName = "NoArgRecipe";
 
-    @Override
-    public String getDescription() {
-        return "NoArgRecipe.";
-    }
+    @Getter
+    final String description = "NoArgRecipe.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {

rewrite-core/src/test/java/org/openrewrite/RecipeSchedulerTest.java

@@ -17,6 +17,7 @@
 
 import lombok.AllArgsConstructor;
 import lombok.EqualsAndHashCode;
+import lombok.Getter;
 import lombok.Value;
 import org.jspecify.annotations.Nullable;
 import org.junit.jupiter.api.Test;
@@ -168,15 +169,11 @@ void managedWorkingDirectoryWithMultipleRecipes(@TempDir Path path) {
 
 @AllArgsConstructor
 class BoomRecipe extends Recipe {
-    @Override
-    public String getDisplayName() {
-        return "We go boom";
-    }
+    @Getter
+    final String displayName = "We go boom";
 
-    @Override
-    public String getDescription() {
-        return "Test recipe.";
-    }
+    @Getter
+    final String description = "Test recipe.";
 
     @Override
     public TreeVisitor<?, ExecutionContext> getVisitor() {
@@ -236,15 +233,11 @@ class RecipeWritingToFile extends ScanningRecipe<RecipeWritingToFile.Accumulator
 
     final int position;
 
-    @Override
-    public String getDisplayName() {
-        return "Write text to a file";
-    }
+    @Getter
+    final String displayName = "Write text to a file";
 
-    @Override
-    public String getDescription() {
-        return "Writes text to a file.";
-    }
+    @Getter
+    final String description = "Writes text to a file.";
 
     @Override
     public Accumulator getInitialValue(ExecutionContext ctx) {

rewrite-core/src/test/java/org/openrewrite/table/RecipeRunStatsTest.java

@@ -16,6 +16,7 @@
 package org.openrewrite.table;
 
 import lombok.AllArgsConstructor;
+import lombok.Getter;
 import org.junit.jupiter.api.Test;
 import org.openrewrite.*;
 import org.openrewrite.marker.SearchResult;
@@ -28,15 +29,11 @@
 
 @AllArgsConstructor
 class RecipeWithApplicabilityTest extends Recipe {
-    @Override
-    public String getDisplayName() {
-        return "Recipe with an applicability test";
-    }
+    @Getter
+    final String displayName = "Recipe with an applicability test";
 
-    @Override
-    public String getDescription() {
-        return "This recipe is a test utility which exists to exercise RecipeRunStats.";
-    }
+    @Getter
+    final String description = "This recipe is a test utility which exists to exercise RecipeRunStats.";
 
     @Option(displayName = "New text", example = "txt")
     String newText;