← All recipes
Open source

Add a comment to an XML tag

Recipe IDorg.openrewrite.xml.AddCommentToXmlTagArtifactorg.openrewrite:rewrite-xml

Adds a comment as the first element in an XML tag.

Single recipeApache 2.0

Add to your build

Get a download tokenSign in with GitHub or Google, and your token replaces YOUR_DOWNLOAD_TOKEN below. Free for open source recipes like this one.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

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

rewrite {
    activeRecipe("org.openrewrite.xml.AddCommentToXmlTag")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite:rewrite-xml:8.92.8")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.xml.AddCommentToXmlTag --recipe-option "xPath=/project/dependencies/dependency" --recipe-option "commentText=This is excluded due to CVE <X> and will be removed when we upgrade the next version is available."

If the recipe isn’t available locally, install it with:

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

Options

NameTypeDescription
xPathrequiredStringAn XPath expression used to find matching tags.
e.g. /project/dependencies/dependency
commentTextrequiredStringThe text to add as a comment..
e.g. This is excluded due to CVE <X> and will be removed when we upgrade the next version is available.

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats