← All recipes
Open source

Rename package name

Recipe IDorg.openrewrite.java.ChangePackage
Artifactorg.openrewrite:rewrite-java

A recipe that will rename a package name in package statements, imports, and fully-qualified types.

Single recipeApache 2.0

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.ChangePackage --recipe-option "oldPackageName=com.yourorg.foo" --recipe-option "newPackageName=com.yourorg.bar"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite:rewrite-java:8.88.0

Options

NameTypeDescription
oldPackageNamerequiredStringThe package name to replace.
e.g. com.yourorg.foo
newPackageNamerequiredStringNew package name to replace the old package name with.
e.g. com.yourorg.bar
recursiveBooleanRecursively change subpackage names

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats