I want to create a gradle plugin that exports a function to the build.gradle.kts file. The function ...

# getting-started

[James]

I want to create a gradle plugin that exports a function to the build.gradle.kts file. The function will be in the scope of org.gradle.api.artifacts.dsl.RepositoryHandler . Is there any documentation that explains how to do that?

[Vampire]

The best would be to add an extension to said repository handler, then it also works the same for both DSLs. But that is more a question for the Gradle Slack, as it is more Gradle related and actually not really Kotlin related when done properly. 😄

[Vampire]

If you for example have in the plugin

abstract class Foo {
    fun bar() {
        println("bar")
    }
}

(repositories as ExtensionAware).extensions.create<Foo>("foo")

then you can do downstream for example:

repositories {
    foo.bar()
}

or

repositories {
    foo {
        bar()
    }
}

and in both, Groovy DSL and Kotlin DSL

[James]

How would I create a function for the org.gradle.api.artifacts.dsl.RepositoryHandler scope?

So I could do

repositories {
  foo("bar", "baz")
}

[Vampire]

You shouldn't

[Vampire]

I mean, if you don't care about Groovy DSL you can of course simply make an extension function on RepositoryHandler

[James]

You shouldn't

Why?

[Vampire]

Because that is not the idiomatic Gradle way.
And it is good that it is clear where this comes from by having an additional namespace.
And it works in all supported DSLs.

[James]

I see! That's a good explanation, thank you! 😄

[Vampire]

Also by using an extension you can control exactly on which this is supported, instead of all of that type