Moderne licensed

Add `@Nullable` to fields that can hold null

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

Adds the JSpecify @Nullable annotation to a Java field when that field is provably assigned a nullable value anywhere in the project: a declaration initializer or an assignment (f = expr, this.f = expr, or obj.f = expr) whose value is the null literal (directly, through a cast or parentheses, or via either branch of a ternary) or a call to a nullable-returning method. Nullability propagates from every assignment site to the field's declaration across the project, preparing the code for NullAway. Conservative by design: it skips primitive fields, final fields with a non-null initializer, record components, fields already annotated, and fields with a dependency-injection annotation (@Inject, @Autowired, @Resource, @Mock, @Value, @Bean). Only Java fields are modified.

Single 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.AddNullableToField")
}

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.AddNullableToField

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

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

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