Links

Add a comment to a Maven dependency

org.openrewrite.maven.AddCommentToMavenDependency
Adds a comment as the first element in a Maven dependency.

Source

  • groupId: org.openrewrite
  • artifactId: rewrite-maven
  • version: 8.6.0

Options

Type
Name
Description
String
xPath
An XPath expression used to find matching tags.
String
groupId
The first part of a dependency coordinate com.google.guava:guava:VERSION.
String
artifactId
The second part of a dependency coordinate com.google.guava:guava:VERSION.
String
commentText
The text to add as a comment..

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.AddCommentToMavenDependencyExample. 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.AddCommentToMavenDependencyExample
displayName: Add a comment to a `Maven` dependency example
recipeList:
- org.openrewrite.maven.AddCommentToMavenDependency:
xPath: /project/dependencies/dependency
groupId: com.google.guava
artifactId: guava
commentText: This is excluded due to CVE <X> and will be removed when we upgrade the next version is available.
Now that com.yourorg.AddCommentToMavenDependencyExample has been defined activate it in your build file:
Maven
  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.5.2</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddCommentToMavenDependencyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.

Contributors

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.