Built by Maven

rewrite:recipeCsvGenerate

Full name:

org.openrewrite.maven:rewrite-maven-plugin:6.31.0-SNAPSHOT:recipeCsvGenerate

Description:

Generate a recipes.csv marketplace file from the recipes found in this project. Scans compiled classes and resources in target/classes/ for recipe definitions (both Java class-based and YAML declarative recipes) and writes the result to src/main/resources/META-INF/rewrite/recipes.csv.

If an existing recipes.csv is present, generated data is merged into it, preserving any manually added entries.

./mvnw rewrite:recipeCsvGenerate

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • The goal is thread-safe and supports parallel builds.
  • Invokes the execution of the following lifecycle phase prior to executing itself: process-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.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
<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
<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
<recipeArtifactCoordinates> LinkedHashSet<String> - No description.
User Property: rewrite.recipeArtifactCoordinates
<resolvePropertiesInYaml> boolean - Whether to resolve properties in YAML configuration files, like${project.artifactId }. Default true; set to false to disable.
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

<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

<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

<resolvePropertiesInYaml>

Whether to resolve properties in YAML configuration files, like${project.artifactId }. Default true; set to false to disable.
  • 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