removexmltag.md

Remove XML Tag

org.openrewrite.xml.RemoveXmlTag

Removes XML tags matching the provided expression.

Source

GitHub, Issue Tracker, Maven Central

• groupId: org.openrewrite
• artifactId: rewrite-xml
• version: 8.1.3

Options

Type	Name	Description
String	xPath	An XPath expression used to find matching tags.
String	fileMatcher	Optional. If provided only matching files will be modified. This is a glob expression.

Example

Parameters

Parameter	Value
xPath	//bean
fileMatcher	**/beans.xml

{% tabs %} {% tab title="my/project/beans.xml" %}

Before

{% code title="my/project/beans.xml" %}

<beans>
    <bean id='myBean.subpackage.subpackage2'/>
    <other id='myBean.subpackage.subpackage2'/>
</beans>

{% endcode %}

After

{% code title="my/project/beans.xml" %}

<beans>
    <other id='myBean.subpackage.subpackage2'/>
</beans>

{% endcode %}

{% endtab %} {% tab title="Diff" %} {% code %}

--- my/project/beans.xml
+++ my/project/beans.xml
@@ -2,1 +2,0 @@
<beans>
-   <bean id='myBean.subpackage.subpackage2'/>
    <other id='myBean.subpackage.subpackage2'/>

{% endcode %} {% endtab %} {% endtabs %}

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.RemoveXmlTagExample. Here's how you can define and customize such a recipe within your rewrite.yml:

{% code title="rewrite.yml" %}

---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.RemoveXmlTagExample
displayName: Remove XML Tag example
recipeList:
  - org.openrewrite.xml.RemoveXmlTag:
      xPath: /project/dependencies/dependency
      fileMatcher: '**/application-*.xml'

{% endcode %}

Now that com.yourorg.RemoveXmlTagExample has been defined activate it in your build file: {% tabs %} {% tab title="Gradle" %} {% code title="build.gradle" %}

plugins {
    id("org.openrewrite.rewrite") version("6.1.4")
}

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

repositories {
    mavenCentral()
}

{% endcode %} {% endtab %} {% tab title="Maven" %} {% code title="pom.xml" %}

<project>
  <build>
    <plugins>
      <plugin>
        <groupId>org.openrewrite.maven</groupId>
        <artifactId>rewrite-maven-plugin</artifactId>
        <version>5.2.4</version>
        <configuration>
          <activeRecipes>
            <recipe>com.yourorg.RemoveXmlTagExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

{% endcode %} {% endtab %} {% endtabs %}

Contributors

• Mark Brophy
• Jonathan Schnéider

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.