Moderne licensed

Find Compose API design issues

Recipe IDorg.openrewrite.kotlin.compose.FindComposeApiDesignIssues$KtRecipeArtifactio.moderne.recipe:recipes-kotlin

Composable functions that don't follow the Compose API guidelines: lowercase name (UI emitters should be PascalCase), non-Unit return without @ReadOnlyComposable, content slot without a default {}, missing Modifier parameter, and @Composable invocations from non-Composable lambdas.

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.compose.FindComposeApiDesignIssues$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.compose.FindComposeApiDesignIssues$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 @Composable functions whose name starts with a lowercase letterorg.openrewrite.kotlin.compose.FindLowercaseComposableFunction$KtRecipe
Find @Composable fun … (): X functions returning a non-Unit valueorg.openrewrite.kotlin.compose.FindComposableWithReturnValue$KtRecipe
Find @Composable functions with a content lambda parameter not defaulted to {}org.openrewrite.kotlin.compose.FindComposableLambdaParamMissingDefault$KtRecipe
Find @Composable functions without a Modifier parameterorg.openrewrite.kotlin.compose.FindComposableMissingModifierParam$KtRecipe
Find @Composable calls inside non-@Composable lambda parametersorg.openrewrite.kotlin.compose.FindComposableCallInNonComposableLambda$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