Change XML attribute of a specific resource version

org.openrewrite.xml.ChangeNamespaceValue

Alters XML Attribute value within specified element of a specific resource versions.

Recipe source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite

• artifactId: rewrite-xml

• version: 8.24.0

Options

Type	Name	Description	Example
String	elementName	Optional. The name of the element whose attribute's value is to be changed. Interpreted as an XPath Expression.	property
String	oldValue	Optional. Only change the property value if it matches the configured oldValue.	newfoo.bar.attribute.value.string
String	newValue	The new value to be used for the namespace.	newfoo.bar.attribute.value.string
String	versionMatcher	Optional. The version of resource to change	1.1
Boolean	searchAllNamespaces	Optional. Specify whether evaluate all namespaces. Defaults to true	true

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.ChangeNamespaceValueExample. 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.ChangeNamespaceValueExample
displayName: Change XML attribute of a specific resource version example
recipeList:
  - org.openrewrite.xml.ChangeNamespaceValue:
      elementName: property
      oldValue: newfoo.bar.attribute.value.string
      newValue: newfoo.bar.attribute.value.string
      versionMatcher: 1.1
      searchAllNamespaces: true

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

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

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

cjobinabo, Jonathan Schnéider, Tim te Beek