Rename package name

org.openrewrite.java.ChangePackage
A recipe that will rename a package name in package statements, imports, and fully-qualified types.
Source
​GitHub, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-java
version: 8.6.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
---
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: null
Now that com.yourorg.ChangePackageExample has been defined activate it in your build file:
Gradle
Maven
1.Add the following to your build.gradle file:
build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.3.11")
}
​
rewrite {
    activeRecipe("com.yourorg.ChangePackageExample")
}
​
repositories {
    mavenCentral()
}
2.Run gradle rewriteRun to run the recipe.
1.Add the following to your pom.xml file:
pom.xml
<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.5.2</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.ChangePackageExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
2.Run mvn rewrite:run to run the recipe.
Contributors
​Tracey Yoshima​
​Jonathan Schnéider​
​Knut Wannheden​
​Nick McKinney​
​Patrick​
​Sam Snyder​
Patrick Way
​Roberto Cortez​
See how this recipe works across multiple open-source repositories
​​
​​
The community edition of the Moderne platform 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.

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

Remove unused imports

Reorder method arguments

Last modified 5d ago