Add Gradle or Maven dependency
org.openrewrite.java.dependencies.AddDependency
For a Gradle project, add a gradle dependency to a build.gradle
file in the correct configuration based on where it is used. Or For a maven project, Add a Maven dependency to a pom.xml
file in the correct scope based on where it is used.
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-java-dependencies
version: 1.7.0
Options
Type | Name | Description | Example |
---|---|---|---|
| groupId | The first part of a dependency coordinate |
|
| artifactId | The second part of a dependency coordinate |
|
| version | Optional. An exact version number or node-style semver selector used to select the version number. |
|
| versionPattern | Optional. Allows version selection to be extended beyond the original Node Semver semantics. So for example, Setting 'version' to "25-29" can be paired with a metadata pattern of "-jre" to select Guava 29.0-jre |
|
| onlyIfUsing | Optional. Used to determine if the dependency will be added and in which scope it should be placed. |
|
| classifier | Optional. A classifier to add. Commonly used to select variants of a library. |
|
| familyPattern | Optional. A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character. |
|
| extension | Optional. For Gradle only, The extension of the dependency to add. If omitted Gradle defaults to assuming the type is "jar". |
|
| configuration | Optional. The Gradle dependency configuration name within which to place the dependency. When omitted the configuration will be determined by the Maven scope parameter. If that parameter is also omitted, configuration will be determined based on where types matching |
|
| scope | Optional. The Maven scope within which to place the dependency. When omitted scope will be determined based on where types matching |
|
| releasesOnly | Optional. For Maven only, Whether to exclude snapshots from consideration when using a semver selector | |
| type | Optional. For Maven only, The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". Valid options: |
|
| optional | Optional. Set the value of the | |
| acceptTransitive | Optional. Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency. |
|
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.AddDependencyExample
. Here's how you can define and customize such a recipe within your rewrite.yml:
Now that com.yourorg.AddDependencyExample
has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-java-dependencies:1.7.0 in your build file:
Add the following to your
build.gradle
file:
Run
gradle rewriteRun
to run the recipe.
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.
Last updated