Links

Rename a file

org.openrewrite.RenameFile
Rename a file while keeping it in the same directory.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-core
  • version: 7.40.6

Contributors

Options

Type
Name
Description
String
fileMatcher
Matching files will be renamed. This is a glob expression.
String
fileName
Just the file name without the folder path that precedes it.

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.RenameFileExample. 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.RenameFileExample
displayName: Rename a file example
recipeList:
- org.openrewrite.RenameFile:
fileMatcher: '**/application-*.yml'
fileName: application.yml
Now that com.yourorg.RenameFileExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.40.4")
}
rewrite {
activeRecipe("com.yourorg.RenameFileExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.45.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.RenameFileExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.