Skip to main content

Keep methods short (max 20 statements)

org.openrewrite.scala.recipes.cleanup.KeepMethodsShort

Finds methods with more than 20 statements. Long methods are harder to understand and maintain; consider refactoring.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Example​

Before​
class Example {
    def longMethod(): Unit = {
        val a1 = 1
        val a2 = 2
        val a3 = 3
        val a4 = 4
        val a5 = 5
        val a6 = 6
        val a7 = 7
        val a8 = 8
        val a9 = 9
        val a10 = 10
        val a11 = 11
        val a12 = 12
        val a13 = 13
        val a14 = 14
        val a15 = 15
        val a16 = 16
        val a17 = 17
        val a18 = 18
        val a19 = 19
        val a20 = 20
        val a21 = 21
    }
}
After​
class Example {
    /*~~(Method has too many statements; consider refactoring)~~>*/def longMethod(): Unit = {
        val a1 = 1
        val a2 = 2
        val a3 = 3
        val a4 = 4
        val a5 = 5
        val a6 = 6
        val a7 = 7
        val a8 = 8
        val a9 = 9
        val a10 = 10
        val a11 = 11
        val a12 = 12
        val a13 = 13
        val a14 = 14
        val a15 = 15
        val a16 = 16
        val a17 = 17
        val a18 = 18
        val a19 = 19
        val a20 = 20
        val a21 = 21
    }
}

Usage​

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 KeepMethodsShort

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

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

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.