Skip to content

Commit

Permalink
Recipe descriptions should consistently end in a dot
Browse files Browse the repository at this point in the history
  • Loading branch information
timtebeek committed Jul 24, 2024
1 parent a86d28e commit f3973c5
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 14 deletions.
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/jakarta-ee-10.yml
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.jakarta.RemovalsServletJakarta10
displayName: Replace deprecated Jakarta Servlet methods and classes
description: >-
This recipe replaces the classes and methods deprecated in Jakarta Servlet 6.0
This recipe replaces the classes and methods deprecated in Jakarta Servlet 6.0.
recipeList:
- org.openrewrite.java.ChangeType:
oldFullyQualifiedTypeName: javax.servlet.http.HttpServletRequest
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/jakarta-ee-9.yml
Original file line number Diff line number Diff line change
Expand Up @@ -995,7 +995,7 @@ 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: >-
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`.
recipeList:
- org.openrewrite.java.ChangePackage:
oldPackageName: org.apache.ws.security
Expand Down
13 changes: 8 additions & 5 deletions src/main/resources/META-INF/rewrite/jakarta-faces-4.yml
Original file line number Diff line number Diff line change
Expand Up @@ -259,10 +259,13 @@ 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`.
displayName: >-
JNDI name `jsf/ClientSideSecretKey` has been renamed to `faces/ClientSideSecretKey`,
and the `jsf/FlashSecretKey` JNDI name has been renamed to `faces/FlashSecretKey`
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.
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:
- org.openrewrite.xml.ChangeTagValue:
elementName: //env-entry-name
Expand Down Expand Up @@ -293,8 +296,8 @@ 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: >-
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
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:
- org.openrewrite.java.ReplaceConstantWithAnotherConstant:
existingFullyQualifiedConstantName: jakarta.faces.component.UIComponent.CURRENT_COMPONENT
Expand All @@ -308,7 +311,7 @@ name: org.openrewrite.java.migrate.jakarta.RemovedStateManagerMethods
displayName: Use `StateManagementStrategy`
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
by `jakarta.faces.view.StateManagementStrategy` or `javax.faces.view.StateManagementStrategy` based on Jakarta10 migration in Faces 4.0.
recipeList:
- org.openrewrite.java.ChangeMethodName:
methodPattern: "*.faces.application.StateManager getComponentStateToSave(*.faces.context.FacesContext)"
Expand Down
4 changes: 2 additions & 2 deletions src/main/resources/META-INF/rewrite/java-concurrent-apis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.concurrent.JavaConcurrentAPIs
displayName: Use modernized `java.util.concurrent` APIs
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.
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:
- org.openrewrite.java.migrate.concurrent.MigrateAtomicBooleanWeakCompareAndSetToWeakCompareAndSetPlain
- org.openrewrite.java.migrate.concurrent.MigrateAtomicIntegerWeakCompareAndSetToWeakCompareAndSetPlain
Expand Down
6 changes: 3 additions & 3 deletions src/main/resources/META-INF/rewrite/java-ee-8.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ recipeList:
---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.javaee8.ServletIsRequestedSessionIdFromURL
displayName: Replace `HttpServletRequestWrapper.isRequestedSessionIdFromUrl()` with `HttpServletRequestWrapper.isRequestedSessionIdFromURL()`
description: The method `HttpServletRequestWrapper.isRequestedSessionIdFromUrl()` is deprecated in JavaEE8 and is replaced by `HttpServletRequestWrapper.isRequestedSessionIdFromURL()`
displayName: Replace `HttpServletRequestWrapper.isRequestedSessionIdFromUrl()` with `isRequestedSessionIdFromURL()`
description: The method `HttpServletRequestWrapper.isRequestedSessionIdFromUrl()` is deprecated in JavaEE8 and is replaced by `HttpServletRequestWrapper.isRequestedSessionIdFromURL()`.
recipeList:
- org.openrewrite.java.ChangeMethodName:
methodPattern: javax.servlet.http.HttpServletRequestWrapper isRequestedSessionIdFromUrl()
Expand All @@ -43,7 +43,7 @@ displayName: Flags any `org.apache.bval.jsr*` (bval 1.1) and `org.apache.bval.js
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
Apache BVal implementation which was used for Bean Validation 1.0 and 1.1.
recipeList:
- org.openrewrite.xml.ChangeTagValue:
elementName: /validation-config/default-provider
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-version-11.yml
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@ recipeList:
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.migrate.ThreadStopDestroy
displayName: Remove `Thread.destroy()` and `Thread.stop(Throwable)`
description: |
description: >-
The `java.lang.Thread.destroy()` method was never implemented, and the `java.lang.Thread.stop(java.lang.Throwable)`
method has been unusable since Java SE 8. This recipe removes any usage of these methods from your application.
tags:
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/META-INF/rewrite/java-version-17.yml
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ displayName: Change `java.lang.reflect.Modifier` and ` java.lang.invoke.Constant
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
See https://docs.oracle.com/en/java/javase/15/migrate/index.html#GUID-233853B8-0782-429E-BEF7-7532EE610E63 for more information on these changes.
recipeList:
- org.openrewrite.java.ChangeMethodTargetToStatic:
methodPattern: java.lang.reflect.Modifier *(..)
Expand Down

0 comments on commit f3973c5

Please sign in to comment.