Skip to content

Commit

Permalink
refactor: Trim recipe descriptions
Browse files Browse the repository at this point in the history
Use this link to re-run the recipe: https://app.moderne.io/recipes/org.openrewrite.text.FindAndReplace?organizationId=T3BlblJld3JpdGU%3D

Co-authored-by: Moderne <team@moderne.io>
  • Loading branch information
timtebeek and TeamModerne committed Jul 24, 2024
1 parent 0e147e3 commit a86d28e
Show file tree
Hide file tree
Showing 16 changed files with 49 additions and 49 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.javax.AddCommonAnnotationsDependencies
displayName: Add explicit Common Annotations dependencies
description: >
description: >-
Add the necessary `annotation-api` dependency from Jakarta EE 8 to maintain compatibility with Java version 11 or greater.
tags:
- javax
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.javax.AddInjectDependencies
displayName: Add explicit Inject dependencies
description: >
description: >-
Add the necessary `inject-api` dependency from Jakarta EE 8 to maintain compatibility with Java version 11 or greater.
tags:
- javax
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/META-INF/rewrite/ibm-java.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.IBMSemeru
displayName: Migrate to IBM Semeru Runtimes
description: >
description: >-
This recipe will apply changes commonly needed when upgrading Java versions. The solutions provided in this list are
solutions only available in IBM Semeru Runtimes.
tags:
Expand All @@ -34,7 +34,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.IBMJDKtoOracleJDK
displayName: Migrate from IBM Runtimes to Oracle Runtimes
description: >
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.
tags:
Expand Down
10 changes: 5 additions & 5 deletions src/main/resources/META-INF/rewrite/jakarta-ee-10.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.ServletCookieBehaviorChangeRFC6265
displayName: Remove `getComment` and `getVersion` methods
description: >
description: >-
Jakarta Servlet methods have been deprecated for removal in Jakarta Servlet 6.0 to align with RFC 6265.
In addition, the behavior of these methods has been changed so the setters no longer have any effect, the getComment methods return null, and the getVersion method returns 0.
The deprecated methods are removed.
Expand Down Expand Up @@ -73,7 +73,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovedIsParmetersProvidedMethod
displayName: Use `isParametersProvided()`
description: >
description: >-
Expression Language prior to 5.0 provides the deprecated MethodExpression.isParmetersProvided() method, with the word 'parameter' misspelled in the method name.
This method is unavailable in Jakarta Expression Language 5.0. Use the correctly spelled MethodExpression.isParametersProvided() method instead.
recipeList:
Expand All @@ -84,7 +84,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovedSOAPElementFactory
displayName: Use `jakarta.xml.soap.SOAPFactory` to create `SOAPElements`
description: >
description: >-
XML Web Services prior to 4.0 provides the deprecated SOAPElementFactory class,
which is removed in XML Web Services 4.0. The recommended replacement is to use jakarta.xml.soap.SOAPFactory to create SOAPElements.
recipeList:
Expand Down Expand Up @@ -183,7 +183,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovalsServletJakarta10
displayName: Replace deprecated Jakarta Servlet methods and classes
description: >
description: >-
This recipe replaces the classes and methods deprecated in Jakarta Servlet 6.0
recipeList:
- org.openrewrite.java.ChangeType:
Expand Down Expand Up @@ -264,7 +264,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
description: >
description: >-
Deprecated APIs have been removed in CDI 4.0. This recipe removes and updates the corresponding deprecated methods.
recipeList:
- org.openrewrite.java.migrate.jakarta.RemoveBeanIsNullable
Expand Down
12 changes: 6 additions & 6 deletions src/main/resources/META-INF/rewrite/jakarta-ee-9.yml
Original file line number Diff line number Diff line change
Expand Up @@ -825,7 +825,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.JacksonJavaxToJakarta
displayName: Migrate Jackson from javax to jakarta namespace
description: >
description: >-
Java EE has been rebranded to Jakarta EE. This recipe replaces existing Jackson dependencies with their counterparts
that are compatible with Jakarta EE 9.
recipeList:
Expand Down Expand Up @@ -942,7 +942,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.EhcacheJavaxToJakarta
displayName: Migrate Ehcache from javax to jakarta namespace
description: >
description: >-
Java EE has been rebranded to Jakarta EE. This recipe replaces existing Ehcache dependencies with their counterparts
that are compatible with Jakarta EE 9.
recipeList:
Expand All @@ -964,7 +964,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.JohnzonJavaxToJakarta
displayName: Migrate Johnzon from javax to jakarta namespace
description: >
description: >-
Java EE has been rebranded to Jakarta EE. This recipe replaces existing Johnzon dependencies with their counterparts
that are compatible with Jakarta EE 9.
recipeList:
Expand All @@ -982,7 +982,7 @@ recipeList:
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
description: >
description: >-
Java EE has been rebranded to Jakarta EE. This recipe replaces existing RestAssured dependencies with their
counterparts that are compatible with Jakarta EE 9.
recipeList:
Expand All @@ -994,7 +994,7 @@ 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
description: >
description: >-
Java EE has been rebranded to Jakarta EE. This recipe replaces Apache security packages to migrate to Apache `wss4j`
recipeList:
- org.openrewrite.java.ChangePackage:
Expand All @@ -1009,7 +1009,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.JavaxEEApiToJakarta
displayName: Migrate deprecated `javaee-api` dependencies to `jakarta.platform`
description: >
description: >-
Java EE has been rebranded to Jakarta EE, necessitating a package relocation.
recipeList:
- org.openrewrite.java.dependencies.ChangeDependency:
Expand Down
12 changes: 6 additions & 6 deletions src/main/resources/META-INF/rewrite/jakarta-faces-4.yml
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.FacesJNDINamesChanged
displayName: JNDI name `jsf/ClientSideSecretKey` has been renamed to `faces/ClientSideSecretKey`, and the `jsf/FlashSecretKey` JNDI name has been renamed to `faces/FlashSecretKey`.
description: >
description: >-
The `jsf/ClientSideSecretKey` JNDI name has been renamed to `faces/ClientSideSecretKey`,
and the `jsf/FlashSecretKey` JNDI name has been renamed to `faces/FlashSecretKey`. The JNDI keys that have been renamed are updated to allow use of the keys.
recipeList:
Expand All @@ -276,7 +276,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovedJakartaFacesResourceResolver
displayName: Replace `ResourceResolver` with `ResourceHandler`
description: >
description: >-
The `ResourceResolver` class was removed in Jakarta Faces 4.0.
The functionality provided by that class can be replaced by using the `jakarta.faces.application.ResourceHandler` class.
recipeList:
Expand All @@ -292,7 +292,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovedUIComponentConstant
displayName: Replace `CURRENT_COMPONENT` and `CURRENT_COMPOSITE_COMPONENT` with `getCurrentComponent()` and `getCurrentCompositeComponent()`
description: >
description: >-
Replace `jakarta.faces.component.UIComponent.CURRENT_COMPONENT` and `CURRENT_COMPOSITE_COMPONENT` constants with `jakarta.faces.component.UIComponent.getCurrentComponent()` and `getCurrentCompositeComponent()`
that were added in JSF 2.0
recipeList:
Expand All @@ -306,7 +306,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovedStateManagerMethods
displayName: Use `StateManagementStrategy`
description: >
description: >-
Methods that were removed from the `jakarta.faces.application.StateManager` and `javax.faces.application.StateManager` classes in Jakarta Faces 4.0 are replaced
by `jakarta.faces.view.StateManagementStrategy` or `javax.faces.view.StateManagementStrategy` based on Jakarta10 migration in Faces 4.0
recipeList:
Expand Down Expand Up @@ -342,7 +342,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovedJakartaFacesExpressionLanguageClasses
displayName: Use `jakarta.el` instead of `jakarta.faces.el` and `javax.faces.el`
description: >
description: >-
Several classes were removed and replaced in Jakarta Faces 4.0.
The only Object definition not removed in the `jakarta.faces.el` package is the CompositeComponentExpressionHolder interface.
recipeList:
Expand Down Expand Up @@ -414,7 +414,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.FacesManagedBeansRemoved
displayName: Substitute deprecated Faces Managed Beans
description: >
description: >-
This recipe substitutes Faces Managed Beans, which were deprecated in JavaServer Faces 2.3 and have been removed from Jakarta Faces 4.0.
recipeList:
- org.openrewrite.java.ChangeType:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.concurrent.JavaConcurrentAPIs
displayName: Use modernized `java.util.concurrent` APIs
description: >
description: >-
The Java concurrent APIs were updated in Java 9 and those changes resulted in certain APIs being deprecated. This
recipe update an application to replace the deprecated APIs with their modern alternatives.
recipeList:
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-ee-7.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.javaee7.OpenJPAPersistenceProvider
displayName: Removed OpenJPA providers in the persistence.xml file
description: >
description: >-
When migrating to EclipseLink, using OpenJPA providers in EclipseLink results in runtime errors. To resolve these errors,
the recipe removes the flagged OpenJPA provider from the persistence.xml.
recipeList:
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-ee-8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.javaee8.ApacheDefaultProvider
displayName: Flags any `org.apache.bval.jsr*` (bval 1.1) and `org.apache.bval.jsr303*` (bval 1.0) package references
description: >
description: >-
This recipe flags any `org.apache.bval.jsr*` (bval 1.1) and `org.apache.bval.jsr303*` (bval 1.0) package references in validation.xml deployment descriptors.
Bean Validation 2.0 and later use the Hibernate Validator implementation instead of the
Apache BVal implementation which was used for Bean Validation 1.0 and 1.1
Expand Down
6 changes: 3 additions & 3 deletions src/main/resources/META-INF/rewrite/java-version-11.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.Java8toJava11
displayName: Migrate to Java 11
description: >
description: >-
This recipe will apply changes commonly needed when upgrading to Java 11. Specifically, for those applications that
are built on Java 8, this recipe will update and add dependencies on J2EE libraries that are no longer directly
bundled with the JDK. This recipe will also replace deprecated API with equivalents when there is a clear migration
Expand Down Expand Up @@ -98,7 +98,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.javax.AddJaxbDependencies
displayName: Add explicit JAXB dependencies
description: >
description: >-
This recipe will add explicit dependencies for Jakarta EE 8 when a Java 8 application is using JAXB. Any existing
dependencies will be upgraded to the latest version of Jakarta EE 8. The artifacts are moved to Jakarta EE 8 version 2.x
which allows for the continued use of the `javax.xml.bind` namespace. Running a full javax to Jakarta migration
Expand Down Expand Up @@ -167,7 +167,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.javax.AddJaxwsDependencies
displayName: Add explicit JAX-WS dependencies
description: >
description: >-
This recipe will add explicit dependencies for Jakarta EE 8 when a Java 8 application is using JAX-WS. Any existing
dependencies will be upgraded to the latest version of Jakarta EE 8. The artifacts are moved to Jakarta EE 8 but the
application can continue to use the `javax.xml.bind` namespace.
Expand Down
18 changes: 9 additions & 9 deletions src/main/resources/META-INF/rewrite/java-version-17.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeToJava17
displayName: Migrate to Java 17
description: >
description: >-
This recipe will apply changes commonly needed when migrating to Java 17. Specifically, for those
applications that are built on Java 8, this recipe will update and add dependencies on J2EE libraries that are no
longer directly bundled with the JDK. This recipe will also replace deprecated API with equivalents when there is a
Expand Down Expand Up @@ -143,7 +143,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.RemovedZipFinalizeMethods
displayName: Replace `finalize` method in `java.util.zip.ZipFile`, `java.util.zip.Inflater` and `java.util.zip.Deflater`
description: >
description: >-
The `finalize` method in `java.util.zip.ZipFile` is replaced with the `close` method and is replaced by the `end` method in
`java.util.zip.Inflater` and `java.util.zip.Deflater` as it is no longer available in Java SE 12 and later.
tags:
Expand All @@ -165,7 +165,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.RemovedSSLSessionGetPeerCertificateChainMethodImpl
displayName: Replace `SSLSession.getPeerCertificateChain()` method
description: >
description: >-
The `javax.net.ssl.SSLSession.getPeerCertificateChain()` method implementation was removed from the SunJSSE provider and HTTP client implementation in Java SE 15.
The default implementation will now throw an `UnsupportedOperationException`.
Applications using this method should be updated to use the `javax.net.ssl.SSLSession.getPeerCertificates()` method instead.
Expand All @@ -180,7 +180,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.SunNetSslPackageUnavailable
displayName: Replace `com.sun.net.ssl` package
description: >
description: >-
The internal API `com.sun.net.ssl` is removed. The package was intended for internal use only and replacement APIs can be found in the `javax.net.ssl` package.
tags:
- java17
Expand All @@ -192,7 +192,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.RemovedRMIConnectorServerCredentialTypesConstant
displayName: Replace `RMIConnectorServer.CREDENTIAL_TYPES` constant
description: >
description: >-
This recipe replaces the `RMIConnectorServer.CREDENTIAL_TYPES` constant with the `RMIConnectorServer.CREDENTIALS_FILTER_PATTERN` constant.
tags:
- java17
Expand All @@ -204,7 +204,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.DeprecatedCountStackFramesMethod
displayName: Remove `Thread.countStackFrames()` method
description: >
description: >-
`Thread.countStackFrames()` has been removed in Java SE 14 and has been changed in this release to unconditionally throw `UnsupportedOperationException`
This recipe removes the usage of this method in your application as long as the method is not assigned to a variable.
For more information on the Java SE 14 deprecation of this method, see https://bugs.java.com/bugdatabase/view_bug?bug_id=8205132.
Expand All @@ -217,7 +217,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.RemovedFileIOFinalizeMethods
displayName: Replace `finalize` method in `java.io.FileInputStream` and `java.io.FileOutputStream`
description: >
description: >-
The `finalize` method in `java.io.FileInputStream` and `java.io.FileOutputStream` is no longer available in Java SE 12 and later. The recipe replaces it with the `close` method.
tags:
- java17
Expand All @@ -234,7 +234,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.RemovedToolProviderConstructor
displayName: Change `javax.tools.ToolProvider` methods calls to static
description: >
description: >-
The `javax.tools.ToolProvider()` constructor has been removed in Java SE 16 since the class only contains static methods.
The recipe converts `javax.tools.ToolProvider getSystemJavaCompiler()`, `javax.tools.ToolProvider getSystemDocumentationTool()` and `javax.tools.ToolProvider getSystemToolClassLoader()` to static methods.
recipeList:
Expand All @@ -245,7 +245,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.RemovedModifierAndConstantBootstrapsConstructors
displayName: Change `java.lang.reflect.Modifier` and ` java.lang.invoke.ConstantBootstraps` method calls to static
description: >
description: >-
The `java.lang.reflect.Modifier()` and `java.lang.invoke.ConstantBootstraps()` constructors have been removed in Java SE 15 because both classes only contain static methods.
This recipe converts the usage of all methods in the two classes to be static.
For more information on these changes, see https://docs.oracle.com/en/java/javase/15/migrate/index.html#GUID-233853B8-0782-429E-BEF7-7532EE610E63
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-version-21.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeToJava21
displayName: Migrate to Java 21
description: >
description: >-
This recipe will apply changes commonly needed when migrating to Java 21. This recipe will also replace deprecated API
with equivalents when there is a clear migration strategy. Build files will also be updated to use Java 21 as the
target/source and plugins will be also be upgraded to versions that are compatible with Java 21.
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-version-6.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeToJava6
displayName: Migrate to Java 6
description: >
description: >-
This recipe will apply changes commonly needed when upgrading to Java 6. This recipe will also replace deprecated API
with equivalents when there is a clear migration strategy.
tags:
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-version-7.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeToJava7
displayName: Migrate to Java 7
description: >
description: >-
This recipe will apply changes commonly needed when upgrading to Java 7. This recipe will also replace deprecated API
with equivalents when there is a clear migration strategy.
tags:
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-version-8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.UpgradeToJava8
displayName: Migrate to Java 8
description: >
description: >-
This recipe will apply changes commonly needed when upgrading to Java 8. This recipe will also replace deprecated API
with equivalents when there is a clear migration strategy.
tags:
Expand Down
Loading

0 comments on commit a86d28e

Please sign in to comment.