← All recipes
Open source

Add a comment to a method

Recipe IDsoftware.amazon.awssdk.v2migration.AddCommentToMethodArtifactorg.openrewrite.recipe:rewrite-third-party

Add a comment to a method.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("software.amazon.awssdk.v2migration.AddCommentToMethod")
}

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-third-party:0.48.0")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

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

mod run . --recipe software.amazon.awssdk.v2migration.AddCommentToMethod --recipe-option "methodPattern=org.mockito.Matchers anyVararg()" --recipe-option "comment=This method is not supported in AWS SDK for Java v2."

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

mod config recipes jar install org.openrewrite.recipe:rewrite-third-party:RELEASE

Options

NameTypeDescription
methodPatternrequiredStringA method pattern that is used to find matching method invocations.
e.g. org.mockito.Matchers anyVararg()
commentrequiredStringA comment to add to this method.
e.g. This method is not supported in AWS SDK for Java v2.

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