Hello devs, I'm migrating all my gradle scripts from groovy to kotlin, and finding myself in a dead ...

# gradle

[Xavier F. Gouchet]

Hello devs, I'm migrating all my gradle scripts from groovy to kotlin, and finding myself in a dead end it seems. Most of it is working well, but I used to have a single script to configure specific plugins, eg detekt.gradle that would apply the same detekt config to all projects needing it.
Now when I try to do that, I can still use the apply(from("path/to/detekt.settings.gradle.kts")), but apparently anything I put in the settings script doesn't have the usual imports, and cannot resolve any of the extensions.

[Xavier F. Gouchet]

My detekt.settings.gradle.kts have this inside :

detekt {
    version = "1.0.1"

    input = files("$projectDir/src/main/kotlin")
    config = files("$project.rootDir/script/config/detekt.yml")
    reports {
        xml {
            enabled = true
            destination = file("build/reports/detekt.xml")
        }
    }
}

[Xavier F. Gouchet]

And if I copy paste it directly in a module's script, it works, but through the apply from it doesn't, and I get a > Unresolved reference: detekt

[tapchicoma]

I would advice you to move logic to buildSrc module: https://docs.gradle.org/current/userguide/organizing_gradle_projects.html#sec:build_sources

And create extension function for Project something like this: https://github.com/gradle/kotlin-dsl-samples/blob/master/samples/multi-kotlin-project-with-buildSrc/buildSrc/src/main/kotlin/utils.kt

[Xavier F. Gouchet]

That does make sense to use buildSrc for that

[Xavier F. Gouchet]

Thanks @tapchicoma

[Xavier F. Gouchet]

Well unfortunately, to be able to configur especific plugins, I need to be able tu use the dsl generated by them, which is not possible at compile time from the buildSrc folder.

[Xavier F. Gouchet]

Or there is a trick to do that

[tapchicoma]

I think you need to add 3rd party plugin as a dependency to your buildSrc

[Xavier F. Gouchet]

Indeed that does work 🙂

[Xavier F. Gouchet]

Thanks

[pg]

@Xavier F. Gouchet can you share gist or something how you setup detekt in buildSrc ? It's exactly what I tried to achieve yesterday without success 😓

[Xavier F. Gouchet]

Sure thing, here's how I did it :
in your buildSrc/build.gradle.kts :

dependencies {
    compile ("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.0.1")
 }

[Xavier F. Gouchet]

And inside the buildSrc/src/main/kotlin/com/example/DetektConfig.kt

package com.example

import io.gitlab.arturbosch.detekt.extensions.DetektExtension
import org.gradle.api.Project

fun Project.detektConfig() {

     val ext: DetektExtension? = extensions.findByType(DetektExtension::class)
    ext?.apply {
        version = "1.0.1"

        input = files("$projectDir/src/main/kotlin")
        config = files("${project.rootDir}/script/config/detekt.yml")
        reports {
            xml {
                enabled = true
                destination = file("build/reports/detekt.xml")
            }
        }
    }
}

[Xavier F. Gouchet]

Then you can just call detektConfig() from any build.gradle.kts script in any module

[tapchicoma]

as alternative you can create a plugin in buildSrc that configures detekt (and some other common stuff) and apply it to all modules

[pg]

@Xavier F. Gouchet ah that was the trick. Initially I tried to use approach in your first post, failed of course. I didn't think about creating project extension, which seems nice. @tapchicoma I thought about it, but something was telling me that creating wrapper plugin on 3rd party plugin isn't right 😅

[tapchicoma]

it is not so bad as it sounds 🙂

[tapchicoma]

but yeah, for simple logic just go with Project extension functions in the buildSrc

[Xavier F. Gouchet]

Yeah I found that just to add a configuration, a full Plugin might be overkill 🙂

[pg]

I will experiment a bit with it. For now I created 2 plugins: one for <http://android.app|android.app> with android-kotlin and one for pure kotlin library, both with default configs and core deps. Effect is lovely

Untitled

[henrik]

@Xavier F. Gouchet: Do you need an import in your build.gradle.kts files to gain access to detektConfig()?

[Xavier F. Gouchet]

Yes you need to import the method

[henrik]

ah, after some trial and error I figured out that I didn't actually have to import it 🙂