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
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:
---
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
- Maven
- Moderne CLI
- Add the following to your
build.gradle
file:
plugins {
id("org.openrewrite.rewrite") version("6.28.1")
}
rewrite {
activeRecipe("com.yourorg.AppendToTextFileExample")
setExportDatatables(true)
}
repositories {
mavenCentral()
}
- Run
gradle rewriteRun
to run the recipe.
- Add the following to your
pom.xml
file:
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.46.1</version>
<configuration>
<exportDatatables>true</exportDatatables>
<activeRecipes>
<recipe>com.yourorg.AppendToTextFileExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
- Run
mvn rewrite:run
to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
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.41.1
See how this recipe works across multiple open-source repositories
Run this recipe on OSS repos at scale with the Moderne SaaS.
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.
Data Tables
Source files that had results
org.openrewrite.table.SourcesFileResults
Source files that were modified by the recipe run.
Column Name | 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 errored on a recipe
org.openrewrite.table.SourcesFileErrors
The details of all errors produced by a recipe run.
Column Name | 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 Name | 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 | The total time spent across the scanning phase of this recipe. |
99th percentile scanning time | 99 out of 100 scans completed in this amount of time. |
Max scanning time | The max time scanning any one source file. |
Cumulative edit time | The total time spent across the editing phase of this recipe. |
99th percentile edit time | 99 out of 100 edits completed in this amount of time. |
Max edit time | The max time editing any one source file. |
Contributors
Jonathan Schnéider, Nick McKinney, Tim te Beek, Maxime Michel, Knut Wannheden, Sam Snyder, Kun Li