I have a custom Gradle plugin which adds different common de

Question

I have a custom Gradle plugin which adds different common dependencies However I cannot find the syntax for adding a dependency on another project In Kotlin Gradle Script DSL the syntax would be ```testImplementation project myProject ``` I need the syntax for writing a Kotlin plugin ```project dependencies add testImplementation How do I create a project dependency notation here ```

jendrik · Answer

It is the same in Kotlin DSL `project myProject ` Which error are you getting if you do that

Lukasz Kalnik · Answer

I need the syntax for a custom Gradle plugin not for the Kotlin Script DSL

jendrik · Answer

Got it Is the Plugin written in Java or Kotlin

Lukasz Kalnik · Answer

In Kotlin

Lukasz Kalnik · Answer

This is what I get now

jendrik · Answer

The `project ` method is on the `Project` interface So you can do `project project `

Lukasz Kalnik · Answer

smile

Lukasz Kalnik · Answer

Works

Lukasz Kalnik · Answer

Thanks for your help pray

jendrik · Answer

You can use Kotlin s `with` to have the whole method in the `project` context then it looks like in the DSL E g ```override fun apply project Project Unit = with project ```

Lukasz Kalnik · Answer

Yes that s true

jendrik · Answer

I have a sample on doing common things in a Plugin written in Kotlin here <https github com jjohannes gradle plugins howto tree main kotlin gradle build logic java plugins src main kotlin software onepiece gradle pluginshowto|https github com jjohannes gradle plugins howto tree main kotlin gradle build lo a plugins src main kotlin software onepiece gradle pluginshowto>

Lukasz Kalnik · Answer

I was looking for some hint about it in the Gradle documentation but it was not so easy to find

Lukasz Kalnik · Answer

I usually work only with the Kotlin DSL and there I think the `Project` is indeed always the implicit receiver for the whole syntax I was not aware of this because the DSL is so convenient that I never actually thought how it works under the hood and how it connects to the underlying Gradle Java API

Lukasz Kalnik · Answer

The samples are helpful thanks

Vampire · Answer

Does it really work with `project project ` I thought it should be `project dependencies project ` `project ` in a build script uses the latter just navigate to it from a build script `project project` returns a `Project` while `project dependencies project` returns a `ProjectDependency` Latest if you need to supply a configuration to depend on you need to use `project dependencies project` even if it otherwise works with `project project`

Lukasz Kalnik · Answer

Good point `DependencyHandler add ` just accepts `Object`

Lukasz Kalnik · Answer

Currently I do this in my plugin and it works clean + build + tests pass ``` override fun apply project Project with project dependencies add testImplementation project testFixtures ```

Vampire · Answer

Yeah because you can give it a variety of things like `ProjectDependency` `String` and others I m not sure whether it accepts `Project` could well be I just was not aware

Vampire · Answer

Well then it seems to accept it unless you need a specific configuration

Vampire · Answer

TIL

Lukasz Kalnik · Answer

I mean it doesn t make it typesafe

Lukasz Kalnik · Answer

There could be an overload for special cases like `String`

Lukasz Kalnik · Answer

And the rest of dependency types could be handled just under a common interface like `Dependency`

Vampire · Answer

I have no idea why the Gradle guys designed it like that Maybe because main usage target was Groovy DSL as sole DSL at that time and there you have duck typing anyway

Lukasz Kalnik · Answer

True

Lukasz Kalnik · Answer

That might have been the reason

Vampire · Answer

But could also be a different reason If you are curious open a feature request to make the API type safe with overloads and we will see what the Gradle guys respond

Lukasz Kalnik · Answer

`project dependencies project ` doesn t allow String as argument

Vampire · Answer

Well you can either use the Kotlin DSL classes that add that sugar or you have to use the real arguments which is `Map`

Vampire · Answer

`project dependencies project mapOf path to foo `

Vampire · Answer

But if it works with `project project` you can also just stick with it I just was not aware that is accepted

Lukasz Kalnik · Answer

I guess if I want to use the Kotlin DSL inside of my plugin code which is in the `gradlePlugins` module I need to somehow add dependency on the Kotlin DSL in this module right

Lukasz Kalnik · Answer

Otherwise I cannot import the `DependencyHandler project ` extension function from `org gradle kotlin dsl DependencyHandlerExtensions kt`

Vampire · Answer

Exactly

Lukasz Kalnik · Answer

How do I do this

Vampire · Answer

You can either apply the `kotlin dsl` plugin if you also want the other bits it does or there is a helper for it I have to search for Probably something like `implementation kotlinDsl `

Lukasz Kalnik · Answer

Looks like there is `implementation gradleKotlinDsl `

Vampire · Answer

Exactly

Vampire · Answer

`kotlin dsl` applies `java gradle plugin` `kotlin dsl base` and `kotlin dsl precompiled script plugins` plugins `kotlin dsl base` plugin applies `embedded kotlin` adds `gradleKotlinDsl ` to the dependencies of `compileOnly` and `testImplementation` configurations and configures the Kotlin DSL compiler plugins for example for proper SAM conversion for `Action` and similar

Vampire · Answer

So maybe `compileOnly gradleKotlinDsl ` would be more appropriate as the classes are provided by the runtime environment already

Javier · Answer

I have it added as dependency and I can t access to ```import org gradle api artifacts dsl project```

Lukasz Kalnik · Answer

Thank you so much for all your helpful explanations They really helped me understand what s going on behind the scenes which is so much better than just quickly fixing the problem

Lukasz Kalnik · Answer

`import org gradle kotlin dsl project`

Javier · Answer

as a workaround you can use

Lukasz Kalnik · Answer

Javier your import is not importing the extension function

Javier · Answer

exactly is what I said

Javier · Answer

it is not accessible even with `gradleKotlinDsl`

Lukasz Kalnik · Answer

No the import is wrong

Lukasz Kalnik · Answer

That s what I mean

Lukasz Kalnik · Answer

Compare to mine

Javier · Answer

ah

Lukasz Kalnik · Answer

Javier · Answer

yeah I copy paste it wrong from an accessor

Javier · Answer

it works with it then

Lukasz Kalnik · Answer

thumbsup

Vampire · Answer

ok hand

Javier · Answer

I don t understand why `testImplementation` and so on are accessors whose need to be generated instead of being in an interface

Javier · Answer

I guess they generate even the base ones too and not only the custom ones

Vampire · Answer

They are not base ones they are coming because of a built in plugin but still they come because of a plugin and only if it is applied

Vampire · Answer

Having the accessors there always would make the build script compile but then fail at runtime and that s counter productive

Javier · Answer

yeah but for example de kotlin dependency handler has implementation api and so on without being autogenerated

Vampire · Answer

What do you mean with the kotlin depedendency handler

Vampire · Answer

If you mean doing `implementation ` in Kotlin DSL then try navigating to it and looking at the file path and you will see it is generated

Javier · Answer

Kotlin sourcesets has its own dependency handler interface

Javier · Answer

they aren t generated

Vampire · Answer

Well but they are only useable when the Kotlin plugin is applied And if it is applied `implementation` is always usable So it can also be hard coded

Vampire · Answer

Besides that that is JetBrains code not Gradle code

Javier · Answer

yep