Moderne licensed

Find Kotlin declarations missing `@Jvm*` interop annotations

Recipe IDorg.openrewrite.kotlin.interop.FindMissingJvmAnnotations$KtRecipeArtifactio.moderne.recipe:recipes-kotlin

Search-only bundle of declarations where the JVM-visible API surface would benefit from one of the @JvmStatic / @JvmField / @JvmOverloads / @JvmName / @Throws annotations. Each match is a candidate for review — none should be applied blindly, but the absence is the primary friction Java callers feel.

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.interop.FindMissingJvmAnnotations$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.interop.FindMissingJvmAnnotations$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 companion object functions missing @JvmStaticorg.openrewrite.kotlin.interop.FindMissingJvmStaticInCompanion$KtRecipe
Find const val / companion val declarations missing @JvmFieldorg.openrewrite.kotlin.interop.FindMissingJvmFieldOnConst$KtRecipe
Find functions with default parameters missing @JvmOverloadsorg.openrewrite.kotlin.interop.FindMissingJvmOverloadsOnDefaults$KtRecipe
Find top-level functions missing @JvmNameorg.openrewrite.kotlin.interop.FindMissingJvmNameOnExtensionFunction$KtRecipe
Find val isX Boolean properties missing @get:JvmNameorg.openrewrite.kotlin.interop.FindMissingJvmNameOnIsGetter$KtRecipe
Find functions with throw of a checked exception missing @Throwsorg.openrewrite.kotlin.interop.FindMissingThrowsAnnotation$KtRecipe
Find interface declarations with default-method bodiesorg.openrewrite.kotlin.interop.FindKotlinDefaultMethodInterface$KtRecipe
Find @RequiresOptIn annotation declarationsorg.openrewrite.kotlin.interop.FindRequiresOptInOnExperimentalApi$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