Append to text file

org.openrewrite.text.AppendToTextFile

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.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-core

• version: 8.24.0

Options

Type	Name	Description	Example
String	relativeFileName	File name, using a relative path. If a non-plaintext file already exists at this location, then this recipe will do nothing.	foo/bar/baz.txt
String	content	Multiline text content to be appended to the file.	Some text.
String	preamble	Optional. If a new file is created, this content will be included at the beginning.	# File generated by OpenRewrite #
Boolean	appendNewline	Optional. Print a newline automatically after the content (and preamble). Default true.
Strategy	existingFileStrategy	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. 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. Valid options: Continue, Replace, Leave

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.AppendToTextFileExample. 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.AppendToTextFileExample
displayName: Append to text file example
recipeList:
  - org.openrewrite.text.AppendToTextFile:
      relativeFileName: foo/bar/baz.txt
      content: Some text.
      preamble: # File generated by OpenRewrite #

Now that com.yourorg.AppendToTextFileExample has been defined activate it in your build file:

Gradle

1. Add the following to your build.gradle file:

build.gradle

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

rewrite {
    activeRecipe("com.yourorg.AppendToTextFileExample")
}

repositories {
    mavenCentral()
}

2. Run gradle rewriteRun to run the recipe.

Maven

1. Add the following to your pom.xml file:

pom.xml

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.29.0</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.AppendToTextFileExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

2. Run mvn rewrite:run to run the recipe.

Moderne CLI

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

shell

mod run . --recipe AppendToTextFileExample

See how this recipe works across multiple open-source repositories

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.

Contributors

Jonathan Schnéider, Nick McKinney, Maxime Michel, Knut Wannheden, Sam Snyder, Kun Li, Tim te Beek