rewrite:dryRun
Full name:
org.openrewrite.maven:rewrite-maven-plugin:5.46.0-SNAPSHOT:dryRun
Description:
Generate warnings to the console for any recipe that would make changes, but do not make changes.
This variant of rewrite:dryRun will fork the maven life cycle and can be run as a "stand-alone" goal. It will execute the maven build up to the process-test-classes phase.
Attributes:
- Requires a Maven project to be executed.
- Requires dependency resolution of artifacts in scope:
test. - The goal is thread-safe and supports parallel builds.
- Binds by default to the lifecycle phase:
process-test-classes. - Invokes the execution of the following lifecycle phase prior to executing itself:
process-test-classes.
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.checkstyleConfigFileAlias: checkstyleConfigFile |
<checkstyleDetectionEnabled> |
boolean |
- |
No description. Default: trueUser Property: rewrite.checkstyleDetectionEnabledAlias: checkstyleDetectionEnabled |
<configLocation> |
String |
- |
No description. Default: ${maven.multiModuleProjectDirectory}/rewrite.ymlUser Property: rewrite.configLocationAlias: configLocation |
<exclusions> |
LinkedHashSet<String> |
- |
No description. User Property: rewrite.exclusions |
<exportDatatables> |
boolean |
- |
No description. Default: falseUser Property: rewrite.exportDatatables |
<failOnDryRunResults> |
boolean |
- |
Whether to throw an exception if there are any result changes produced. Default: falseUser Property: failOnDryRunResults |
<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: falseUser Property: rewrite.failOnInvalidActiveRecipesAlias: failOnInvalidActiveRecipes |
<metricsPassword> |
String |
- |
No description. User Property: rewrite.metricsPasswordAlias: metricsPassword |
<metricsUri> |
String |
- |
No description. User Property: rewrite.metricsUriAlias: metricsUri |
<metricsUsername> |
String |
- |
No description. User Property: rewrite.metricsUsernameAlias: metricsUsername |
<options> |
LinkedHashSet<String> |
- |
No description. User Property: rewrite.options |
<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.pomCacheDirectoryAlias: pomCacheDirectory |
<pomCacheEnabled> |
boolean |
- |
No description. Default: trueUser Property: rewrite.pomCacheEnabledAlias: pomCacheEnabled |
<recipeArtifactCoordinates> |
LinkedHashSet<String> |
- |
No description. User Property: rewrite.recipeArtifactCoordinates |
<recipeChangeLogLevel> |
LogLevel |
- |
The level used to log changes performed by recipes. Default: WARNUser Property: rewrite.recipeChangeLogLevel |
<reportOutputDirectory> |
String |
- |
No description. User Property: reportOutputDirectory |
<resolvePropertiesInYaml> |
boolean |
- |
No description. Default: trueUser Property: rewrite.resolvePropertiesInYaml |
<rewriteSkip> |
boolean |
- |
No description. Default: falseUser Property: rewrite.skip |
<runPerSubmodule> |
boolean |
- |
No description. Default: falseUser Property: rewrite.runPerSubmoduleAlias: runPerSubmodule |
<sizeThresholdMb> |
int |
- |
No description. Default: 10User 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: falseUser 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
<exclusions>
No description.
- Type:
java.util.LinkedHashSet<java.lang.String> - Required:
No - User Property:
rewrite.exclusions
<exportDatatables>
No description.
- Type:
boolean - Required:
No - User Property:
rewrite.exportDatatables - Default:
false
<failOnDryRunResults>
Whether to throw an exception if there are any result changes produced.
- Type:
boolean - Required:
No - User Property:
failOnDryRunResults - Default:
false
<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
<options>
No description.
- Type:
java.util.LinkedHashSet<java.lang.String> - Required:
No - User Property:
rewrite.options
<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
<recipeArtifactCoordinates>
No description.
- Type:
java.util.LinkedHashSet<java.lang.String> - Required:
No - User Property:
rewrite.recipeArtifactCoordinates
<recipeChangeLogLevel>
The level used to log changes performed by recipes.
- Type:
org.openrewrite.maven.LogLevel - Required:
No - User Property:
rewrite.recipeChangeLogLevel - Default:
WARN
<reportOutputDirectory>
No description.
- Type:
java.lang.String - Required:
No - User Property:
reportOutputDirectory
<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