Add PluginDependenciesSpec.embeddedKotlin function

Signed-off-by: Björn Kautler <Bjoern@Kautler.net>
echoOfqi · Jun 12, 2023 · dda0a0a · dda0a0a
1 parent a0cbef0
commit dda0a0a
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/...c/main/kotlin/gradlebuild/kotlindsl/generator/tasks/GenerateKotlinDependencyExtensions.kt b/...c/main/kotlin/gradlebuild/kotlindsl/generator/tasks/GenerateKotlinDependencyExtensions.kt
@@ -61,6 +61,7 @@ val expectedKotlinDslPluginsVersion: String
 
 package org.gradle.kotlin.dsl
 
+import org.gradle.api.Incubating
 import org.gradle.api.artifacts.dsl.DependencyHandler
 
 import org.gradle.plugin.use.PluginDependenciesSpec
@@ -92,6 +93,21 @@ fun DependencyHandler.kotlin(module: String, version: String? = null): Any =
     "org.jetbrains.kotlin:kotlin-${'$'}module${'$'}{version?.let { ":${'$'}version" } ?: ""}"
 
 
+/**
+ * Applies the given Kotlin plugin [module] at the embedded version (currently _${embeddedKotlinVersion}_).
+ *
+ * For example: `plugins { embeddedKotlin("plugin.serialization") }`
+ *
+ * Visit the [plugin portal](https://plugins.gradle.org/search?term=org.jetbrains.kotlin) to see the list of available plugins.
+ *
+ * @param module simple name of the Kotlin Gradle plugin module, for example "jvm", "android", "kapt", "plugin.allopen" etc...
+ * @since 8.3
+ */
+@Incubating
+fun PluginDependenciesSpec.embeddedKotlin(module: String): PluginDependencySpec =
+    id("org.jetbrains.kotlin.${'$'}module") version embeddedKotlinVersion
+
+
 /**
  * Applies the given Kotlin plugin [module].
  *

diff --git a/...jects/kotlin-dsl/src/test/kotlin/org/gradle/kotlin/dsl/PluginDependenciesSpecScopeTest.kt b/...jects/kotlin-dsl/src/test/kotlin/org/gradle/kotlin/dsl/PluginDependenciesSpecScopeTest.kt
@@ -71,6 +71,13 @@ class PluginDependenciesSpecScopeTest {
             kotlin("jvm") version "1.1.1"
         }
     }
+
+    @Test
+    fun `given embedded kotlin plugin accessor, it should create a single request with embedded version`() {
+        expecting(plugin(id = "org.jetbrains.kotlin.jvm", version = embeddedKotlinVersion)) {
+            embeddedKotlin("jvm")
+        }
+    }
 }