← All recipes
Moderne licensed

Add @NullMarked to package-info.java for an allowlist of packages

Recipe IDio.moderne.nullability.AddNullMarkedToPackageInfo
Artifactio.moderne.recipe:rewrite-nullability

Adds the JSpecify @NullMarked annotation to the package-info.java of an explicit allowlist of packages. The allowlist supports exact package names and a trailing .* prefix wildcard; an empty allowlist is a no-op. When generateMissing is enabled, an allowlisted package that has Java sources but no package-info.java gets one generated. Idempotent and Java only.

Single recipeProprietary

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe io.moderne.nullability.AddNullMarkedToPackageInfo --recipe-option "packages=com.airbnb.payments.*"

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

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

Options

NameTypeDescription
packagesrequiredListThe allowlist of packages to null-mark. Each entry is either an exact package name (for example com.airbnb.payments) or a trailing .* prefix wildcard (for example com.airbnb.payments.*, which matches that package and every sub-package). If empty, the recipe is a no-op.
e.g. com.airbnb.payments.*
generateMissingBooleanWhen true, for an allowlisted package that has at least one Java source but no package-info.java, generate one containing @NullMarked. Defaults to false.

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