Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Keep classes small (max 30 members)

Recipe IDorg.openrewrite.scala.cleanup.KeepClassesSmall

Artifactio.moderne.recipe:recipes-scala

Finds classes with more than 30 members. Large classes are harder to maintain; consider splitting into smaller classes.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Examples

scala

scala

Before

class BigService {
    val f1 = 1
    val f2 = 2
    val f3 = 3
    val f4 = 4
    val f5 = 5
    val f6 = 6
    val f7 = 7
    val f8 = 8
    val f9 = 9
    val f10 = 10
    val f11 = 11
    val f12 = 12
    val f13 = 13
    val f14 = 14
    val f15 = 15
    val f16 = 16
    val f17 = 17
    val f18 = 18
    val f19 = 19
    val f20 = 20
    val f21 = 21
    val f22 = 22
    val f23 = 23
    val f24 = 24
    val f25 = 25
    val f26 = 26
    val f27 = 27
    val f28 = 28
    val f29 = 29
    val f30 = 30
    val f31 = 31
}

After

/*~~(Class has too many members; consider splitting)~~>*/class BigService {
    val f1 = 1
    val f2 = 2
    val f3 = 3
    val f4 = 4
    val f5 = 5
    val f6 = 6
    val f7 = 7
    val f8 = 8
    val f9 = 9
    val f10 = 10
    val f11 = 11
    val f12 = 12
    val f13 = 13
    val f14 = 14
    val f15 = 15
    val f16 = 16
    val f17 = 17
    val f18 = 18
    val f19 = 19
    val f20 = 20
    val f21 = 21
    val f22 = 22
    val f23 = 23
    val f24 = 24
    val f25 = 25
    val f26 = 26
    val f27 = 27
    val f28 = 28
    val f29 = 29
    val f30 = 30
    val f31 = 31
}

Diff

@@ -1,1 +1,1 @@
-class BigService {
+/*~~(Class has too many members; consider splitting)~~>*/class BigService {
    val f1 = 1

Usage

Run this recipe

This recipe has no required configuration options. Users of Moderne can run it via the Moderne CLI.

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe KeepClassesSmall

If the recipe is not available locally, then you can install it using:

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

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

LATEST

mod config recipes jar install io.moderne.recipe:recipes-scala:LATEST

Pinned version

mod config recipes jar install io.moderne.recipe:recipes-scala:0.5.0

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.