Compat Kotlin Multiplatform plugin #1280
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Integrating with Kotlin Multiplatform Plugin | ||
|
|
||
| Shadow honors Kotlin's | ||
| [`org.jetbrains.kotlin.multiplatform`](https://kotlinlang.org/docs/multiplatform-intro.html) plugin and will automatically | ||
| configure additional tasks for bundling the shadowed JAR for it's `jvm` target. | ||
|
|
||
| ```groovy | ||
| // Using Shadow with KMP Plugin | ||
| plugins { | ||
| id 'org.jetbrains.kotlin.multiplatform' | ||
| id 'com.gradleup.shadow' | ||
| } | ||
|
|
||
| def ktorVersion = "3.1.0" | ||
|
|
||
| kotlin { | ||
| jvm() | ||
| sourceSets { | ||
| commonMain { | ||
| dependencies { | ||
| implementation "io.ktor:ktor-client-core$ktorVersion" | ||
| } | ||
| } | ||
| jvmMain { | ||
| dependencies { | ||
| implementation "io.ktor:ktor-client-okhttp$ktorVersion" | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| tasks.named('shadowJar', com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar) { | ||
| manifest { | ||
| // Optionally, set the main class for the shadowed JAR. | ||
| attributes 'Main-Class': 'com.example.MainKt' | ||
| } | ||
| } | ||
| ``` | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| package com.github.jengelman.gradle.plugins.shadow | ||
|
|
||
| import assertk.assertThat | ||
| import com.github.jengelman.gradle.plugins.shadow.util.containsEntries | ||
| import kotlin.io.path.appendText | ||
| import kotlin.io.path.writeText | ||
| import org.junit.jupiter.api.BeforeEach | ||
| import org.junit.jupiter.api.Test | ||
|
|
||
| class KmpPluginTest : BasePluginTest() { | ||
| @BeforeEach | ||
| override fun setup() { | ||
| super.setup() | ||
| val projectBuildScript = getDefaultProjectBuildScript( | ||
| plugin = "org.jetbrains.kotlin.multiplatform", | ||
| withGroup = true, | ||
| withVersion = true, | ||
| ) | ||
| projectScriptPath.writeText(projectBuildScript) | ||
| } | ||
|
|
||
| @Test | ||
| fun compatKmpJvmTarget() { | ||
| val mainClass = writeMainClass(sourceSet = "jvmMain", isJava = false) | ||
| projectScriptPath.appendText( | ||
| """ | ||
| kotlin { | ||
| jvm() | ||
| sourceSets { | ||
| commonMain { | ||
| dependencies { | ||
| implementation 'my:b:1.0' | ||
| } | ||
| } | ||
| jvmMain { | ||
| dependencies { | ||
| implementation 'my:a:1.0' | ||
| } | ||
| } | ||
| } | ||
| } | ||
| """.trimIndent(), | ||
| ) | ||
|
|
||
| run(shadowJarTask) | ||
|
|
||
| assertThat(outputShadowJar).useAll { | ||
| containsEntries( | ||
| mainClass, | ||
| *entriesInAB, | ||
| ) | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| package com.github.jengelman.gradle.plugins.shadow | ||
|
|
||
| import com.github.jengelman.gradle.plugins.shadow.ShadowJavaPlugin.Companion.registerShadowJarCommon | ||
| import org.gradle.api.Plugin | ||
| import org.gradle.api.Project | ||
| import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension | ||
|
|
||
| public abstract class ShadowKmpPlugin : Plugin<Project> { | ||
|
|
||
| override fun apply(project: Project) { | ||
| with(project) { | ||
| val kmpExtension = extensions.getByType(KotlinMultiplatformExtension::class.java) | ||
| val kotlinJvmMain = kmpExtension.jvm().compilations.named("main") | ||
|
There was a problem hiding this comment. Please don't call More over, they can specify a custom name for their jvm target. The correct API is to lazily iterate over targets collection. And check for KotlinJvmTarget instance. There was a problem hiding this comment. You are right, I didn't know how to defer this. Thanks for the reporting. Creating a new issue in #1377. There was a problem hiding this comment. I guess this will also be useful for #1333. |
||
| registerShadowJarCommon { task -> | ||
| task.from(kotlinJvmMain.map { it.output.allOutputs }) | ||
| task.configurations.convention( | ||
| provider { listOf(configurations.getByName(kotlinJvmMain.get().runtimeDependencyConfigurationName)) }, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.