Moderne licensed

Find ignored results of `@CheckReturnValue` methods

Recipe IDorg.openrewrite.staticanalysis.FindIgnoredCheckReturnValueArtifactorg.openrewrite.recipe:rewrite-static-analysis

Marks invocations whose result is discarded even though the method is annotated with @CheckReturnValue, either directly or through its enclosing class or package. Any annotation named CheckReturnValue is recognized, and @CanIgnoreReturnValue opts a method or class back out. Ignoring such a result is usually a bug, such as calling a method on an immutable object without using the returned copy. Calls expected to throw, Mockito stubbing and verification, calls on the current instance in custom AssertJ assertion constructors, and code under @SuppressWarnings("CheckReturnValue") are not marked.

Single recipeMSAL

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("org.openrewrite.staticanalysis.FindIgnoredCheckReturnValue")
}

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

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-static-analysis:2.45.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 org.openrewrite.staticanalysis.FindIgnoredCheckReturnValue

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

mod config recipes jar install org.openrewrite.recipe:rewrite-static-analysis:RELEASE

Options

Name	Type	Description
`checkReturnValuePackages`	`List`	Packages whose methods should be treated as annotated with `@CheckReturnValue`. Package annotations of dependencies are not part of type attribution, so list packages here that declare `@CheckReturnValue` in a `package-info.java` outside of the repository. Subpackages are not included. e.g. `org.openrewrite.java.tree`

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