Built by Maven

rewrite:run

Full name:

org.openrewrite.maven:rewrite-maven-plugin:5.31.0-SNAPSHOT:run

Description:

Run the configured recipes and apply the changes locally.

This variant of rewrite:run 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
<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
<deprecatedActiveRecipes> LinkedHashSet<String> -
Deprecated.
Use rewrite.activeRecipes instead.

No description.
User Property: activeRecipes
<deprecatedActiveStyles> LinkedHashSet<String> -
Deprecated.
Use rewrite.activeStyles instead.

No description.
User Property: activeStyles
<deprecatedExclusions> LinkedHashSet<String> -
Deprecated.
Use rewrite.exclusions instead.

No description.
User Property: exclusions
<deprecatedPlainTextMasks> LinkedHashSet<String> -
Deprecated.
No reason given

No description.
User Property: plainTextMasks
<exclusions> LinkedHashSet<String> - No description.
User Property: rewrite.exclusions
<exportDatatables> boolean - No description.
Default: false
User Property: rewrite.exportDatatables
<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 improperly 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> - No description.
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
<recipeArtifactCoordinates> LinkedHashSet<String> - No description.
User Property: rewrite.recipeArtifactCoordinates
<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

<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

<deprecatedActiveRecipes>

Deprecated.
Use rewrite.activeRecipes instead.

No description.
  • Type: java.util.LinkedHashSet<java.lang.String>
  • Required: No
  • User Property: activeRecipes

<deprecatedActiveStyles>

Deprecated.
Use rewrite.activeStyles instead.

No description.
  • Type: java.util.LinkedHashSet<java.lang.String>
  • Required: No
  • User Property: activeStyles

<deprecatedExclusions>

Deprecated.
Use rewrite.exclusions instead.

No description.
  • Type: java.util.LinkedHashSet<java.lang.String>
  • Required: No
  • User Property: exclusions

<deprecatedPlainTextMasks>

Deprecated.
No reason given

No description.
  • Type: java.util.LinkedHashSet<java.lang.String>
  • Required: No
  • User Property: plainTextMasks

<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

<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 improperly 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>

No description.
  • 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

<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