Add a comment to a Maven dependency
org.openrewrite.maven.AddCommentToMavenDependency Adds a comment as the first element in a
Maven dependency.- groupId: org.openrewrite
- artifactId: rewrite-maven
- version: 7.38.0
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.. |
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:Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.38.0")
}
rewrite {
activeRecipe("com.yourorg.AddCommentToMavenDependencyExample")
}
repositories {
mavenCentral()
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.42.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddCommentToMavenDependencyExample</recipe>
</activeRecipes>
</configuration>
</plugin>
</plugins>
</build>
</project>
The Moderne public SaaS instance 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.
Last modified 5h ago