← All recipes
Open source

Rename a file

Recipe IDorg.openrewrite.RenameFile
Artifactorg.openrewrite:rewrite-core

Rename a file while keeping it in the same directory.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.RenameFile --recipe-option "fileMatcher=**/application-*.yml" --recipe-option "fileName=application.yml"

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

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

Options

NameTypeDescription
fileMatcherrequiredStringMatching files will be renamed. This is a glob expression.
e.g. **/application-*.yml
fileNamerequiredStringJust the file name without the folder path that precedes it.
e.g. application.yml

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