Polish YAML recipe display names and descriptions (K8 of #1330) (#1360)

* Use sentence case for YAML recipe display names

Lowercase common nouns such as "Dependencies", "Plugins" and "Namespace" while keeping proper nouns like Jakarta EE, OmniFaces and Jetty, spell out "Java EE 6" and "Jetty 9", and put coordinates and package names in backticks.

* Fix typos and stray spacing in YAML recipe names and descriptions

Among others "Jakata", "API's", "search fro", double spaces, a stray and an unclosed backtick, and continuation lines that YAML folded into literal line breaks.

* Describe what YAML recipes do instead of repeating names or pointing elsewhere

Correct descriptions that did not match the recipe list, such as `ApacheDefaultProvider` and the Java EE and Jakarta EE composites that claimed to flag, `AddJaxwsDependencies` mentioning `javax.xml.bind`, `MigrateZipErrorToZipException` gated on Java 25, and the copy-pasted `NoGuavaJava11`/`NoGuavaJava21` text. Replace descriptions that only repeated the display name or referred to another recipe with a summary of the changes made.

* Regenerate `recipes.csv`

Author: timtebeek

src/main/resources/META-INF/rewrite/ibm-java.yml

@@ -36,7 +36,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.IBMJDKtoOracleJDK
-displayName: Migrate from IBM Runtimes to Oracle Runtimes
+displayName: Migrate from IBM runtimes to Oracle runtimes
 description: >-
   This recipe will apply changes commonly needed when upgrading Java versions. The solutions provided in this list are
   solutions necessary for migrating from IBM Runtimes to Oracle Runtimes.
@@ -132,7 +132,7 @@ type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.RemovedJavaXMLWSModuleProvided
 displayName: Do not package `java.xml.ws` module in WebSphere Liberty applications
 description:
-  The `java.xml.ws` module was removed in Java11. Websphere Liberty provides its own implementation of the module, which can be used by specifying the `jaxws-2.2` feature in the server.xml file.
+  The `java.xml.ws` module was removed in Java 11. WebSphere Liberty provides its own implementation of the module, which can be used by specifying the `jaxws-2.2` feature in the server.xml file.
   This recipe updates the `javax.xml.ws` dependency to use the `provided` scope to avoid class loading issues.
 tags:
   - java11
@@ -152,8 +152,8 @@ type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.RemovedJaxBModuleProvided
 displayName: Do not package `java.xml.bind` and `java.activation` modules in WebSphere Liberty applications
 description:
-  The `java.xml.bind` and `java.activation` modules were removed in Java11.
-  Websphere Liberty provides its own implementation of the modules, which can be used by specifying the `jaxb-2.2` feature in the server.xml file.
+  The `java.xml.bind` and `java.activation` modules were removed in Java 11.
+  WebSphere Liberty provides its own implementation of the modules, which can be used by specifying the `jaxb-2.2` feature in the server.xml file.
   This recipe updates the `javax.xml.bind` and `javax.activation` dependencies to use the `provided` scope to avoid class loading issues.
 tags:
   - java11

src/main/resources/META-INF/rewrite/inline-guava-33-methods.yml

@@ -21,7 +21,7 @@
 
 type: specs.openrewrite.org/v1beta/recipe
 name: com.google.guava.InlineGuavaMethods
-displayName: Inline `guava` methods annotated with `@InlineMe`
+displayName: Inline Guava methods annotated with `@InlineMe`
 description: >-
   Automatically generated recipes to inline method calls based on `@InlineMe` annotations
   discovered in the type table.

src/main/resources/META-INF/rewrite/intellij-annotations-to-jetbrains-annotations.yml

@@ -17,7 +17,7 @@
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.ComIntelliJAnnotationsToOrgJetbrainsAnnotations
-displayName: Migrate com.intellij:annotations to org.jetbrains:annotations
+displayName: Migrate `com.intellij:annotations` to `org.jetbrains:annotations`
 description: >-
   This recipe will upgrade old dependency of com.intellij:annotations to the newer org.jetbrains:annotations.
 tags:

src/main/resources/META-INF/rewrite/jakarta-ee-10.yml

@@ -18,7 +18,10 @@
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JakartaEE10
 displayName: Migrate to Jakarta EE 10
-description: These recipes help with the Migration to Jakarta EE 10, flagging and updating deprecated methods.
+description: >-
+  Migrate to Jakarta EE 10 from Java EE 8 or Jakarta EE 9. Moves `javax` packages to `jakarta`, upgrades the Jakarta EE
+  APIs, implementations and Maven plugins to their Jakarta EE 10 versions, and replaces APIs that were deprecated or removed
+  in Jakarta EE 10.
 tags:
   - jakarta
 preconditions:
@@ -57,8 +60,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.MigrationToJakarta10Apis
-displayName: Migrate Jakarta EE 9 api dependencies to Jakarta EE 10 versions
-description: Jakarta EE 10 updates some apis compared to Jakarta EE 9.
+displayName: Migrate Jakarta EE 9 API dependencies to Jakarta EE 10 versions
+description: Upgrade the Jakarta EE 9 API dependencies to their Jakarta EE 10 versions.
 tags:
   - jakarta
 preconditions:
@@ -161,8 +164,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name:  org.openrewrite.java.migrate.jakarta.UpdateFileupload2Dependencies
-displayName: Update Apache Commons FileUpload2 package for EE10
-description: Update Apache Commons FileUpload2 package for EE10.
+displayName: Update Apache Commons FileUpload2 package for Jakarta EE 10
+description: Replace the `commons-fileupload2-jakarta-servlet5` artifact and package with their `servlet6` counterparts, which target Jakarta Servlet 6.0.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -271,7 +274,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JavaxEjbJarXmlToJakartaEjbJarXml
-displayName: Migrate xmlns entries and javax. packages in `ejb-jar.xml` files
+displayName: Migrate xmlns entries and `javax` packages in `ejb-jar.xml` files
 description: Java EE has been rebranded to Jakarta EE, necessitating an XML namespace relocation.
 tags:
   - jakarta
@@ -300,7 +303,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JavaxBeanValidationXmlToJakartaBeanValidationXml
-displayName: Migrate xmlns entries and javax. packages in `validation.xml` files
+displayName: Migrate xmlns entries and `javax` packages in `validation.xml` files
 description: Java EE has been rebranded to Jakarta EE, necessitating an XML namespace relocation.
 tags:
   - jakarta
@@ -330,7 +333,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.RemovalsServletJakarta10
-displayName: Replace  deprecated Jakarta Servlet methods and classes
+displayName: Replace deprecated Jakarta Servlet methods and classes
 description: >-
   This recipe replaces the classes and methods deprecated in Jakarta Servlet 6.0.
 preconditions:
@@ -392,7 +395,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.DeprecatedCDIAPIsRemoved40
-displayName: Remove deprecated API's not supported in CDI4.0
+displayName: Remove deprecated APIs not supported in CDI 4.0
 description: >-
   Deprecated APIs have been removed in CDI 4.0. This recipe removes and updates the corresponding deprecated methods.
 preconditions:
@@ -404,7 +407,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JavaxToJakartaCdiExtensions
-displayName: Rename CDI Extension to Jakarta
+displayName: Rename CDI extension service files to Jakarta
 description: Rename `javax.enterprise.inject.spi.Extension` to `jakarta.enterprise.inject.spi.Extension`.
 preconditions:
   - org.openrewrite.Singleton
@@ -415,8 +418,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateJakartaPlatform10
-displayName: Update Jakarta EE Platform Dependencies to 10.0.0
-description: Update Jakarta EE Platform Dependencies to 10.0.0.
+displayName: Update Jakarta EE platform dependencies to 10.0.0
+description: Upgrade the `jakarta.platform` dependencies to 10.0.0.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -427,8 +430,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateJakartaAnnotations2
-displayName: Update Jakarta EE annotation Dependencies to 2.1.x
-description: Update Jakarta EE annotation Dependencies to 2.1.x.
+displayName: Update Jakarta EE annotation dependencies to 2.1.x
+description: Deprecated and does nothing, as the `jakarta.annotation-api` upgrade to 2.1.x is now part of the Jakarta EE 10 API migration.
 tags:
   # This recipe has been inlined into `MigrationToJakarta10Apis`; drop the reference to this recipe,
   # This placeholder is kept to avoid breaking existing recipes that reference this recipe still.
@@ -439,8 +442,10 @@ recipeList: []
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateJakartaXmlWsEE10
-displayName: Update Jakarta EE XML Web Services Dependencies for EE 10
-description: Update Jakarta EE XML Web Services Dependencies for EE 10.
+displayName: Update Jakarta XML Web Services dependencies for Jakarta EE 10
+description: >-
+  Upgrade the Jakarta XML Binding, SOAP and XML Web Services APIs and the `jaxws-rt` implementation to their Jakarta EE 10
+  versions, replacing the retired `jakarta.jws-api` artifact with `jakarta.xml.ws-api`.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -491,8 +496,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateJerseyDependencies
-displayName: Update GlassFish Jersey Dependencies to 3.1.x
-description: Update GlassFish Jersey Dependencies to 3.1.x.
+displayName: Update GlassFish Jersey dependencies to 3.1.x
+description: Upgrade the GlassFish Jersey dependencies to 3.1.x, and Tyrus to 2.1.x.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -528,7 +533,7 @@ recipeList:
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateApacheCommonsEmailDependencies
 displayName: Update Apache Commons Email to Email2 for Jakarta
-description: Update Apache Commons Email to Email2 for Jakarta.
+description: Replace `commons-email` with `commons-email2-jakarta` 2.0.x, and move the `org.apache.commons.mail` types to their Email2 packages.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -554,8 +559,10 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateApacheShiroDependencies
-displayName: Update Apache Shiro Dependencies to 2.0.x
-description: Update Apache Shiro Dependencies to 2.0.x.
+displayName: Update Apache Shiro dependencies to 2.0.x
+description: >-
+  Upgrade Apache Shiro to the 2.0.x `jakarta` classifier artifacts and move the relocated codec and utility types,
+  and upgrade `buji-pac4j` and pac4j to their Jakarta EE versions.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -603,8 +610,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateEclipseLinkDependencies
-displayName: Update EclipseLink Dependencies to 4.x
-description: Update EclipseLink Dependencies to 4.x.
+displayName: Update EclipseLink dependencies to 4.x
+description: Upgrade the `org.eclipse.persistence` dependencies to EclipseLink 4.x, which implements Jakarta Persistence 3.1.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -615,8 +622,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateYassonDependencies
-displayName: Update Eclipse Yasson Dependencies to 3.0.x
-description: Update Eclipse Yasson Dependencies to 3.0.x.
+displayName: Update Eclipse Yasson dependencies to 3.0.x
+description: Upgrade the `org.eclipse:yasson` dependency to 3.0.x, which implements Jakarta JSON Binding 3.0.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -773,8 +780,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.MigratePluginsForJakarta10
-displayName: Update Plugins for Jakarta EE 10
-description: Update plugin to be compatible with Jakarta EE 10.
+displayName: Update plugins for Jakarta EE 10
+description: Update plugins to be compatible with Jakarta EE 10.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:

src/main/resources/META-INF/rewrite/jakarta-ee-11.yml

@@ -18,7 +18,9 @@
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JakartaEE11
 displayName: Migrate to Jakarta EE 11
-description: These recipes help with the Migration to Jakarta EE 11, flagging and updating deprecated methods.
+description: >-
+  Migrate to Jakarta EE 11 by applying the Jakarta EE 10 migration, and then upgrading the Jakarta EE platform,
+  Jakarta Faces and Maven plugins to their Jakarta EE 11 versions.
 tags:
   - jakarta
 preconditions:
@@ -31,8 +33,8 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateJakartaPlatform11
-displayName: Update Jakarta EE Platform Dependencies to 11.0.x
-description: Update Jakarta EE Platform Dependencies to 11.0.x.
+displayName: Update Jakarta EE platform dependencies to 11.0.x
+description: Upgrade the `jakarta.platform` dependencies to 11.0.x, along with the Jakarta Annotations and Jakarta Server Pages APIs.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -51,7 +53,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.MigratePluginsForJakarta11
-displayName: Update Plugins for Jakarta EE 11
+displayName: Update plugins for Jakarta EE 11
 description: Update plugins to be compatible with Jakarta EE 11.
 preconditions:
   - org.openrewrite.Singleton

src/main/resources/META-INF/rewrite/jakarta-ee-9.yml

@@ -1091,7 +1091,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JavaxXmlToJakartaXmlXJCBinding
-displayName: Migrate XJC Bindings to Jakata XML
+displayName: Migrate XJC bindings to Jakarta XML
 description: Java EE has been rebranded to Jakarta EE, migrates the namespace and version in XJC bindings.
 tags:
   - jaxb
@@ -1256,7 +1256,7 @@ type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JacksonJavaxToJakarta
 displayName: Migrate Jackson from javax to jakarta namespace
 description: >-
-  Java EE has been rebranded to Jakarta EE.  This recipe replaces existing Jackson dependencies with their counterparts
+  Java EE has been rebranded to Jakarta EE. This recipe replaces existing Jackson dependencies with their counterparts
   that are compatible with Jakarta EE 9.
 preconditions:
   - org.openrewrite.Singleton
@@ -1387,7 +1387,7 @@ type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.EhcacheJavaxToJakarta
 displayName: Migrate Ehcache from javax to jakarta namespace
 description: >-
-  Java EE has been rebranded to Jakarta EE.  This recipe replaces existing Ehcache dependencies with their counterparts
+  Java EE has been rebranded to Jakarta EE. This recipe replaces existing Ehcache dependencies with their counterparts
   that are compatible with Jakarta EE 9.
 preconditions:
   - org.openrewrite.Singleton
@@ -1418,7 +1418,7 @@ type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JohnzonJavaxToJakarta
 displayName: Migrate Johnzon from javax to jakarta namespace
 description: >-
-  Java EE has been rebranded to Jakarta EE.  This recipe replaces existing Johnzon dependencies with their counterparts
+  Java EE has been rebranded to Jakarta EE. This recipe replaces existing Johnzon dependencies with their counterparts
   that are compatible with Jakarta EE 9.
 preconditions:
   - org.openrewrite.Singleton
@@ -1438,9 +1438,9 @@ recipeList:
 # breaking changes to the Rest Assured API that need to be addressed.
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.RestAssuredJavaxToJakarta
-displayName: Migrate RestAssured from javax to jakarta namespace by upgrading to a version compatible with J2EE9
+displayName: Migrate RestAssured from javax to jakarta namespace by upgrading to a version compatible with Jakarta EE 9
 description: >-
-  Java EE has been rebranded to Jakarta EE.  This recipe replaces existing RestAssured dependencies with their
+  Java EE has been rebranded to Jakarta EE. This recipe replaces existing RestAssured dependencies with their
   counterparts that are compatible with Jakarta EE 9.
 preconditions:
   - org.openrewrite.Singleton
@@ -1452,9 +1452,9 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateApacheWSSecurityPackages
-displayName: Migrate `org.apache.ws.security` and `org.apache.ws.security.components.crypto` packages to  `org.apache.wss4j.common.ext` and `org.apache.wss4j.common.crypto` packages
+displayName: Migrate `org.apache.ws.security` and `org.apache.ws.security.components.crypto` packages to `org.apache.wss4j.common.ext` and `org.apache.wss4j.common.crypto` packages
 description: >-
-  Java EE has been rebranded to Jakarta EE.  This recipe replaces Apache security packages to migrate to Apache `wss4j`.
+  Java EE has been rebranded to Jakarta EE. This recipe replaces Apache security packages to migrate to Apache `wss4j`.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -1564,7 +1564,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.JettyUpgradeEE9
-displayName: Update Jetty9 to Jetty12
+displayName: Update Jetty 9 to Jetty 12
 description: Update Jetty dependencies from version 9 to version 12.
 preconditions:
   - org.openrewrite.Singleton
@@ -1685,8 +1685,10 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.UpdateRestLet2_6
-displayName: Update RestLet to 2.6.0
-description: Update RestLet to 2.6.0.
+displayName: Update Restlet to 2.6.x
+description: >-
+  Upgrade Restlet dependencies to 2.6.x, moving the `org.restlet.jee` artifacts to the `org.restlet` group and removing
+  the `org.restlet.ext.httpclient` extension.
 preconditions:
   - org.openrewrite.Singleton
 recipeList:
@@ -1705,7 +1707,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.MigratePluginsForJakarta9
-displayName: Update Plugins for Jakarta EE 9
+displayName: Update plugins for Jakarta EE 9
 description: Update plugins to be compatible with Jakarta EE 9.
 preconditions:
   - org.openrewrite.Singleton
@@ -1805,7 +1807,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.AddJakartaElDependency
-displayName: Add the Jakarta El API when needed
+displayName: Add the Jakarta EL API when needed
 description: Add the migrated API without promoting an explicitly provided or compile-only dependency.
 preconditions:
   - org.openrewrite.java.migrate.jakarta.DoesNotHaveProvidedApiDependency:
@@ -1824,7 +1826,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.AddJakartaEjbDependency
-displayName: Add the Jakarta Ejb API when needed
+displayName: Add the Jakarta EJB API when needed
 description: Add the migrated API without promoting an explicitly provided or compile-only dependency.
 preconditions:
   - org.openrewrite.java.migrate.jakarta.DoesNotHaveProvidedApiDependency:
@@ -1868,7 +1870,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.AddJakartaInjectDependency
-displayName: Add the jakarta.inject API when needed
+displayName: Add the `jakarta.inject` API when needed
 description: Add a standalone API only when no explicitly provided API or full platform already supplies it.
 preconditions:
   - org.openrewrite.java.migrate.jakarta.DoesNotHaveProvidedApiDependency:
@@ -1889,7 +1891,7 @@ recipeList:
 ---
 type: specs.openrewrite.org/v1beta/recipe
 name: org.openrewrite.java.migrate.jakarta.AddJakartaRestDependency
-displayName: Add the jakarta.ws.rs API when needed
+displayName: Add the `jakarta.ws.rs` API when needed
 description: Add a standalone API only when no explicitly provided API or full platform already supplies it.
 preconditions:
   - org.openrewrite.java.migrate.jakarta.DoesNotHaveProvidedApiDependency: