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.MethodQualityMetricsPer-method code quality metrics including cyclomatic complexity, cognitive complexity, nesting depth, Halstead measures, and ABC metric.
| Column | Description |
|---|---|
| Source path | The path to the source file containing the method. |
| Class name | The fully qualified name of the containing class. |
| Method name | The simple name of the method. |
| Method signature | The full method signature including parameter types. |
| Cyclomatic complexity | Number of linearly independent paths through the method. 1-10 low, 11-20 moderate, 21-50 high, 50+ very high. |
| Cognitive complexity | Weighted complexity penalizing nesting depth and flow-breaking structures. |
| Max nesting depth | Maximum depth of nested control structures. |
| Line count | Number of lines in the method body. |
| Parameter count | Number of parameters the method accepts. |
| ABC score | ABC metric magnitude: sqrt(A^2 + B^2 + C^2) where A=assignments, B=branches (calls), C=conditions. |
| Assignments | Number of assignment operations (the A in ABC metric). |
| Branches | Number of method/function calls (the B in ABC metric). |
| Conditions | Number of boolean conditions (the C in ABC metric). |
| Halstead volume | Information content of the method: N * log2(n) where N=total operators+operands, n=distinct operators+operands. |
| Halstead difficulty | Error proneness: (n1/2) * (N2/n2) where n1=distinct operators, N2=total operands, n2=distinct operands. |
| Halstead estimated bugs | Estimated number of delivered bugs: E^(2/3) / 3000 where E = difficulty * volume. |
Source files that had results
org.openrewrite.table.SourcesFileResultsSource 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.SearchResultsSearch 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.SourcesFileErrorsThe 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.RecipeRunStatsStatistics 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. |