Rename package name
org.openrewrite.java.ChangePackage A recipe that will rename a package name in package statements, imports, and fully-qualified types.
- groupId: org.openrewrite
- artifactId: rewrite-java
- version: 7.35.0
Type | Name | Description |
---|---|---|
String | oldPackageName | The package name to replace. |
String | newPackageName | New package name to replace the old package name with. |
Boolean | recursive | Optional. Recursively change subpackage names |
This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example:
com.yourorg.ChangePackageExample
. Here's how you can define and customize such a recipe within your rewrite.yml:rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangePackageExample
displayName: Rename package name example
recipeList:
- org.openrewrite.java.ChangePackage:
oldPackageName: com.yourorg.foo
newPackageName: com.yourorg.bar
recursive: true
Now that
com.yourorg.ChangePackageExample
has been defined activate it in your build file:Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.34.0")
}
rewrite {
activeRecipe("com.yourorg.ChangePackageExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.39.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.ChangePackageExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument
-Drewrite.activeRecipes=com.yourorg.ChangePackageExample
The Moderne public SaaS instance enables you to easily run recipes across thousands of open-source repositories.
Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.
Last modified 13d ago