Moderne licensed

Find class-declaration smells

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

Search-only bundle: flags class-level structural smells (empty companion, empty class body, redundant : Any(), manual toString/equals/hashCode trio, named companion of constants, multiple secondary constructors, sealed-class-without-state, marker-object-without-data, empty init, all-val classes that could be data class, mutable data class/object state, abstract classes without abstract members, and open classes with no overridable members).

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.FindClassStructureSmells$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.FindClassStructureSmells$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 marker object declarations that could be data objectorg.openrewrite.kotlin.bestpractices.FindDataObjectCandidates$KtRecipe
Find sealed class declarations that could be sealed interfaceorg.openrewrite.kotlin.bestpractices.FindSealedClassWithoutStateCandidates$KtRecipe
Find empty companion object declarationsorg.openrewrite.kotlin.bestpractices.FindEmptyCompanionObject$KtRecipe
Find named companion object Constants patternsorg.openrewrite.kotlin.bestpractices.FindNamedCompanionObjectOfConstants$KtRecipe
Find class Foo : Any() declarationsorg.openrewrite.kotlin.bestpractices.FindClassExtendsAny$KtRecipe
Find class Foo {} declarations with an empty bodyorg.openrewrite.kotlin.bestpractices.FindEmptyClassBody$KtRecipe
Find empty init { } blocksorg.openrewrite.kotlin.bestpractices.FindEmptyInitBlock$KtRecipe
Find classes with manual toString/equals/hashCode overridesorg.openrewrite.kotlin.bestpractices.FindManualToStringEqualsHashCode$KtRecipe
Find classes with multiple overloaded secondary constructorsorg.openrewrite.kotlin.bestpractices.FindMultipleSecondaryConstructors$KtRecipe
Find classes that could be data classorg.openrewrite.kotlin.bestpractices.FindClassWithoutDataAnnotation$KtRecipe
Find data class declarations with var propertiesorg.openrewrite.kotlin.bestpractices.FindDataClassWithMutableProperty$KtRecipe
Find object declarations with var propertiesorg.openrewrite.kotlin.bestpractices.FindObjectWithMutableState$KtRecipe
Find abstract class declarations without abstract membersorg.openrewrite.kotlin.bestpractices.FindAbstractClassWithoutMembers$KtRecipe
Find open class declarations without overridable membersorg.openrewrite.kotlin.bestpractices.FindOpenClassWithoutOverrides$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