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.
mod run . --recipe FindTransactionDeclarations
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
- LATEST
- Pinned version
mod config recipes jar install io.moderne.recipe:rewrite-prethink:RELEASE
mod config recipes jar install io.moderne.recipe:rewrite-prethink:LATEST
mod config recipes jar install io.moderne.recipe:rewrite-prethink:0.18.0
Data tables
Transaction declarations
io.moderne.prethink.table.TransactionDeclarationsDirect, type-attributed transaction annotations on Java type and method declarations. Declaration evidence only; does not establish effective transaction or rollback behavior.
mod study . --last-recipe-run \
--data-table io.moderne.prethink.table.TransactionDeclarations
| Column | Description |
|---|---|
| Source path | The path to the Java source file. |
| Class name | Attributed declaring type FQN, with $ for nested types. Joins method quality metrics and SQL usage. |
| Declaration kind | TYPE or METHOD. A TYPE row is not expanded into rows for its methods. |
| Method name | Simple method name, or null for a type declaration. |
| Method signature | JavaType.Method.toString(), preserving overload parameter types. Null for a type declaration. |
| Annotation type | Attributed annotation FQN: Spring, jakarta, or javax Transactional. |
| Start line | One-based source line of the annotation @ token, excluding prefix comments and whitespace. |
| Start column | One-based UTF-16 source column of the annotation @ token. Tabs count as one character. |
| End line | One-based source line at the exclusive end of the annotation. |
| End column | One-based UTF-16 source column at the exclusive end of the annotation. |
| Declaration start line | One-based start line of the declaration syntax, including its leading annotations. |
| Declaration start column | One-based UTF-16 start column of the declaration syntax, including its leading annotations. |
| Annotation source | Annotation source text, including every explicit member and original formatting, without leading prefix whitespace or comments. |
| Explicit attributes | JSON object keyed by explicit member name (shorthand is value). Each entry has raw, state, and value. States are LITERAL, ENUM_CONSTANT, CLASS_LITERAL, ARRAY, or UNRESOLVED. Arrays resolve only when every element resolves. Unresolved values are JSON null; omitted members are absent. No runtime defaults, alias expansion, or constant folding. |
Source files that had results
org.openrewrite.table.SourcesFileResultsSource files that were modified by the recipe run.
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SourcesFileResults
| 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.
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SearchResults
| 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.
mod study . --last-recipe-run \
--data-table org.openrewrite.table.SourcesFileErrors
| 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.
mod study . --last-recipe-run \
--data-table org.openrewrite.table.RecipeRunStats
| 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. |