From 74b4adf8e2e5691d5986a205478d3240ede356c6 Mon Sep 17 00:00:00 2001 From: Yahor Berdnikau Date: Tue, 5 Dec 2023 22:37:03 +0100 Subject: [PATCH] [Gradle] Rename internal KotlinGradlePluginDsl into KotlinGradlePluginPublicDsl This is an internal annotation that eventually should go away, and the name is clashing with more public annotation is going to be introduced in the API project. ^KT-57292 In Progress --- libraries/tools/kotlin-gradle-plugin/build.gradle.kts | 2 +- ...tlinGradlePluginDsl.kt => KotlinGradlePluginPublicDsl.kt} | 5 ++++- .../kotlin/gradle/dsl/KotlinMultiplatformExtension.kt | 4 ++-- .../gradle/dsl/KotlinMultiplatformSourceSetConventions.kt | 2 +- .../jetbrains/kotlin/gradle/dsl/KotlinProjectExtension.kt | 2 +- .../gradle/dsl/KotlinTargetContainerWithJsPresetFunctions.kt | 2 +- .../gradle/dsl/KotlinTargetContainerWithNativeShortcuts.kt | 2 +- .../gradle/dsl/KotlinTargetContainerWithPresetFunctions.kt | 2 +- .../dsl/KotlinTargetContainerWithWasmPresetFunctions.kt | 2 +- 9 files changed, 13 insertions(+), 10 deletions(-) rename libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/{KotlinGradlePluginDsl.kt => KotlinGradlePluginPublicDsl.kt} (67%) diff --git a/libraries/tools/kotlin-gradle-plugin/build.gradle.kts b/libraries/tools/kotlin-gradle-plugin/build.gradle.kts index 1647dab2144..5a78de666c5 100644 --- a/libraries/tools/kotlin-gradle-plugin/build.gradle.kts +++ b/libraries/tools/kotlin-gradle-plugin/build.gradle.kts @@ -32,7 +32,7 @@ kotlin { apiValidation { publicMarkers.add("org.jetbrains.kotlin.gradle.ExternalKotlinTargetApi") - publicMarkers.add("org.jetbrains.kotlin.gradle.dsl.KotlinGradlePluginDsl") + publicMarkers.add("org.jetbrains.kotlin.gradle.dsl.KotlinGradlePluginPublicDsl") nonPublicMarkers.add("org.jetbrains.kotlin.gradle.InternalKotlinGradlePluginApi") additionalSourceSets.add("common") } diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinGradlePluginDsl.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinGradlePluginPublicDsl.kt similarity index 67% rename from libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinGradlePluginDsl.kt rename to libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinGradlePluginPublicDsl.kt index 758dc8c7ff9..c9eef4b9bd4 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinGradlePluginDsl.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinGradlePluginPublicDsl.kt @@ -7,6 +7,9 @@ package org.jetbrains.kotlin.gradle.dsl /** * Adhoc marker for APIs that are considered 'User facing dsl'. + * * Annotated APIs will be binary validated. + * + * Please consider exposing public DSL in the Kotlin Gradle Plugin API artifact rather than adding this annotation. */ -internal annotation class KotlinGradlePluginDsl +internal annotation class KotlinGradlePluginPublicDsl diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformExtension.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformExtension.kt index 22f1741a235..0eedcdbc5f4 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformExtension.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformExtension.kt @@ -27,7 +27,7 @@ import org.jetbrains.kotlin.gradle.utils.newInstance import javax.inject.Inject @Suppress("DEPRECATION") -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl abstract class KotlinMultiplatformExtension @InternalKotlinGradlePluginApi constructor(project: Project) : KotlinProjectExtension(project), @@ -263,7 +263,7 @@ abstract class KotlinMultiplatformExtension } @DeprecatedTargetPresetApi -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl interface TargetsFromPresetExtension : NamedDomainObjectCollection { @Deprecated( diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformSourceSetConventions.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformSourceSetConventions.kt index 8432d1c41ec..90da2e34a42 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformSourceSetConventions.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinMultiplatformSourceSetConventions.kt @@ -26,7 +26,7 @@ import org.jetbrains.kotlin.gradle.targets.js.dsl.KotlinJsTargetDsl import org.jetbrains.kotlin.gradle.targets.jvm.KotlinJvmTarget import org.jetbrains.kotlin.konan.target.Family -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl interface KotlinMultiplatformSourceSetConventions { val NamedDomainObjectContainer.commonMain: NamedDomainObjectProvider val NamedDomainObjectContainer.commonTest: NamedDomainObjectProvider diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinProjectExtension.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinProjectExtension.kt index bb05c1b2b7d..c3fba256cb4 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinProjectExtension.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinProjectExtension.kt @@ -165,7 +165,7 @@ internal fun KotlinTopLevelExtension.explicitApiModeAsCompilerArg(): String? { return cliOption?.let { "-Xexplicit-api=$it" } } -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl open class KotlinProjectExtension @Inject constructor(project: Project) : KotlinTopLevelExtension(project), KotlinSourceSetContainer, HasMutableExtras { final override val extras: MutableExtras = mutableExtrasOf() diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithJsPresetFunctions.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithJsPresetFunctions.kt index d3667255955..d6d4ad4972a 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithJsPresetFunctions.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithJsPresetFunctions.kt @@ -10,7 +10,7 @@ import org.jetbrains.kotlin.gradle.plugin.* import org.jetbrains.kotlin.gradle.targets.android.internal.InternalKotlinTargetPreset import org.jetbrains.kotlin.gradle.targets.js.dsl.KotlinJsTargetDsl -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl interface KotlinTargetContainerWithJsPresetFunctions : KotlinTargetContainerWithPresetFunctions, KotlinJsCompilerTypeHolder { diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithNativeShortcuts.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithNativeShortcuts.kt index 08f509f80cc..e8654bcbdad 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithNativeShortcuts.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithNativeShortcuts.kt @@ -22,7 +22,7 @@ import org.jetbrains.kotlin.tooling.core.extrasReadWriteProperty private const val SHORTCUTS_DEPRECATION_MESSAGE = "Use applyDefaultHierarchyTemplate() instead. " + "Deprecated since 1.9.20, scheduled for removal in 2.0" -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl @Deprecated(SHORTCUTS_DEPRECATION_MESSAGE) interface KotlinTargetContainerWithNativeShortcuts : KotlinTargetContainerWithPresetFunctions, KotlinSourceSetContainer { diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithPresetFunctions.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithPresetFunctions.kt index 56a9f6ba54d..e1d6239dea4 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithPresetFunctions.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithPresetFunctions.kt @@ -18,7 +18,7 @@ import org.jetbrains.kotlin.konan.target.DEPRECATED_TARGET_MESSAGE private const val ANDROID_TARGET_MIGRATION_MESSAGE = "Please use androidTarget() instead. Learn more here: https://kotl.in/android-target-dsl" -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl interface KotlinTargetContainerWithPresetFunctions : KotlinTargetsContainerWithPresets { fun jvm( diff --git a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithWasmPresetFunctions.kt b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithWasmPresetFunctions.kt index fcba5e76384..d93447109d9 100644 --- a/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithWasmPresetFunctions.kt +++ b/libraries/tools/kotlin-gradle-plugin/src/common/kotlin/org/jetbrains/kotlin/gradle/dsl/KotlinTargetContainerWithWasmPresetFunctions.kt @@ -11,7 +11,7 @@ import org.jetbrains.kotlin.gradle.targets.js.dsl.KotlinWasmJsTargetDsl import org.jetbrains.kotlin.gradle.targets.js.dsl.KotlinWasmWasiTargetDsl import org.jetbrains.kotlin.gradle.targets.js.ir.KotlinWasmTargetPreset -@KotlinGradlePluginDsl +@KotlinGradlePluginPublicDsl interface KotlinTargetContainerWithWasmPresetFunctions : KotlinTargetContainerWithPresetFunctions { @ExperimentalWasmDsl fun wasmJs(