Easily use any BOM as a Gradle Version Catalog.
First, add your BOM dependencies to your version catalog
libs.versions.toml
[versions]
spring = "3.2.0"
aws = "2.22.0"
[libraries]
awsBom = { group = "software.amazon.awssdk", name = "bom", version.ref = "aws" }
springBootDependencies = { group = "org.springframework.boot", name = "spring-boot-dependencies", version.ref = "spring" }Then, add the plugin to your settings with the catalogs you want to generate
settings.gradle.kts
import dev.aga.gradle.versioncatalogs.Generator.generate
plugins {
id("dev.aga.gradle.version-catalog-generator") version("4.0.0")
}
dependencyResolutionManagement {
repositories {
mavenCentral() // (1)
}
versionCatalogs {
create("libs") { // (2)
from(files("gradle/libs.versions.toml"))
}
generate("libs") { // (3)
fromToml("springBootDependencies") { // (4)
propertyOverrides = mapOf(
"jackson-bom.version" to "2.16.1", // (5)
"mockito.version" to versionRef("mockito"), // (6)
)
generateBomEntry = true // (7)
}
}
generate("awsLibs") {
fromToml("awsBom") {
aliasPrefixGenerator = GeneratorConfig.NO_PREFIX // (8)
}
}
generate("manyLibs") {
using { // (9)
aliasPrefixGenerator = GeneratorConfig.NO_PREFIX
}
fromToml("aws-bom", "jackson-bom") { // (10)
aliasSuffixGenerator = { prefix, groupId, artifactId -> // (11)
val trimmed = artifactId.replaceFirst("junit-", "").replaceFirst("jackson-", "")
GeneratorConfig.DEFAULT_ALIAS_SUFFIX_GENERATOR(prefix, groupId, trimmed)
}
}
from("org.springframework.boot:spring-boot-dependencies:3.4.1") { // (12)
aliasPrefixGenerator = GeneratorConfig.DEFAULT_ALIAS_PREFIX_GENERATOR // (13)
}
}
}
}-
Must include repositories here for dependency resolution to work from settings
-
If you want to append to an existing catalog, you must declare it before using it in a generate block (even if it’s the default
libs.versions.toml) -
The name of the generated catalog. If a catalog with that name already exists, the entries will be appended to it. Otherwise, a new catalog will be created.
-
The name of the bom library in the version catalog
-
Optionally override some version properties using a literal value
-
Or, you can reference version aliases in the source TOML
-
Optionally generate an entry in the catalog for the BOM itself
-
All dependencies in the AWS BOM are for AWS so we can skip the prefix
-
Set the default generation options that will apply to all sources unless overridden
-
Include all dependencies from both
aws-bomandjackson-bom -
Override the default
aliasSuffixGeneratorfor dependencies in these two BOMs -
Also include all dependencies from the
spring-boot-dependenciesBOM in the generated catalog -
Override the default
aliasPrefixGeneratorfor dependencies in the spring BOM
Lastly, use the dependencies in your build
build.gradle.kts
dependencies {
implementation(awsLibs.s3)
implementation(awsLibs.dynamodb)
implementation(libs.spring.springBootStarterWeb)
implementation(libs.jackson.jacksonDatabind)
implementation(manyLibs.sts)
implementation(manyLibs.databind)
implementation(manyLibs.spring.springBootStarterJdbc)
}