Skip to content

Add JSpecify best practices recipe #744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 31, 2025
Merged

Add JSpecify best practices recipe #744

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
632d037
Add JSpecify best practices recipe
timtebeek May 31, 2025
d2c6887
Rename to JSpecifyBestPracticesTest
timtebeek May 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions src/main/resources/META-INF/rewrite/jspecify.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,23 @@
# 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.JSpecifyBestPractices
displayName: JSpecify best practices
description: >-
Apply JSpecify best practices, such as migrating off of alternatives, and adding missing `@Nullable` annotations.
tags:
- java
recipeList:
- org.openrewrite.java.jspecify.MigrateToJSpecify
- org.openrewrite.staticanalysis.AnnotateNullableMethods
- org.openrewrite.staticanalysis.AnnotateNullableParameters
- org.openrewrite.staticanalysis.NullableOnMethodReturnType

---
type: specs.openrewrite.org/v1beta/recipe
name: org.openrewrite.java.jspecify.MigrateToJspecify
name: org.openrewrite.java.jspecify.MigrateToJSpecify
displayName: Migrate to JSpecify
description: >-
This recipe will migrate to JSpecify annotations from various other nullability annotation standards.
Expand All @@ -27,7 +40,7 @@ recipeList:
- org.openrewrite.java.jspecify.MigrateFromJakartaAnnotationApi
- org.openrewrite.java.jspecify.MigrateFromJetbrainsAnnotations
# Running the following recipe on current versions of Spring can cause Spring to misunderstand a nullable field.
# For instance, a custom Prometheus scrape endpoint with @Nullable Set<String> includedNames will fail if
# For instance, a custom Prometheus scrape endpoint with @Nullable Set<String> includedNames will fail if
# includedNames is null and if @Nullable is @org.jspecify.annotations.Nullable.
# - org.openrewrite.java.jspecify.MigrateFromSpringFrameworkAnnotations

Expand Down
4 changes: 2 additions & 2 deletions ...grate/jspecify/MigrateToJspecifyTest.java → ...e/jspecify/JSpecifyBestPracticesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@
import static org.openrewrite.maven.Assertions.pomXml;

@SuppressWarnings("NotNullFieldNotInitialized")
class MigrateToJspecifyTest implements RewriteTest {
class JSpecifyBestPracticesTest implements RewriteTest {

@Override
public void defaults(RecipeSpec spec) {
spec
.recipeFromResource("/META-INF/rewrite/jspecify.yml", "org.openrewrite.java.jspecify.MigrateToJspecify")
.recipeFromResource("/META-INF/rewrite/jspecify.yml", "org.openrewrite.java.jspecify.JSpecifyBestPractices")
.parser(JavaParser.fromJavaVersion().classpath("jsr305", "jakarta.annotation-api", "annotations", "spring-core"));
}

Expand Down