Moderne licensed

Find public-API and binary-stability surface

Recipe IDorg.openrewrite.kotlin.search.FindApiSurface$KtRecipeArtifactio.moderne.recipe:recipes-kotlin

Public const val / lateinit var declarations, @OptIn / @RequiresOptIn annotations, @Deprecated declarations, and JVM-interop annotations (@JvmStatic, @JvmField, @JvmOverloads). Each match is a position where API stability or external-consumer constraints are encoded in the source.

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.search.FindApiSurface$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.search.FindApiSurface$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 public const val declarationsorg.openrewrite.kotlin.search.FindPublicConstants$KtRecipe
Find public lateinit var declarationsorg.openrewrite.kotlin.search.FindPublicLateinit$KtRecipe
Find @OptIn(...) annotationsorg.openrewrite.kotlin.search.FindOptInAnnotations$KtRecipe
Find declarations annotated @RequiresOptInorg.openrewrite.kotlin.search.FindRequiresOptInDeclarations$KtRecipe
Find declarations annotated @Deprecatedorg.openrewrite.kotlin.search.FindDeprecatedDeclarations$KtRecipe
Find @JvmStatic annotationsorg.openrewrite.kotlin.search.FindJvmStaticAnnotations$KtRecipe
Find @JvmField annotationsorg.openrewrite.kotlin.search.FindJvmFieldAnnotations$KtRecipe
Find @JvmOverloads annotationsorg.openrewrite.kotlin.search.FindJvmOverloadsAnnotations$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