appendtotextfile.md

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.

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	relativeFileName	File name, using a relative path. If a non-plaintext file already exists at this location, then this recipe will do nothing.
String	content	Multiline text content to be appended to the file.
String	preamble	Optional. If a new file is created, this content will be included at the beginning.
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. |

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:

{% code title="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 #
      appendNewline: null
      existingFileStrategy: null

{% endcode %}

Now that com.yourorg.AppendToTextFileExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

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

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

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

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

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Jonathan Schnéider
• Nick McKinney
• Knut Wannheden
• Kun Li

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.