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

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
String	newVersion	The new version of the resource	2.0
String	newSchemaLocation	Optional. The new value to be used for the namespace schema location.	newfoo.bar.attribute.value.string

License

This recipe is available under the Apache License 2.0.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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
      newVersion: 2.0
      newSchemaLocation: newfoo.bar.attribute.value.string

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.28.3")
}

rewrite {
    activeRecipe("com.yourorg.ChangeNamespaceValueExample")
    setExportDatatables(true)
}

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.47.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <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 ChangeNamespaceValue --recipe-option "elementName=property" --recipe-option "oldValue=newfoo.bar.attribute.value.string" --recipe-option "newValue=newfoo.bar.attribute.value.string" --recipe-option "versionMatcher=1.1" --recipe-option "searchAllNamespaces=true" --recipe-option "newVersion=2.0" --recipe-option "newSchemaLocation=newfoo.bar.attribute.value.string"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite:rewrite-xml:8.42.0

See how this recipe works across multiple open-source repositories

Run this recipe on OSS repos at scale with the Moderne SaaS.

Run this recipe here

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.

Data Tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column Name	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column Name	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column Name	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time	The total time spent across the scanning phase of this recipe.
99th percentile scanning time	99 out of 100 scans completed in this amount of time.
Max scanning time	The max time scanning any one source file.
Cumulative edit time	The total time spent across the editing phase of this recipe.
99th percentile edit time	99 out of 100 edits completed in this amount of time.
Max edit time	The max time editing any one source file.

Contributors

cjobinabo, Adriano Machado, Sam Snyder, Tim te Beek, Jonathan Schnéider