JSpecify best practices

Usage

This recipe has no required configuration options. You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.jspecify.JSpecifyBestPractices

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-java:3.41.0

Definition

This recipe runs the following recipes in order.

• Migrate to JSpecifyorg.openrewrite.java.jspecify.MigrateToJSpecify
• Annotate methods which may return null with @Nullableorg.openrewrite.staticanalysis.AnnotateNullableMethods
• Annotate null-checked method parameters with @Nullableorg.openrewrite.staticanalysis.AnnotateNullableParameters
• Annotate required method parameters with @NonNullorg.openrewrite.staticanalysis.AnnotateRequiredParameters
• Move @Nullable method annotations to the return typeorg.openrewrite.staticanalysis.NullableOnMethodReturnType

Data tables

Structured output this recipe can produce.

• Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
• Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
• Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
• Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats