Rename package name
org.openrewrite.java.ChangePackage A recipe that will rename a package name in package statements, imports, and fully-qualified types.

Source

    groupId: org.openrewrite
    artifactId: rewrite-java
    version: 7.15.0

Options

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

Usage

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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.ChangePackageExample
4
displayName: Rename package name example
5
recipeList:
6
- org.openrewrite.java.ChangePackage:
7
oldPackageName: com.yourorg.foo
8
newPackageName: com.yourorg.bar
9
recursive: true
Copied!
Now that com.yourorg.ChangePackageExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
id("org.openrewrite.rewrite") version("5.12.0")
3
}
4
5
rewrite {
6
activeRecipe("com.yourorg.ChangePackageExample")
7
}
8
9
repositories {
10
mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
<build>
3
<plugins>
4
<plugin>
5
<groupId>org.openrewrite.maven</groupId>
6
<artifactId>rewrite-maven-plugin</artifactId>
7
<version>4.13.0</version>
8
<configuration>
9
<activeRecipes>
10
<recipe>com.yourorg.ChangePackageExample</recipe>
11
</activeRecipes>
12
</configuration>
13
</plugin>
14
</plugins>
15
</build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -DactiveRecipe=com.yourorg.ChangePackageExample
Last modified 10d ago
Export as PDF
Copy link