← All recipes
Moderne licensed

Replace Kotlin method

Recipe IDorg.openrewrite.kotlin.replace.ReplaceKotlinMethodArtifactorg.openrewrite.recipe:rewrite-migrate-kotlin

Replaces Kotlin method calls based on @Deprecated(replaceWith=ReplaceWith(...)) annotations.

Single recipedeprecatedkotlinProprietary

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.kotlin.replace.ReplaceKotlinMethod")
}

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-migrate-kotlin:0.9.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 org.openrewrite.kotlin.replace.ReplaceKotlinMethod --recipe-option "methodPattern=arrow.core.MapKt mapOrAccumulate(kotlin.Function2)" --recipe-option "replacement=mapValuesOrAccumulate(transform)"

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

mod config recipes jar install org.openrewrite.recipe:rewrite-migrate-kotlin:RELEASE

Options

NameTypeDescription
methodPatternrequiredStringA method pattern that is used to find matching method invocations.
e.g. arrow.core.MapKt mapOrAccumulate(kotlin.Function2)
replacementrequiredStringThe replacement expression from @Deprecated(replaceWith=ReplaceWith(...)). Parameter names from the original method can be used directly.
e.g. mapValuesOrAccumulate(transform)
importsListList of imports to add when the replacement is made.
e.g. ["arrow.core.Either"]
classpathFromResourcesListList of classpath resource names for parsing the replacement template.
e.g. ["arrow-core-2"]

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