← All recipes
Open source

Move a file

Recipe IDorg.openrewrite.MoveFileArtifactorg.openrewrite:rewrite-core

Move a file to a different directory. The file name will remain the same.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.MoveFile")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-core:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

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

mod run . --recipe org.openrewrite.MoveFile --recipe-option "moveTo=../yamls/"

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

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

Options

NameTypeDescription
folderStringWhen using the folder option, all files / subfolders in the folder will be moved to the moveTo source path. Folder should be starting at root
e.g. src/main/resources/
fileMatcherStringMatching files will be moved. This is a glob expression.
e.g. **/*.yml
moveTorequiredStringEither a relative or absolute path. If relative, it is relative to the current file's directory.
e.g. ../yamls/

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