changetext.md

Change text

org.openrewrite.text.ChangeText

Completely replaces the contents of the text file with other text.

Tags

• plain text

Source

GitHub, Issue Tracker, Maven Central

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

Options

Type	Name	Description
String	toText	The text file will have only this text after the change.

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.ChangeTextExample. 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.ChangeTextExample
displayName: Change text example
recipeList:
  - org.openrewrite.text.ChangeText:
      toText: Some text.

{% endcode %}

Now that com.yourorg.ChangeTextExample 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.ChangeTextExample")
}

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.ChangeTextExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

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

Contributors

• Jonathan Leitschuh
• Jonathan Schnéider
• Sam Snyder

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.