Question I wanted to parse manually the file `gradle libs ve Gradle Community #plugin-development

Question: I wanted to parse manually the file `gr...

jmfayard

02/12/2022, 4:02 PM

Question: I wanted to parse manually the file

gradle/libs.versions.toml

for my plugin refreshVersions But I noticed that there is version catalog API available in

build.gradle.kts

Copy code

// build.gradle.kts
val versionCatalog = extensions.getByType<VersionCatalogsExtension>().named("libs")
println("Library aliases: ${versionCatalog.libraryAliases}")

Exactly what I need! But if I put the same code in my plugin:

Copy code

open class RefreshVersionsMigrateTask : DefaultTask() {

    @TaskAction
    fun versionsCatalog() {
        val versionCatalog = extensions.getByType<VersionCatalogsExtension>().named("libs")
        println("Library aliases: ${versionCatalog.dependencyAliases}")
    }
}

Then I get:

Execution failed for task ':refreshVersionsMigrate'.

Extension of type 'VersionCatalogsExtension' does not exist. Currently registered extension types: [ExtraPropertiesExtension]

Is there a way to make it work or should I parse the file

libs.versions.toml

manually?

Vampire

02/12/2022, 4:07 PM

Besides that it is not the same code (

libraryAliases

vs.

dependencyAliases

), you just call it on the wrong object.

Vampire

02/12/2022, 4:08 PM

You look in the

extensions

of the

Task

which also is

ExtensionAware

but does not have the extension you are after and if you query

extensions

explicitly there is no delegation strategy.

Vampire

02/12/2022, 4:08 PM

Use

project.extensions

and it should work just fine.

Vampire

02/12/2022, 4:09 PM

Maybe someone should post a feature request to add the

ExtensionAware

instance to the error message, I also fell into that trap a few times already.

melix

02/12/2022, 4:09 PM

You should look at what I'm doing here: https://github.com/micronaut-projects/micronaut-build/tree/master/src/main/java/io/micronaut/build/catalogs

melix

02/12/2022, 4:10 PM

I don't think using the API you mention is going to help you because it represents a realized catalog. Typically won't give you where a version is defined.

jmfayard

02/12/2022, 5:04 PM

It works, thanks a lot to you both!

jmfayard

02/12/2022, 5:08 PM

I don't think using the API you mention is going to help you because it represents a realized catalog.

That's fine, I'm not modifying the file

libs.versions.toml

, I'm using its content to rewrite the files

build.gradle(.kts)

https://github.com/jmfayard/gradle-versions-catalog/commit/c9f9dfe12861ea409c06416fc2d25f150067e9fb

melix

02/12/2022, 8:38 PM

mmm, having the versions in a separate file kind of defeats the concept, no?

jmfayard

02/12/2022, 8:56 PM

Generating the

libs.versions.toml

and updating the

build.gradle(.kts)

is half of the work of integrating refreshVersions and the versions catalog. The second half will be that refreshVersions add the available versions updates as comments in the

libs.versions.toml

directly, if the versions are present there.

Open in Slack

Previous Next