← All recipes
Open source

Create text file

Recipe IDorg.openrewrite.text.CreateTextFile
Artifactorg.openrewrite:rewrite-core

Creates a new plain text file.

Single recipeApache 2.0

Usage

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

mod run . --recipe org.openrewrite.text.CreateTextFile --recipe-option "fileContents=Some text." --recipe-option "relativeFileName=foo/bar/baz.txt"

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

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

Options

NameTypeDescription
fileContentsrequiredStringMultiline text content for the file.
e.g. Some text.
relativeFileNamerequiredStringFile path of new file.
e.g. foo/bar/baz.txt
overwriteExistingBooleanIf there is an existing file, should it be overwritten.

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