Skip to main content
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

Find method complexity

Recipe IDio.moderne.prethink.quality.FindMethodComplexity
Artifactio.moderne.recipe:rewrite-prethink

Compute per-method code quality metrics including cyclomatic complexity, cognitive complexity, max nesting depth, line count, parameter count, ABC metric, and Halstead measures.

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

Example 1
Unchanged
package com.example;

public class Simple {
public String doWork() {
return "done";
}
}

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 FindMethodComplexity

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

mod config recipes jar install io.moderne.recipe:rewrite-prethink:0.7.3

Data tables

Method quality metrics
io.moderne.prethink.table.MethodQualityMetrics

Per-method code quality metrics including cyclomatic complexity, cognitive complexity, nesting depth, Halstead measures, and ABC metric.

ColumnDescription
Source pathThe path to the source file containing the method.
Class nameThe fully qualified name of the containing class.
Method nameThe simple name of the method.
Method signatureThe full method signature including parameter types.
Cyclomatic complexityNumber of linearly independent paths through the method. 1-10 low, 11-20 moderate, 21-50 high, 50+ very high.
Cognitive complexityWeighted complexity penalizing nesting depth and flow-breaking structures.
Max nesting depthMaximum depth of nested control structures.
Line countNumber of lines in the method body.
Parameter countNumber of parameters the method accepts.
ABC scoreABC metric magnitude: sqrt(A^2 + B^2 + C^2) where A=assignments, B=branches (calls), C=conditions.
AssignmentsNumber of assignment operations (the A in ABC metric).
BranchesNumber of method/function calls (the B in ABC metric).
ConditionsNumber of boolean conditions (the C in ABC metric).
Halstead volumeInformation content of the method: N * log2(n) where N=total operators+operands, n=distinct operators+operands.
Halstead difficultyError proneness: (n1/2) * (N2/n2) where n1=distinct operators, N2=total operands, n2=distinct operands.
Halstead estimated bugsEstimated number of delivered bugs: E^(2/3) / 3000 where E = difficulty * volume.
Source files that had results
org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

ColumnDescription
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.
Source files that had search results
org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

ColumnDescription
Source path of search result before the runThe source path of the file with the search result markers present.
Source path of search result after run 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.
ResultThe trimmed printed tree of the LST element that the marker is attached to.
DescriptionThe content of the description of the marker.
Recipe that added the search markerThe 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.

ColumnDescription
Source pathThe file that failed to parse.
Recipe that made changesThe specific recipe that made a change.
Stack traceThe stack trace of the failure.
Recipe performance
org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

ColumnDescription
The recipeThe recipe whose stats are being measured both individually and cumulatively.
Source file countThe number of source files the recipe ran over.
Source file changed countThe 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.