Change XML Attribute

** org.openrewrite.xml.ChangeTagAttribute** Alters XML Attribute value within specified element.
Source
​Github, Issue Tracker, Maven Central​
groupId: org.openrewrite
artifactId: rewrite-xml
version: 7.24.0
Options
Type
Name
Description
String
elementName
The name of the element whose attribute's value is to be changed. Interpreted as an XPath Expression.
String
attributeName
The name of the attribute whose value is to be changed.
String
newValue
The new value to be used for key specified by attributeName.
String
oldValue
Optional. Only change the property value if it matches the configured oldValue.
String
fileMatcher
Optional. If provided only matching files will be modified. This is a glob expression.
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
1
---
2
type: specs.openrewrite.org/v1beta/recipe
3
name: com.yourorg.ChangeTagAttributeExample
4
displayName: Change XML Attribute example
5
recipeList:
6
  - org.openrewrite.xml.ChangeTagAttribute:
7
      elementName: property
8
      attributeName: name
9
      newValue: newfoo.bar.attribute.value.string
10
      oldValue: foo.bar.attribute.value.string
11
      fileMatcher: '**/application-*.xml'
Copied!
Now that com.yourorg.ChangeTagAttributeExample has been defined activate it in your build file:
Gradle
Maven
build.gradle
1
plugins {
2
    id("org.openrewrite.rewrite") version("5.22.2")
3
}
4
​
5
rewrite {
6
    activeRecipe("com.yourorg.ChangeTagAttributeExample")
7
}
8
​
9
repositories {
10
    mavenCentral()
11
}
Copied!
pom.xml
1
<project>
2
  <build>
3
    <plugins>
4
      <plugin>
5
        <groupId>org.openrewrite.maven</groupId>
6
        <artifactId>rewrite-maven-plugin</artifactId>
7
        <version>4.25.3</version>
8
        <configuration>
9
          <activeRecipes>
10
            <recipe>com.yourorg.ChangeTagAttributeExample</recipe>
11
          </activeRecipes>
12
        </configuration>
13
      </plugin>
14
    </plugins>
15
  </build>
16
</project>
Copied!
Recipes can also be activated directly from the commandline by adding the argument -Drewrite.activeRecipescom.yourorg.ChangeTagAttributeExample

Add a comment to a XML tag

Remove trailing whitespace

Last modified 8d ago

Export as PDF

Copy link

Contents

Source

Options

Usage