Moderne licensed

Compose JSpecify best practices (intra-body nullability inference)

Recipe IDio.moderne.nullability.ComposeJSpecifyBestPracticesArtifactio.moderne.recipe:rewrite-nullability

Run the OpenRewrite static-analysis inference recipes that derive nullability from signals inside each method body: methods whose bodies can return null (standard-library aware, e.g. Map.get/Queue.poll) and parameters that are null-checked in the body, emitting JSpecify @Nullable. Complements the cross-file inference recipes.

Composite recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("io.moderne.nullability.ComposeJSpecifyBestPractices")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("io.moderne.recipe:rewrite-nullability:0.6.0")
}

Then run

./gradlew rewriteRun

Usage

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

mod run . --recipe io.moderne.nullability.ComposeJSpecifyBestPractices

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

mod config recipes jar install io.moderne.recipe:rewrite-nullability:RELEASE

Definition

This recipe runs the following recipes in order.

Annotate methods which may return null with @Nullableorg.openrewrite.staticanalysis.AnnotateNullableMethods
Annotate null-checked method parameters with @Nullableorg.openrewrite.staticanalysis.AnnotateNullableParameters

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