rewrite:discover
Full name:
org.openrewrite.maven:rewrite-maven-plugin:5.48.0-SNAPSHOT:discover
Description:
Generate a report of the available recipes and styles found on the classpath.
Can also be used to display information about a specific recipe. For example:
./mvnw rewrite:discover -Ddetail=true -Drecipe=org.openrewrite.java.format.AutoFormat
Attributes:
- Executes as an aggregator goal.
- The goal is thread-safe and supports parallel builds.
Optional Parameters
Name | Type | Since | Description |
---|---|---|---|
<activeRecipes> |
LinkedHashSet<String> |
- |
No description. User Property: rewrite.activeRecipes |
<activeStyles> |
LinkedHashSet<String> |
- |
No description. User Property: rewrite.activeStyles |
<additionalPlainTextMasks> |
LinkedHashSet<String> |
- |
Allows adding additional plain text masks without overriding the defaults. User Property: rewrite.additionalPlainTextMasks |
<checkstyleConfigFile> |
String |
- |
No description. User Property: rewrite.checkstyleConfigFile Alias: checkstyleConfigFile |
<checkstyleDetectionEnabled> |
boolean |
- |
No description. Default: true User Property: rewrite.checkstyleDetectionEnabled Alias: checkstyleDetectionEnabled |
<configLocation> |
String |
- |
No description. Default: ${maven.multiModuleProjectDirectory}/rewrite.yml User Property: rewrite.configLocation Alias: configLocation |
<detail> |
boolean |
- |
Whether to display recipe details such as displayName, description, and configuration options. Default: false User Property: detail |
<exclusions> |
LinkedHashSet<String> |
- |
No description. User Property: rewrite.exclusions |
<failOnInvalidActiveRecipes> |
boolean |
- |
Whether to throw an exception if an activeRecipe fails configuration validation. This may happen if the activeRecipe is improperly configured, or any downstream recipes are improperly configured.
For the time, this default is "false" to prevent one improper recipe from failing the build. In the future, this default may be changed to "true" to be more restrictive. Default: false User Property: rewrite.failOnInvalidActiveRecipes Alias: failOnInvalidActiveRecipes |
<metricsPassword> |
String |
- |
No description. User Property: rewrite.metricsPassword Alias: metricsPassword |
<metricsUri> |
String |
- |
No description. User Property: rewrite.metricsUri Alias: metricsUri |
<metricsUsername> |
String |
- |
No description. User Property: rewrite.metricsUsername Alias: metricsUsername |
<plainTextMasks> |
LinkedHashSet<String> |
- |
Override default plain text masks. If this is specified, rewrite.additionalPlainTextMasks will have no effect.User Property: rewrite.plainTextMasks |
<pomCacheDirectory> |
String |
- |
No description. User Property: rewrite.pomCacheDirectory Alias: pomCacheDirectory |
<pomCacheEnabled> |
boolean |
- |
No description. Default: true User Property: rewrite.pomCacheEnabled Alias: pomCacheEnabled |
<recipe> |
String |
- |
The name of a specific recipe to show details for. For example:
./mvnw rewrite:discover -Ddetail=true -Drecipe=org.openrewrite.java.format.AutoFormat User Property: recipe |
<recipeArtifactCoordinates> |
LinkedHashSet<String> |
- |
No description. User Property: rewrite.recipeArtifactCoordinates |
<recursion> |
int |
- |
The maximum level of recursion to display recipe descriptors under recipeList. Default: 0 User Property: recursion |
<resolvePropertiesInYaml> |
boolean |
- |
No description. Default: true User Property: rewrite.resolvePropertiesInYaml |
<rewriteSkip> |
boolean |
- |
No description. Default: false User Property: rewrite.skip |
<runPerSubmodule> |
boolean |
- |
No description. Default: false User Property: rewrite.runPerSubmodule Alias: runPerSubmodule |
<sizeThresholdMb> |
int |
- |
No description. Default: 10 User Property: sizeThresholdMb |
<skipMavenParsing> |
boolean |
- |
When enabled, skip parsing Maven `pom.xml`s, and any transitive poms, as source files. This can be an efficiency improvement in certain situations. Default: false User Property: skipMavenParsing |
Parameter Details
<activeRecipes>
No description.
- Type:
java.util.LinkedHashSet<java.lang.String>
- Required:
No
- User Property:
rewrite.activeRecipes
<activeStyles>
No description.
- Type:
java.util.LinkedHashSet<java.lang.String>
- Required:
No
- User Property:
rewrite.activeStyles
<additionalPlainTextMasks>
Allows adding additional plain text masks without overriding the defaults.
- Type:
java.util.LinkedHashSet<java.lang.String>
- Required:
No
- User Property:
rewrite.additionalPlainTextMasks
<checkstyleConfigFile>
No description.
- Type:
java.lang.String
- Required:
No
- User Property:
rewrite.checkstyleConfigFile
- Alias:
checkstyleConfigFile
<checkstyleDetectionEnabled>
No description.
- Type:
boolean
- Required:
No
- User Property:
rewrite.checkstyleDetectionEnabled
- Default:
true
- Alias:
checkstyleDetectionEnabled
<configLocation>
No description.
- Type:
java.lang.String
- Required:
No
- User Property:
rewrite.configLocation
- Default:
${maven.multiModuleProjectDirectory}/rewrite.yml
- Alias:
configLocation
<detail>
Whether to display recipe details such as displayName, description, and configuration options.
- Type:
boolean
- Required:
No
- User Property:
detail
- Default:
false
<exclusions>
No description.
- Type:
java.util.LinkedHashSet<java.lang.String>
- Required:
No
- User Property:
rewrite.exclusions
<failOnInvalidActiveRecipes>
Whether to throw an exception if an activeRecipe fails configuration validation. This may happen if the activeRecipe is improperly configured, or any downstream recipes are improperly configured.
For the time, this default is "false" to prevent one improper recipe from failing the build. In the future, this default may be changed to "true" to be more restrictive.
- Type:
boolean
- Required:
No
- User Property:
rewrite.failOnInvalidActiveRecipes
- Default:
false
- Alias:
failOnInvalidActiveRecipes
<metricsPassword>
No description.
- Type:
java.lang.String
- Required:
No
- User Property:
rewrite.metricsPassword
- Alias:
metricsPassword
<metricsUri>
No description.
- Type:
java.lang.String
- Required:
No
- User Property:
rewrite.metricsUri
- Alias:
metricsUri
<metricsUsername>
No description.
- Type:
java.lang.String
- Required:
No
- User Property:
rewrite.metricsUsername
- Alias:
metricsUsername
<plainTextMasks>
Override default plain text masks. If this is specified,
rewrite.additionalPlainTextMasks
will have no effect.- Type:
java.util.LinkedHashSet<java.lang.String>
- Required:
No
- User Property:
rewrite.plainTextMasks
<pomCacheDirectory>
No description.
- Type:
java.lang.String
- Required:
No
- User Property:
rewrite.pomCacheDirectory
- Alias:
pomCacheDirectory
<pomCacheEnabled>
No description.
- Type:
boolean
- Required:
No
- User Property:
rewrite.pomCacheEnabled
- Default:
true
- Alias:
pomCacheEnabled
<recipe>
The name of a specific recipe to show details for. For example:
./mvnw rewrite:discover -Ddetail=true -Drecipe=org.openrewrite.java.format.AutoFormat
- Type:
java.lang.String
- Required:
No
- User Property:
recipe
<recipeArtifactCoordinates>
No description.
- Type:
java.util.LinkedHashSet<java.lang.String>
- Required:
No
- User Property:
rewrite.recipeArtifactCoordinates
<recursion>
The maximum level of recursion to display recipe descriptors under recipeList.
- Type:
int
- Required:
No
- User Property:
recursion
- Default:
0
<resolvePropertiesInYaml>
No description.
- Type:
boolean
- Required:
No
- User Property:
rewrite.resolvePropertiesInYaml
- Default:
true
<rewriteSkip>
No description.
- Type:
boolean
- Required:
No
- User Property:
rewrite.skip
- Default:
false
<runPerSubmodule>
No description.
- Type:
boolean
- Required:
No
- User Property:
rewrite.runPerSubmodule
- Default:
false
- Alias:
runPerSubmodule
<sizeThresholdMb>
No description.
- Type:
int
- Required:
No
- User Property:
sizeThresholdMb
- Default:
10
<skipMavenParsing>
When enabled, skip parsing Maven `pom.xml`s, and any transitive poms, as source files. This can be an efficiency improvement in certain situations.
- Type:
boolean
- Required:
No
- User Property:
skipMavenParsing
- Default:
false