[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
This commit is contained in:
Yahor Berdnikau
2023-12-05 22:37:03 +01:00
committed by Space Team
parent a02cf76d6c
commit 74b4adf8e2
9 changed files with 13 additions and 10 deletions
@@ -32,7 +32,7 @@ kotlin {
apiValidation { apiValidation {
publicMarkers.add("org.jetbrains.kotlin.gradle.ExternalKotlinTargetApi") 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") nonPublicMarkers.add("org.jetbrains.kotlin.gradle.InternalKotlinGradlePluginApi")
additionalSourceSets.add("common") additionalSourceSets.add("common")
} }
@@ -7,6 +7,9 @@ package org.jetbrains.kotlin.gradle.dsl
/** /**
* Adhoc marker for APIs that are considered 'User facing dsl'. * Adhoc marker for APIs that are considered 'User facing dsl'.
*
* Annotated APIs will be binary validated. * 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
@@ -27,7 +27,7 @@ import org.jetbrains.kotlin.gradle.utils.newInstance
import javax.inject.Inject import javax.inject.Inject
@Suppress("DEPRECATION") @Suppress("DEPRECATION")
@KotlinGradlePluginDsl @KotlinGradlePluginPublicDsl
abstract class KotlinMultiplatformExtension abstract class KotlinMultiplatformExtension
@InternalKotlinGradlePluginApi constructor(project: Project) : @InternalKotlinGradlePluginApi constructor(project: Project) :
KotlinProjectExtension(project), KotlinProjectExtension(project),
@@ -263,7 +263,7 @@ abstract class KotlinMultiplatformExtension
} }
@DeprecatedTargetPresetApi @DeprecatedTargetPresetApi
@KotlinGradlePluginDsl @KotlinGradlePluginPublicDsl
interface TargetsFromPresetExtension : NamedDomainObjectCollection<KotlinTarget> { interface TargetsFromPresetExtension : NamedDomainObjectCollection<KotlinTarget> {
@Deprecated( @Deprecated(
@@ -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.gradle.targets.jvm.KotlinJvmTarget
import org.jetbrains.kotlin.konan.target.Family import org.jetbrains.kotlin.konan.target.Family
@KotlinGradlePluginDsl @KotlinGradlePluginPublicDsl
interface KotlinMultiplatformSourceSetConventions { interface KotlinMultiplatformSourceSetConventions {
val NamedDomainObjectContainer<KotlinSourceSet>.commonMain: NamedDomainObjectProvider<KotlinSourceSet> val NamedDomainObjectContainer<KotlinSourceSet>.commonMain: NamedDomainObjectProvider<KotlinSourceSet>
val NamedDomainObjectContainer<KotlinSourceSet>.commonTest: NamedDomainObjectProvider<KotlinSourceSet> val NamedDomainObjectContainer<KotlinSourceSet>.commonTest: NamedDomainObjectProvider<KotlinSourceSet>
@@ -165,7 +165,7 @@ internal fun KotlinTopLevelExtension.explicitApiModeAsCompilerArg(): String? {
return cliOption?.let { "-Xexplicit-api=$it" } return cliOption?.let { "-Xexplicit-api=$it" }
} }
@KotlinGradlePluginDsl @KotlinGradlePluginPublicDsl
open class KotlinProjectExtension @Inject constructor(project: Project) : KotlinTopLevelExtension(project), KotlinSourceSetContainer, HasMutableExtras { open class KotlinProjectExtension @Inject constructor(project: Project) : KotlinTopLevelExtension(project), KotlinSourceSetContainer, HasMutableExtras {
final override val extras: MutableExtras = mutableExtrasOf() final override val extras: MutableExtras = mutableExtrasOf()
@@ -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.android.internal.InternalKotlinTargetPreset
import org.jetbrains.kotlin.gradle.targets.js.dsl.KotlinJsTargetDsl import org.jetbrains.kotlin.gradle.targets.js.dsl.KotlinJsTargetDsl
@KotlinGradlePluginDsl @KotlinGradlePluginPublicDsl
interface KotlinTargetContainerWithJsPresetFunctions : interface KotlinTargetContainerWithJsPresetFunctions :
KotlinTargetContainerWithPresetFunctions, KotlinTargetContainerWithPresetFunctions,
KotlinJsCompilerTypeHolder { KotlinJsCompilerTypeHolder {
@@ -22,7 +22,7 @@ import org.jetbrains.kotlin.tooling.core.extrasReadWriteProperty
private const val SHORTCUTS_DEPRECATION_MESSAGE = "Use applyDefaultHierarchyTemplate() instead. " + private const val SHORTCUTS_DEPRECATION_MESSAGE = "Use applyDefaultHierarchyTemplate() instead. " +
"Deprecated since 1.9.20, scheduled for removal in 2.0" "Deprecated since 1.9.20, scheduled for removal in 2.0"
@KotlinGradlePluginDsl @KotlinGradlePluginPublicDsl
@Deprecated(SHORTCUTS_DEPRECATION_MESSAGE) @Deprecated(SHORTCUTS_DEPRECATION_MESSAGE)
interface KotlinTargetContainerWithNativeShortcuts : KotlinTargetContainerWithPresetFunctions, KotlinSourceSetContainer { interface KotlinTargetContainerWithNativeShortcuts : KotlinTargetContainerWithPresetFunctions, KotlinSourceSetContainer {
@@ -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" 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 { interface KotlinTargetContainerWithPresetFunctions : KotlinTargetsContainerWithPresets {
fun jvm( fun jvm(
@@ -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.dsl.KotlinWasmWasiTargetDsl
import org.jetbrains.kotlin.gradle.targets.js.ir.KotlinWasmTargetPreset import org.jetbrains.kotlin.gradle.targets.js.ir.KotlinWasmTargetPreset
@KotlinGradlePluginDsl @KotlinGradlePluginPublicDsl
interface KotlinTargetContainerWithWasmPresetFunctions : KotlinTargetContainerWithPresetFunctions { interface KotlinTargetContainerWithWasmPresetFunctions : KotlinTargetContainerWithPresetFunctions {
@ExperimentalWasmDsl @ExperimentalWasmDsl
fun wasmJs( fun wasmJs(