Recipes to migrate from Javax, Jakarta and JetBrains nullability anno…

…tations to JSpecify (#541)

* add jspecify recipe

* Update src/test/java/org/openrewrite/java/migrate/jspecify/MigrateToJspecifyTest.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/test/java/org/openrewrite/java/migrate/jspecify/MigrateToJspecifyTest.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/test/java/org/openrewrite/java/migrate/jspecify/MigrateToJspecifyTest.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/test/java/org/openrewrite/java/migrate/jspecify/MigrateToJspecifyTest.java

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* fix AddCommonAnnotationsDependenciesTest

* Upgrade test version of jakarta.annotation-api

* Switch to `dependsOn` for AddCommonAnnotationsDependenciesTest

* validate jspecify annotations

* jspecify onlyIfUsing

* jspecify onlyIfUsing pattern

* update recipe descriptions

* add MigrateFromJetbrainsAnnotations

* jspecify -> JSpecify

* Scan for the old annotations when adding jspecify dependency

* Suppress warnings inside text blocks

* Use common capitalization on displayName and description

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Tim te Beek <tim@moderne.io>

build.gradle.kts

@@ -53,6 +53,7 @@ dependencies {
     testRuntimeOnly("com.fasterxml.jackson.core:jackson-core")
     testRuntimeOnly("com.fasterxml.jackson.core:jackson-databind")
     testRuntimeOnly("org.codehaus.groovy:groovy:latest.release")
-    testRuntimeOnly("jakarta.annotation:jakarta.annotation-api:1.3.5")
+    testRuntimeOnly("jakarta.annotation:jakarta.annotation-api:2.1.1")
+    testRuntimeOnly("com.google.code.findbugs:jsr305:3.0.2")
     testRuntimeOnly(gradleApi())
 }

src/main/resources/META-INF/rewrite/jspecify.yml

@@ -0,0 +1,92 @@
+#
+# Copyright 2024 the original author or authors.
+# <p>
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# <p>
+# https://www.apache.org/licenses/LICENSE-2.0
+# <p>
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+---
+type: specs.openrewrite.org/v1beta/recipe
+name: org.openrewrite.java.jspecify.MigrateToJspecify
+displayName: Migrate to JSpecify
+description: >-
+  This recipe will migrate to JSpecify annotations from various other nullability annotation standards.
+tags:
+  - java
+recipeList:
+  - org.openrewrite.java.jspecify.MigrateFromJavaxAnnotationApi
+  - org.openrewrite.java.jspecify.MigrateFromJakartaAnnotationApi
+  - org.openrewrite.java.jspecify.MigrateFromJetbrainsAnnotations
+
+---
+type: specs.openrewrite.org/v1beta/recipe
+name: org.openrewrite.java.jspecify.MigrateFromJavaxAnnotationApi
+displayName: Migrate from javax annotation API to JSpecify
+description: Migrate from javax annotation API to JSpecify.
+recipeList:
+  - org.openrewrite.java.dependencies.AddDependency:
+      groupId: org.jspecify
+      artifactId: jspecify
+      version: latest.release
+      onlyIfUsing: javax.annotation.*ull*
+  - org.openrewrite.java.ChangeType:
+      oldFullyQualifiedTypeName: javax.annotation.Nullable
+      newFullyQualifiedTypeName: org.jspecify.annotations.Nullable
+      ignoreDefinition: true
+  - org.openrewrite.java.ChangeType:
+      oldFullyQualifiedTypeName: javax.annotation.Nonnull
+      newFullyQualifiedTypeName: org.jspecify.annotations.NonNull
+      ignoreDefinition: true
+  - org.openrewrite.staticanalysis.java.MoveFieldAnnotationToType:
+      annotationType: org.jspecify.annotations.*
+---
+type: specs.openrewrite.org/v1beta/recipe
+name: org.openrewrite.java.jspecify.MigrateFromJakartaAnnotationApi
+displayName: Migrate from Jakarta annotation API to JSpecify
+description: Migrate from Jakarta annotation API to JSpecify.
+recipeList:
+  - org.openrewrite.java.dependencies.AddDependency:
+      groupId: org.jspecify
+      artifactId: jspecify
+      version: 1.0.0
+      onlyIfUsing: jakarta.annotation.*ull*
+  - org.openrewrite.java.ChangeType:
+      oldFullyQualifiedTypeName: jakarta.annotation.Nullable
+      newFullyQualifiedTypeName: org.jspecify.annotations.Nullable
+      ignoreDefinition: true
+  - org.openrewrite.java.ChangeType:
+      oldFullyQualifiedTypeName: jakarta.annotation.Nonnull
+      newFullyQualifiedTypeName: org.jspecify.annotations.NonNull
+      ignoreDefinition: true
+  - org.openrewrite.staticanalysis.java.MoveFieldAnnotationToType:
+      annotationType: org.jspecify.annotations.*
+---
+type: specs.openrewrite.org/v1beta/recipe
+name: org.openrewrite.java.jspecify.MigrateFromJetbrainsAnnotations
+displayName: Migrate from JetBrains annotations to JSpecify
+description: Migrate from JetBrains annotations to JSpecify.
+recipeList:
+  - org.openrewrite.java.dependencies.AddDependency:
+      groupId: org.jspecify
+      artifactId: jspecify
+      version: 1.0.0
+      onlyIfUsing: org.jetbrains.annotations.*ull*
+  - org.openrewrite.java.ChangeType:
+      oldFullyQualifiedTypeName: org.jetbrains.annotations.Nullable
+      newFullyQualifiedTypeName: org.jspecify.annotations.Nullable
+      ignoreDefinition: true
+  - org.openrewrite.java.ChangeType:
+      oldFullyQualifiedTypeName: org.jetbrains.annotations.NotNull
+      newFullyQualifiedTypeName: org.jspecify.annotations.NonNull
+      ignoreDefinition: true
+  - org.openrewrite.staticanalysis.java.MoveFieldAnnotationToType:
+      annotationType: org.jspecify.annotations.*

src/test/java/org/openrewrite/java/migrate/javax/AddCommonAnnotationsDependenciesTest.java

@@ -36,14 +36,14 @@ public void defaults(RecipeSpec spec) {
     @Test
     void addDependencyIfAnnotationJsr250Present() {
         rewriteRun(
-          spec -> spec.parser(JavaParser.fromJavaVersion().classpath("jakarta.annotation-api")),
+          spec -> spec.parser(JavaParser.fromJavaVersion().dependsOn("package javax.annotation; public @interface Generated {}")),
           mavenProject("my-project",
             //language=java
             srcMainJava(
               java(
                 """
                   import javax.annotation.Generated;
-
+                  
                   @Generated("Hello")
                   class A {
                   }