Change XML tag value

org.openrewrite.xml.ChangeTagValue

Alters the value of XML tags matching the provided expression.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite

  • artifactId: rewrite-xml

  • version: 8.21.0

Options

TypeNameDescriptionExample

String

elementName

The name of the element whose value is to be changed. Interpreted as an XPath Expression.

/settings/servers/server/username

String

oldValue

Optional. The old value of the tag.

user

String

newValue

The new value for the tag.

user

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.ChangeTagValueExample. 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.ChangeTagValueExample
displayName: Change XML tag value example
recipeList:
  - org.openrewrite.xml.ChangeTagValue:
      elementName: /settings/servers/server/username
      oldValue: user
      newValue: user

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

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

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.10.0")
}

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

repositories {
    mavenCentral()
}
  1. Run gradle rewriteRun to run the recipe.

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

Mark Brophy, Jonathan Schnéider, Tim te Beek

Last updated