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 FindExceptionHandlers
If the recipe is not available locally, then you can install it using:
mod config recipes jar install io.moderne.recipe:rewrite-prethink:0.8.1
Data tables
Exception handlers
io.moderne.prethink.table.ExceptionHandlersSpring @ExceptionHandler and @ControllerAdvice bindings: exception type -> HTTP status -> response body FQN. Used to complete the 'responses' section of an OpenAPI spec with non-2xx branches.
| Column | Description |
|---|---|
| Source path | The path to the source file containing the handler. |
| Scope class FQN | Fully qualified name of the @ControllerAdvice class OR the controller class hosting the local handler. |
| Scope kind | 'advice' when the handler lives on a @ControllerAdvice class, 'controller' for controller-local handlers. |
| Base packages | Comma-separated basePackages from @ControllerAdvice narrowing scope, else null. |
| Exception FQN | Fully qualified name of the exception type handled by this method. |
| Handler method | The handler method name. |
| Status | HTTP status code returned (e.g. 400, 500), or null when it could not be resolved. |
| Status source | Where the status came from: '@ResponseStatus', 'ResponseEntity.status', or 'unresolved'. |
| Response body FQN | Fully qualified name of the response body DTO for this handler, or null if no body. |
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. |