Skip to main content

Add Maven dependency

org.openrewrite.maven.AddDependency

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

This recipe is available under the Apache License Version 2.0.

Options​

TypeNameDescriptionExample
StringgroupIdThe first part of a dependency coordinate com.google.guava:guava:VERSION.com.google.guava
StringartifactIdThe second part of a dependency coordinate com.google.guava:guava:VERSION.guava
StringversionAn exact version number or node-style semver selector used to select the version number.29.X
StringversionPatternOptional. 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-jre
StringscopeOptional. A scope to use when it is not what can be inferred from usage. Most of the time this will be left empty, but is used when adding a runtime, provided, or import dependency. Valid options: import, runtime, provided, testruntime
BooleanreleasesOnlyOptional. Whether to exclude snapshots from consideration when using a semver selector
StringonlyIfUsingOptional. Used to determine if the dependency will be added and in which scope it should be placed.org.junit.jupiter.api.*
StringtypeOptional. The type of dependency to add. If omitted Maven defaults to assuming the type is "jar". Valid options: jar, pom, warjar
StringclassifierOptional. A Maven classifier to add. Most commonly used to select shaded or test variants of a librarytest
BooleanoptionalOptional. Set the value of the <optional> tag. No <optional> tag will be added when this is null.
StringfamilyPatternOptional. A pattern, applied to groupIds, used to determine which other dependencies should have aligned version numbers. Accepts '*' as a wildcard character.com.fasterxml.jackson*
BooleanacceptTransitiveOptional. Default false. If enabled, the dependency will not be added if it is already on the classpath as a transitive dependency.true

Examples​

Example 1​
Parameters​
ParameterValue
groupIdcom.google.guava
artifactIdguava
version29.0-jre
versionPatternnull
scopenull
releasesOnlytrue
onlyIfUsingnull
typenull
classifiernull
optionalnull
familyPatternnull
acceptTransitivenull
Before​
pom.xml
<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
</project>
After​
pom.xml
<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
    </dependencies>
</project>
Example 2​
Parameters​
ParameterValue
groupIdcom.fasterxml.jackson.module
artifactIdjackson-module-afterburner
version2.10.5
versionPatternnull
scopenull
releasesOnlytrue
onlyIfUsingnull
typenull
classifiernull
optionalfalse
familyPatternnull
acceptTransitivenull
Before​
pom.xml
<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
</project>
After​
pom.xml
<project>
    <groupId>com.mycompany.app</groupId>
    <artifactId>my-app</artifactId>
    <version>1</version>
    <dependencies>
        <dependency>
            <groupId>com.fasterxml.jackson.module</groupId>
            <artifactId>jackson-module-afterburner</artifactId>
            <version>2.10.5</version>
        </dependency>
        <dependency>
            <groupId>com.google.guava</groupId>
            <artifactId>guava</artifactId>
            <version>29.0-jre</version>
        </dependency>
    </dependencies>
</project>

Usage​

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly (unless you are running them via the Moderne CLI). 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:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddDependencyExample
displayName: Add Maven dependency example
recipeList:
  - org.openrewrite.maven.AddDependency:
      groupId: com.google.guava
      artifactId: guava
      version: 29.X
      versionPattern: '-jre'
      scope: runtime
      onlyIfUsing: org.junit.jupiter.api.*
      type: jar
      classifier: test
      familyPattern: com.fasterxml.jackson*
      acceptTransitive: true

Now that com.yourorg.AddDependencyExample has been defined, activate it in your build file:

  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>6.8.0</version>
        <configuration>
          <exportDatatables>true</exportDatatables>
          <activeRecipes>
            <recipe>com.yourorg.AddDependencyExample</recipe>
          </activeRecipes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>
  1. Run mvn rewrite:run to run the recipe.

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

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.

Data Tables​

Maven metadata failures​

org.openrewrite.maven.table.MavenMetadataFailures

Attempts to resolve maven metadata that failed.

Column NameDescription
Group idThe groupId of the artifact for which the metadata download failed.
Artifact idThe artifactId of the artifact for which the metadata download failed.
VersionThe version of the artifact for which the metadata download failed.
Maven repositoryThe URL of the Maven repository that the metadata download failed on.
SnapshotsDoes the repository support snapshots.
ReleasesDoes the repository support releases.
FailureThe reason the metadata download failed.