Package org.openrewrite.maven

Class InitMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.openrewrite.maven.ConfigurableRewriteMojo

org.openrewrite.maven.AbstractRewriteMojo

org.openrewrite.maven.InitMojo

All Implemented Interfaces:

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

@Mojo(name="init",
      threadSafe=true)
@Execute
public class InitMojo
extends AbstractRewriteMojo

Add rewrite-maven-plugin (or any other plugin) to the project.
For example:
./mvnw rewrite:init -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
protected boolean	rootOnly
protected String	version

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
InitMojo()

Method Summary

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

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 Details

groupId

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

artifactId

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

version

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

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

rootOnly

@Parameter(property="rootOnly",
           defaultValue="true")
protected boolean rootOnly

Constructor Details

InitMojo

public InitMojo()

Method Details

execute

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

Throws:

org.apache.maven.plugin.MojoExecutionException

getVersion

protected String getVersion()

getConfiguration

@Nullable
protected String getConfiguration()

getExecutions

@Nullable
protected String getExecutions()