Open source

Append to text file

Recipe IDorg.openrewrite.text.AppendToTextFile

Artifactorg.openrewrite:rewrite-core

Appends or replaces content of an existing plain text file, or creates a new one if it doesn't already exist. Please note that this recipes requires existing plain text files' format to be successfully parsable by OpenRewrite. If a file is left unchanged, it might be parsed as a Quark rather than plain text. In such case, use the plainTextMask option. See the Gradle or Maven plugin configuration page.

Single recipeOpenRewriteApache License Version 2.0

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

5 parameters

2 required3 optional

Parameter	Example	Type	Required
content	Some text.	String	Required
Multiline text content to be appended to the file.
relativeFileName	foo/bar/baz.txt	String	Required
File name, using a relative path. May also be a glob expression (e.g. **/*.txt) to match one or more existing files; when a glob is supplied no new file is created. If a non-plaintext file matches, that file is left unchanged.
appendNewline	—	Boolean	Optional
Print a newline automatically after the content (and preamble). Default true.
existingFileStrategy	—	Strategy	Optional
Determines behavior if a file exists at this location prior to Rewrite execution. - Continue: append new content to existing file contents. If existing file is not plaintext, recipe does nothing. - Replace: remove existing content from file. - Leave: *(default)* do nothing. Existing file is fully preserved. - Merge: append only lines from new content that are not already present in the file. Lines are compared line-by-line after trimming whitespace. Preserves existing line order. Note: this only affects the first interaction with the specified file per Rewrite execution. Subsequent instances of this recipe in the same Rewrite execution will always append.
preamble	# File generated by OpenRewrite #	String	Optional
If a new file is created, this content will be included at the beginning.

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe AppendToTextFile --recipe-option "relativeFileName=foo/bar/baz.txt" --recipe-option "content=Some text." --recipe-option "preamble=# File generated by OpenRewrite #"

If the recipe is not available locally, then you can install it using:

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

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.