Skip to main content

Add @NullMarked to packages that are ready for NullAway

io.moderne.nullability.scope.AddNullMarkedToCleanPackages

Automatically adds the JSpecify @NullMarked annotation to a package — by annotating its existing package-info.java or generating one — but only when every Java class in the package is "ready", i.e. would not produce a fresh NullAway error once the scope is marked. A package fails the readiness gate (and is left unmarked) if any class in it has: (1) an uninitialized non-null instance field (the FindUninitializedNonNullField condition: non-@Nullable, non-final, non-static, reference-typed, no initializer, not assigned in every constructor, not dependency-injection-annotated); (2) a method whose body can return a provably-null value but whose return type is not @Nullable; or (3) a field initialized to a provably-null value that is not @Nullable. An @Override method that returns null without @Nullable is also treated as a blocker. Packages whose sources live under a generated marker path (/generated/, /build/generated, /generated-sources/) or whose classes carry a @Generated annotation are skipped. The recipe is idempotent and operates per leaf package; it never marks parent packages transitively. Java sources only.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Example​

Unchanged​
src/main/java/com/example/Clean.java
package com.example;

import org.jspecify.annotations.Nullable;

class Clean {
    String name = "x";

    @Nullable
    String maybeNull() {
        return null;
    }
}
Before​
src/main/java/com/example/package-info.java
package com.example;
After​
src/main/java/com/example/package-info.java
@NullMarked
package com.example;

import org.jspecify.annotations.NullMarked;

Usage​

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell
mod run . --recipe AddNullMarkedToCleanPackages

If the recipe is not available locally, then you can install it using:

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

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changesIn a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.