Add comment to import statement
Recipe ID
org.openrewrite.java.AddCommentToImportArtifact
org.openrewrite:rewrite-javaAdd a comment to an import statement in a Java source file.
Usage
You’ll need the Moderne CLI configured before running the command below.
mod run . --recipe org.openrewrite.java.AddCommentToImport --recipe-option "comment=This is a comment." --recipe-option "typePattern=org.springframework..*"If the recipe isn’t available locally, install it with:
mod config recipes jar install org.openrewrite:rewrite-java:8.88.0Options
| Name | Type | Description |
|---|---|---|
commentrequired | String | The comment to add. e.g. This is a comment. |
typePatternrequired | String | A type pattern that is used to find matching imports uses. e.g. org.springframework..* |
Data tables
Structured output this recipe can produce.
- Source files that had resultsSource files that were modified by the recipe run.
org.openrewrite.table.SourcesFileResults - Source files that had search resultsSearch results that were found during the recipe run.
org.openrewrite.table.SearchResults - Source files that errored on a recipeThe details of all errors produced by a recipe run.
org.openrewrite.table.SourcesFileErrors - Recipe performanceStatistics used in analyzing the performance of recipes.
org.openrewrite.table.RecipeRunStats