Moderne licensed

Find function-declaration smells

Recipe IDorg.openrewrite.kotlin.bestpractices.FindFunctionDeclarationSmells$KtRecipeArtifactio.moderne.recipe:recipes-kotlin

Search-only bundle: explicit : Unit / : Nothing return type, block bodies that are a single return expr, literal-Boolean-returning functions, Pair/Triple returns that could be data classes, default-before-required parameters, suspend fun declarations returning Job/Deferred, and explicit return Unit statements.

Composite recipeProprietary

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.bestpractices.FindFunctionDeclarationSmells$KtRecipe")
}

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

dependencies {
    rewrite("io.moderne.recipe:recipes-kotlin:0.5.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.kotlin.bestpractices.FindFunctionDeclarationSmells$KtRecipe

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

mod config recipes jar install io.moderne.recipe:recipes-kotlin:RELEASE

Definition

This recipe runs the following recipes in order.

Find functions with explicit : Unit return typeorg.openrewrite.kotlin.bestpractices.FindExplicitUnitReturnType$KtRecipe
Find functions declared with : Nothing return typeorg.openrewrite.kotlin.bestpractices.FindReturnTypeNothing$KtRecipe
Find fun foo(): T { return x } block bodiesorg.openrewrite.kotlin.bestpractices.FindSingleExpressionBodyCandidate$KtRecipe
Find fun f(): Boolean = true|false literal-returning functionsorg.openrewrite.kotlin.bestpractices.FindBooleanLiteralReturnType$KtRecipe
Find functions returning Pair<A, B>org.openrewrite.kotlin.bestpractices.FindFunctionReturningPair$KtRecipe
Find functions returning Triple<A, B, C>org.openrewrite.kotlin.bestpractices.FindFunctionReturningTriple$KtRecipe
Find suspend fun declarations returning Job / Deferredorg.openrewrite.kotlin.bestpractices.FindSuspendFunctionReturningJob$KtRecipe
Find return Unit / return kotlin.Unit statementsorg.openrewrite.kotlin.bestpractices.FindRedundantReturnUnit$KtRecipe

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