Links

Add a comment to an XML tag

org.openrewrite.xml.AddCommentToXmlTag
Adds a comment as the first element in an XML tag.

Recipe source

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

Options

Type
Name
Description
Example
String
xPath
An XPath expression used to find matching tags.
/project/dependencies/dependency
String
commentText
The text to add as a comment..
This is excluded due to CVE <X> and will be removed when we upgrade the next version is available.

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.AddCommentToXmlTagExample. 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.AddCommentToXmlTagExample
displayName: Add a comment to an XML tag example
recipeList:
- org.openrewrite.xml.AddCommentToXmlTag:
xPath: /project/dependencies/dependency
commentText: This is excluded due to CVE <X> and will be removed when we upgrade the next version is available.
Now that com.yourorg.AddCommentToXmlTagExample has been defined activate it in your build file:
Gradle
Maven
Moderne CLI
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.8.4")
}
rewrite {
activeRecipe("com.yourorg.AddCommentToXmlTagExample")
}
repositories {
mavenCentral()
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 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.23.1</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddCommentToXmlTagExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.
You will need to have configured the Moderne CLI on your machine before you can run the following command.
shell
mod run . --recipe AddCommentToXmlTagExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
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