Package org.openrewrite.maven

Class ConfigureMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.openrewrite.maven.ConfigurableRewriteMojo

org.openrewrite.maven.AbstractRewriteMojo

org.openrewrite.maven.ConfigureMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="configure",
      threadSafe=true)
@Execute
public class ConfigureMojo
extends AbstractRewriteMojo

Configure rewrite-maven-plugin (or any other plugin) in the project.
For example:
./mvnw rewrite:configure -DactiveRecipes=org.openrewrite.java.spring.boot2.SpringBoot1To2Migration -Ddependencies=org.openrewrite.recipe:rewrite-spring:4.17.0

Nested Class Summary

Nested classes/interfaces inherited from class org.openrewrite.maven.AbstractRewriteMojo

AbstractRewriteMojo.ResultsContainer

Field Summary

Fields

Modifier and Type	Field	Description
protected String	artifactId
protected String	configuration
protected String	dependencies
protected String	executionGoals
protected String	executionPhase
protected String	groupId

Fields inherited from class org.openrewrite.maven.AbstractRewriteMojo

mavenSession, project, repositorySystem, runtime, settingsDecrypter

Fields inherited from class org.openrewrite.maven.ConfigurableRewriteMojo

checkstyleConfigFile, failOnInvalidActiveRecipes, metricsPassword, metricsUri, metricsUsername, pomCacheDirectory, pomCacheEnabled, runPerSubmodule, sizeThresholdMb, skipMavenParsing

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ConfigureMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()
protected String	getConfiguration()
protected String	getExecutions()

Methods inherited from class org.openrewrite.maven.AbstractRewriteMojo

environment, executionContext, getBaseDir, getRecipeClassloader, getRecipeDescriptor, listResults, logRecipesThatMadeChanges

Methods inherited from class org.openrewrite.maven.ConfigurableRewriteMojo

getActiveRecipes, getActiveStyles, getExclusions, getRecipeArtifactCoordinates

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

groupId

@Parameter(property="groupId",
           defaultValue="org.openrewrite.maven")
protected String groupId

artifactId

@Parameter(property="artifactId",
           defaultValue="rewrite-maven-plugin")
protected String artifactId

configuration

@Parameter(property="configuration")
@Nullable
protected String configuration

dependencies

@Parameter(property="dependencies")
@Nullable
protected String dependencies

executionPhase

@Parameter(property="executionPhase")
@Nullable
protected String executionPhase

executionGoals

@Parameter(property="executionGoals")
@Nullable
protected String executionGoals

Constructor Detail

ConfigureMojo

public ConfigureMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getConfiguration

@Nullable
protected String getConfiguration()

getExecutions

@Nullable
protected String getExecutions()