Repository navigation
Polish YAML recipe display names and descriptions (K8 of #1330) - #1360
Merged
Merged
Conversation
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.
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.
…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.
22 of 72 tasks
…ames-v1 # Conflicts: # src/main/resources/META-INF/rewrite/recipes.csv
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses K8 of #1330.
The YAML recipe display names and descriptions are what users see on docs.openrewrite.org and in the Moderne platform, and a sweep of all files under
META-INF/rewriteturned up title case, typos, and descriptions that either repeated the display name, pointed at another recipe, or described something the recipe does not do. This PR changes text only; no recipe names or recipe lists change.Sentence case. About 40 display names, including "Lombok best practices", "Find virtual thread opportunities", "Migrate OmniFaces namespaces", "Update plugins for Jakarta EE 9/10/11", every "… dependencies to x" title in the Jakarta EE, Faces and Java EE 8 files, "Migrate to Java EE 6/7/8" and "Update Jetty 9 to Jetty 12". Proper nouns (Jakarta EE, OmniFaces, Jetty, EclipseLink, …) keep their casing. While there: "Migrate JAXB-WS Plugin" becomes "Migrate the JAX-WS Maven plugin", since it moves
jaxws-maven-plugin. The three Java 25 security recipes now say which calls they remove. A JNDI display name that was written as a full sentence is now an imperative title.Typos. "Jakata", "API's"/"CDI4.0", "search fro", "J2EE9", "Websphere", "EcmaScript", double spaces, the stray backtick in
RemovedSubjectMethods, and the unclosed backtick inUseVar. It also fixes over-indented continuation lines inRemovedZipFinalizeMethodsandDeprecatedCountStackFramesMethod: YAML folds those into literal line breaks in the description.Descriptions.
ApacheDefaultProvidersaid it "flags", but it rewritesvalidation.xmlto Hibernate Validator.JakartaEE10/JakartaEE11andjavaee6/7/8said they were "flagging".OpenJPAPersistenceProvidersaid "removes", but it replaces the provider.MigrateZipErrorToZipExceptionsaid Java 9, but the recipe only runs on Java 25.AddJaxwsDependenciesmentionedjavax.xml.bindinstead ofjavax.xml.ws.NoGuavaJava11/NoGuavaJava21had copy-pasted text.NoGuavaSetsNewConcurrentHashSetdisplay name saidnew ConcurrentHashMap<>().UseVar,AddLombokMapstructBindingMavenDependencyOnly,UpgradeBuildToJava24ForKotlin1x,AddAspectJToolsToAspectJMavenPlugin) with what the recipe itself does.Update*dependency recipes in the Jakarta and Faces files,MigrateToServlet3x,UpdateRestLet2_6, and theMigrateFrom*recipes injspecify.yml. Each now summarizes its recipe list.Renames not done.
openJPAToEclipseLink,javaee6/7/8andBounceCastleFromJdk15OntoJdk18Onkeep their names. This repo has no established pattern for a renamed recipe that keeps its old name as a deprecated alias. The only precedent isUpdateJakartaAnnotations2, an empty placeholder for a recipe that was inlined into its parent. Thedeprecatedtag is also used elsewhere to mean "migrates deprecated APIs" (e.g. onjavaee6/7/8themselves), so tagging aliases with it would be ambiguous. That needs a maintainer decision.Verified with
./gradlew rCG, which regeneratedrecipes.csv(committed separately), and./gradlew compileJava processResources testpassed (2297 tests, 0 failures, 63 skipped). A YAML check over every recipe inMETA-INF/rewriteconfirmed that no display name ends with a period, every description ends with one, backticks are balanced, and no description equals its display name.