Change XML attribute

org.openrewrite.xml.ChangeTagAttribute

Alters XML attribute value on a specified element.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-xml

• version: 8.24.0

Options

Type	Name	Description	Example
String	elementName	The name of the element whose attribute's value is to be changed. Interpreted as an XPath expression.	property
String	attributeName	The name of the attribute whose value is to be changed.	name
String	newValue	The new value to be used for key specified by attributeName, Set to null if you want to remove the attribute.	newfoo.bar.attribute.value.string
String	oldValue	Optional. Only change the property value if it matches the configured oldValue.	foo.bar.attribute.value.string
Boolean	regex	Optional. Default false. If true, oldValue will be interpreted as a Regular Expression, and capture group contents will be available in newValue.

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.ChangeTagAttributeExample. 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.ChangeTagAttributeExample
displayName: Change XML attribute example
recipeList:
  - org.openrewrite.xml.ChangeTagAttribute:
      elementName: property
      attributeName: name
      newValue: newfoo.bar.attribute.value.string
      oldValue: foo.bar.attribute.value.string

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

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.ChangeTagAttributeExample</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 ChangeTagAttributeExample

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, Adriano Machado, Kun Li, Jonathan Schnéider, Sam Snyder, Tim te Beek