Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2010-2023 JetBrains s.r.o. and Kotlin Programming Language contributors.
* Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.gradle.plugin.diagnostics
import org.gradle.api.Project
import org.gradle.util.GradleVersion
import org.jetbrains.kotlin.gradle.InternalKotlinGradlePluginApi
import org.jetbrains.kotlin.gradle.PRESETS_DEPRECATION_MESSAGE_SUFFIX
import org.jetbrains.kotlin.gradle.dsl.KotlinSourceSetConvention.isAccessedByKotlinSourceSetConventionAt
import org.jetbrains.kotlin.gradle.dsl.NativeTargetShortcutTrace
import org.jetbrains.kotlin.gradle.internal.KOTLIN_BUILD_TOOLS_API_IMPL
import org.jetbrains.kotlin.gradle.internal.KOTLIN_MODULE_GROUP
import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation
import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider.Companion.KOTLIN_SUPPRESS_GRADLE_PLUGIN_WARNINGS_PROPERTY
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider.PropertyNames.KOTLIN_MPP_APPLY_DEFAULT_HIERARCHY_TEMPLATE
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider.PropertyNames.KOTLIN_NATIVE_IGNORE_DISABLED_TARGETS
import org.jetbrains.kotlin.gradle.plugin.PropertiesProvider.PropertyNames.KOTLIN_NATIVE_SUPPRESS_EXPERIMENTAL_ARTIFACTS_DSL_WARNING
import org.jetbrains.kotlin.gradle.plugin.diagnostics.ToolingDiagnostic.Severity.*
import org.jetbrains.kotlin.gradle.plugin.sources.android.multiplatformAndroidSourceSetLayoutV1
import org.jetbrains.kotlin.gradle.plugin.sources.android.multiplatformAndroidSourceSetLayoutV2
import org.jetbrains.kotlin.gradle.utils.prettyName
import org.jetbrains.kotlin.utils.addToStdlib.flatGroupBy
import java.io.File
@InternalKotlinGradlePluginApi // used in integration tests
object KotlinToolingDiagnostics {
/**
* This diagnostic is suppressed in kotlin-test and kotlin-stdlib.
* We should migrate the stdlib and kotlin-test from deprecated flags and then completely remove the support.
* ETA: 2.0-M1
*
* P.s. Some tests also suppress this diagnostic -- these tests should be removed together with the flags support
*/
object PreHMPPFlagsError : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(usedDeprecatedFlags: List) = build(
"The following properties are obsolete and no longer supported:\n" +
"${usedDeprecatedFlags.joinToString()}\n" +
"Read the details here: https://kotlinlang.org/docs/multiplatform-compatibility-guide.html#deprecate-hmpp-properties",
)
}
object DeprecatedKotlinNativeTargetsDiagnostic : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(usedTargetIds: List) = build(
"The following removed Kotlin/Native targets were used in the project: ${usedTargetIds.joinToString()}"
)
}
object CommonMainOrTestWithDependsOnDiagnostic : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(suffix: String) = build("common$suffix can't declare dependsOn on other source sets")
}
object NativeStdlibIsMissingDiagnostic : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(changedKotlinNativeHomeProperty: String?) = build(
"The Kotlin/Native distribution used in this build does not provide the standard library." +
" Make sure that the '$changedKotlinNativeHomeProperty' property points to a valid Kotlin/Native distribution."
.onlyIf(changedKotlinNativeHomeProperty != null)
)
}
object DeprecatedJvmWithJavaPresetDiagnostic : ToolingDiagnosticFactory(ERROR) {
operator fun invoke() = build(
"""
The 'jvmWithJava' preset is deprecated and will be removed soon. Please use an ordinary JVM target with Java support:
kotlin {
jvm {
withJava()
}
}
After this change, please move the Java sources to the Kotlin source set directories.
For example, if the JVM target is given the default name 'jvm':
* instead of 'src/main/java', use 'src/jvmMain/java'
* instead of 'src/test/java', use 'src/jvmTest/java'
""".trimIndent()
)
}
object UnusedSourceSetsWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(sourceSetNames: Collection): ToolingDiagnostic {
val cause = if (sourceSetNames.size == 1) {
"The Kotlin source set ${sourceSetNames.single()} was configured but not added to any Kotlin compilation.\n"
} else {
val sourceSetNamesString = sourceSetNames.joinToString("\n") { " * $it" }
"The following Kotlin source sets were configured but not added to any Kotlin compilation:\n" +
sourceSetNamesString
}
val details =
"""
|You can add a source set to a target's compilation by connecting it with the compilation's default source set using 'dependsOn'.
|See https://kotl.in/connecting-source-sets
""".trimMargin()
return build(cause + "\n" + details)
}
}
object MultipleSourceSetRootsInCompilation : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(
kotlinCompilation: KotlinCompilation<*>,
unexpectedSourceSetRoot: String,
expectedRoot: String,
): ToolingDiagnostic = build(
"""
Kotlin Source Set '$unexpectedSourceSetRoot' is included to '${kotlinCompilation.name}' compilation of '${kotlinCompilation.target.name}' target,
but it doesn't depend on '$expectedRoot'.
Please remove '$unexpectedSourceSetRoot' and include its sources to the compilation's default source set:
kotlin.sourceSets["${kotlinCompilation.defaultSourceSet.name}"].kotlin.srcDir() // <-- pass sources directory of '$unexpectedSourceSetRoot'
Or provide explicit dependency if the solution above is not applicable
kotlin.sourceSets["$unexpectedSourceSetRoot"].dependsOn($expectedRoot)
See https://kotl.in/connecting-source-sets for more details.
""".trimIndent()
)
operator fun invoke(
targetNames: Collection,
unexpectedSourceSetRoot: String,
expectedRoot: String,
): ToolingDiagnostic = build(
"""
Kotlin Source Set '$unexpectedSourceSetRoot' is included in compilations of Kotlin Targets: ${targetNames.joinToString(", ") { "'$it'" }}
but it doesn't depend on '$expectedRoot'
Please remove '$unexpectedSourceSetRoot' and include its sources to one of the default source set: https://kotl.in/hierarchy-template
For example:
kotlin.sourceSets.commonMain.kotlin.srcDir() // <-- pass here sources directory
Or add explicit dependency if the solution above is not applicable:
kotlin.sourceSets["$unexpectedSourceSetRoot"].dependsOn($expectedRoot)
See https://kotl.in/connecting-source-sets for more details.
""".trimIndent()
)
operator fun invoke(kotlinCompilation: KotlinCompilation<*>, sourceSetRoots: Collection) = build(
"""
Kotlin Source Sets: ${sourceSetRoots.joinToString(", ") { "'$it'" }}
are included to '${kotlinCompilation.name}' compilation of '${kotlinCompilation.target.name}' target.
However, they have no common source set root between them.
Please remove these kotlin source sets and include their source directories to the compilation's default source set.
kotlin.sourceSets["${kotlinCompilation.defaultSourceSet.name}"].kotlin.srcDir() // <-- pass sources directories here
Or, if the solution above is not applicable, specify `dependsOn` edges between these source sets so that there are no multiple roots.
See https://kotl.in/connecting-source-sets for more details.
""".trimIndent()
)
}
object AndroidSourceSetLayoutV1Deprecation : ToolingDiagnosticFactory(ERROR) {
operator fun invoke() = build(
"""
The version 1 of Android source set layout is deprecated. Please remove kotlin.mpp.androidSourceSetLayoutVersion=1 from the gradle.properties file.
Learn how to migrate to the version 2 source set layout at: https://kotl.in/android-source-set-layout-v2
""".trimIndent()
)
}
object AgpRequirementNotMetForAndroidSourceSetLayoutV2 : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(minimumRequiredAgpVersion: String, currentAgpVersion: String) = build(
"""
${multiplatformAndroidSourceSetLayoutV2.name} requires Android Gradle Plugin Version >= $minimumRequiredAgpVersion.
Found $currentAgpVersion
""".trimIndent()
)
}
object AndroidStyleSourceDirUsageWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(androidStyleSourceDirInUse: String, kotlinStyleSourceDirToUse: String) = build(
"""
Usage of 'Android Style' source directory $androidStyleSourceDirInUse is deprecated.
Use $kotlinStyleSourceDirToUse instead.
To suppress this warning: put the following in your gradle.properties:
${PropertiesProvider.PropertyNames.KOTLIN_MPP_ANDROID_SOURCE_SET_LAYOUT_ANDROID_STYLE_NO_WARN}=true
Learn more: https://kotl.in/android-source-set-layout-v2
""".trimIndent()
)
}
object SourceSetLayoutV1StyleDirUsageWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(v1StyleSourceDirInUse: String, currentLayoutName: String, v2StyleSourceDirToUse: String) = build(
"""
Found used source directory $v1StyleSourceDirInUse
This source directory was supported by: ${multiplatformAndroidSourceSetLayoutV1.name}
Current KotlinAndroidSourceSetLayout: $currentLayoutName
New source directory is: $v2StyleSourceDirToUse
""".trimIndent()
)
}
object IncompatibleGradleVersionTooLowFatalError : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(
currentGradleVersion: GradleVersion,
minimallySupportedGradleVersion: GradleVersion,
) = build(
"""
Kotlin Gradle Plugin <-> Gradle compatibility issue:
The applied Kotlin Gradle is not compatible with the used Gradle version ($currentGradleVersion).
Please update the Gradle version to at least $minimallySupportedGradleVersion.
""".trimIndent()
)
}
object IncompatibleAgpVersionTooLowFatalError : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(
androidGradlePluginVersionString: String,
minSupported: String,
) = build(
"""
Kotlin Gradle Plugin <-> Android Gradle Plugin compatibility issue:
The applied Android Gradle Plugin version ($androidGradlePluginVersionString) is lower than the minimum supported $minSupported.
Please update the Android Gradle Plugin version to at least $minSupported.
""".trimIndent()
)
}
object FailedToGetAgpVersionWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(agpPluginId: String) = build(
"""
Failed to get Android Gradle Plugin version (for '$agpPluginId' plugin).
Please report a new Kotlin issue via https://kotl.in/issue.
""".trimIndent()
)
}
object AndroidSourceSetLayoutV1SourceSetsNotFoundError : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(nameOfRequestedSourceSet: String) = build(
"""
KotlinSourceSet with name '$nameOfRequestedSourceSet' not found:
The SourceSet requested ('$nameOfRequestedSourceSet') was renamed in Kotlin 1.9.0
In order to migrate you might want to replace:
sourceSets.getByName("androidTest") -> sourceSets.getByName("androidUnitTest")
sourceSets.getByName("androidAndroidTest") -> sourceSets.getByName("androidInstrumentedTest")
Learn more about the new Kotlin/Android SourceSet Layout:
https://kotl.in/android-source-set-layout-v2
""".trimIndent()
)
}
object KotlinJvmMainRunTaskConflict : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(targetName: String, taskName: String) = build(
"""
Target '$targetName': Unable to create run task '$taskName' as there is already such a task registered
""".trimIndent()
)
}
object DeprecatedPropertyWithReplacement : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(deprecatedPropertyName: String, replacement: String) = build(
"Project property '$deprecatedPropertyName' is deprecated. Please use '$replacement' instead."
)
}
object UnrecognizedKotlinNativeDistributionType : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(actualValue: String) = build(
"Gradle Property 'kotlin.native.distribution.type' sets unknown Kotlin/Native distribution type: ${actualValue}\n" +
"Available values: prebuilt, light"
)
}
object Kotlin12XMppDeprecation : ToolingDiagnosticFactory(FATAL) {
operator fun invoke() = build(
"""
The 'org.jetbrains.kotlin.platform.*' plugins are no longer available.
Please migrate the project to the 'org.jetbrains.kotlin.multiplatform' plugin.
See: https://kotl.in/legacy-multiplatform-plugins
""".trimIndent()
)
}
object AndroidTargetIsMissing : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(projectName: String, projectPath: String, androidPluginId: String) = build(
"""
Missing 'androidTarget()' Kotlin target in multiplatform project '$projectName ($projectPath)'.
The Android Gradle plugin was applied without creating a corresponding 'android()' Kotlin Target:
```
plugins {
id("$androidPluginId")
kotlin("multiplatform")
}
kotlin {
androidTarget() // <-- please register this Android target
}
```
""".trimIndent()
)
}
object AndroidGradlePluginIsMissing : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(trace: Throwable? = null) = build(
"""
The Android target requires a 'Android Gradle Plugin' to be applied to the project.
plugins {
kotlin("multiplatform")
/* Android Gradle Plugin missing */
id("com.android.library") /* <- Android Gradle Plugin for libraries */
id("com.android.application") <* <- Android Gradle Plugin for applications */
}
kotlin {
androidTarget() /* <- requires Android Gradle Plugin to be applied */
}
""".trimIndent(),
throwable = trace
)
}
object NoKotlinTargetsDeclared : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(projectName: String, projectPath: String) = build(
"""
Please initialize at least one Kotlin target in '${projectName} (${projectPath})'.
Read more https://kotl.in/set-up-targets
""".trimIndent()
)
}
object DisabledCinteropsCommonizationInHmppProject : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(affectedSourceSetsString: String, affectedCinteropsString: String) = build(
"""
The project is using Kotlin Multiplatform with hierarchical structure and disabled 'cinterop commonization'
See: https://kotlinlang.org/docs/mpp-share-on-platforms.html#use-native-libraries-in-the-hierarchical-structure
'cinterop commonization' can be enabled in your 'gradle.properties'
kotlin.mpp.enableCInteropCommonization=true
To hide this message, add to your 'gradle.properties'
${PropertiesProvider.PropertyNames.KOTLIN_MPP_ENABLE_CINTEROP_COMMONIZATION}.nowarn=true
The following source sets are affected:
$affectedSourceSetsString
The following cinterops are affected:
$affectedCinteropsString
""".trimIndent()
)
}
object DisabledKotlinNativeTargets : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(disabledTargetNames: Collection): ToolingDiagnostic = build(
"""
The following Kotlin/Native targets cannot be built on this machine and are disabled:
${disabledTargetNames.joinToString()}
To hide this message, add '$KOTLIN_NATIVE_IGNORE_DISABLED_TARGETS=true' to the Gradle properties.
""".trimIndent()
)
}
object InconsistentTargetCompatibilityForKotlinAndJavaTasks : ToolingDiagnosticFactory(predefinedSeverity = null) {
operator fun invoke(
javaTaskName: String,
targetCompatibility: String,
kotlinTaskName: String,
jvmTarget: String,
severity: ToolingDiagnostic.Severity,
) = build(
"""
Inconsistent JVM-target compatibility detected for tasks '$javaTaskName' ($targetCompatibility) and '$kotlinTaskName' ($jvmTarget).
${if (severity == WARNING) "This will become an error in Gradle 8.0." else ""}
Consider using JVM Toolchain: https://kotl.in/gradle/jvm/toolchain
Learn more about JVM-target validation: https://kotl.in/gradle/jvm/target-validation
""".trimIndent(),
severity
)
}
abstract class JsLikeEnvironmentNotChosenExplicitly(
private val environmentName: String,
private val targetType: String
) : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(availableEnvironments: List) = build(
"""
|Please choose a $environmentName environment to build distributions and run tests.
|Not choosing any of them will be an error in the future releases.
|kotlin {
| $targetType {
| // To build distributions for and run tests use one or several of:
| ${availableEnvironments.joinToString(separator = "\n ")}
| }
|}
""".trimMargin()
)
}
object JsEnvironmentNotChosenExplicitly : JsLikeEnvironmentNotChosenExplicitly("JavaScript", "js")
object WasmJsEnvironmentNotChosenExplicitly : JsLikeEnvironmentNotChosenExplicitly("WebAssembly-JavaScript", "wasmJs")
object WasmWasiEnvironmentNotChosenExplicitly : JsLikeEnvironmentNotChosenExplicitly("WebAssembly WASI", "wasmWasi")
object PreHmppDependenciesUsedInBuild : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(dependencyName: String) = build(
"""
The dependency '$dependencyName' was published in the legacy mode. Support for such dependencies will be removed in the future.
See https://kotl.in/0b5kn8 for details.
""".trimIndent()
)
}
object ExperimentalTryNextWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke() = build(
"""
ATTENTION: 'kotlin.experimental.tryNext' is an experimental option enabled in the project for trying out the next Kotlin compiler language version only.
Please refrain from using it in production code and provide feedback to the Kotlin team for any issues encountered via https://kotl.in/issue
""".trimIndent()
)
}
object KotlinSourceSetTreeDependsOnMismatch : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(dependeeName: String, dependencyName: String) = build(
"""
Kotlin Source Set '$dependeeName' can't depend on '$dependencyName' as they are from different Source Set Trees.
Please remove this dependency edge.
""".trimIndent()
)
operator fun invoke(dependents: Map>, dependencyName: String) = build(
"""
Following Kotlin Source Set groups can't depend on '$dependencyName' together as they belong to different Kotlin Source Set Trees.
${renderSourceSetGroups(dependents).indentLines(16)}
Please keep dependsOn edges only from one group and remove the others.
""".trimIndent()
)
private fun renderSourceSetGroups(sourceSetGroups: Map>) = buildString {
for ((sourceSetTreeName, sourceSets) in sourceSetGroups) {
appendLine("Source Sets from '$sourceSetTreeName' Tree:")
appendLine(sourceSets.joinToString("\n") { " * '$it'" })
}
}
}
object KotlinSourceSetDependsOnDefaultCompilationSourceSet : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(dependeeName: String, dependencyName: String) = build(
"""
Kotlin Source Set '$dependeeName' can't depend on '$dependencyName' which is a default source set for compilation.
None of source sets can depend on the compilation default source sets.
Please remove this dependency edge.
""".trimIndent()
)
}
object PlatformSourceSetConventionUsedWithCustomTargetName : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(sourceSet: KotlinSourceSet, target: KotlinTarget, expectedTargetName: String) = build(
"""
|Accessed '$sourceSet', but $expectedTargetName target used a custom name '${target.name}' (expected '$expectedTargetName'):
|
|Replace:
| kotlin {
| $expectedTargetName("${target.name}") /* <- custom name used */
| }
|
|With:
| kotlin {
| $expectedTargetName()
| }
""".trimMargin(),
throwable = sourceSet.isAccessedByKotlinSourceSetConventionAt
)
}
object PlatformSourceSetConventionUsedWithoutCorrespondingTarget : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(sourceSet: KotlinSourceSet, expectedTargetName: String) = build(
"""
|Accessed '$sourceSet' without the registering the $expectedTargetName target:
| kotlin {
| $expectedTargetName() /* <- register the '$expectedTargetName' target */
|
| sourceSets.${sourceSet.name}.dependencies {
|
| }
| }
""".trimMargin(),
throwable = sourceSet.isAccessedByKotlinSourceSetConventionAt
)
}
object AndroidMainSourceSetConventionUsedWithoutAndroidTarget : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(sourceSet: KotlinSourceSet) = build(
"""
|Accessed '$sourceSet' without registering the Android target
|Please apply a given Android Gradle plugin (e.g. com.android.library) and register an Android target
|
|Example using the 'com.android.library' plugin:
|
| plugins {
| id("com.android.library")
| }
|
| android {
| namespace = "org.sample.library"
| compileSdk = 33
| }
|
| kotlin {
| androidTarget() /* <- register the androidTarget */
| }
""".trimMargin(),
throwable = sourceSet.isAccessedByKotlinSourceSetConventionAt
)
}
object IosSourceSetConventionUsedWithoutIosTarget : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(sourceSet: KotlinSourceSet) = build(
"""
|Accessed '$sourceSet' without registering any ios target:
| kotlin {
| /* Register at least one of the following targets */
| iosX64()
| iosArm64()
| iosSimulatorArm64()
|
| /* Use convention */
| sourceSets.${sourceSet.name}.dependencies {
|
| }
| }
""".trimMargin(),
throwable = sourceSet.isAccessedByKotlinSourceSetConventionAt
)
}
object KotlinDefaultHierarchyFallbackDependsOnUsageDetected : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(project: Project, sourceSetsWithDependsOnEdges: Iterable) = build(
"""
The Default Kotlin Hierarchy Template was not applied to '${project.displayName}':
Explicit .dependsOn() edges were configured for the following source sets:
${sourceSetsWithDependsOnEdges.toSet().map { it.name }}
Consider removing dependsOn-calls or disabling the default template by adding
'$KOTLIN_MPP_APPLY_DEFAULT_HIERARCHY_TEMPLATE=false'
to your gradle.properties
Learn more about hierarchy templates: https://kotl.in/hierarchy-template
""".trimIndent()
)
}
object KotlinDefaultHierarchyFallbackNativeTargetShortcutUsageDetected : ToolingDiagnosticFactory(WARNING) {
internal operator fun invoke(project: Project, trace: NativeTargetShortcutTrace) = build(
"""
The Default Kotlin Hierarchy Template was not applied to '${project.displayName}':
Deprecated '${trace.shortcut}()' shortcut was used:
kotlin {
${trace.shortcut}()
}
Please declare the required targets explicitly:
kotlin {
${trace.shortcut}X64()
${trace.shortcut}Arm64()
${trace.shortcut}SimulatorArm64() /* <- Note: Was not previously applied */
/* ... */
}
After that, replace `by getting` with static accessors:
sourceSets {
commonMain { ... }
${trace.shortcut}Main {
dependencies { ... }
}
}
To suppress the 'Default Hierarchy Template' add
'$KOTLIN_MPP_APPLY_DEFAULT_HIERARCHY_TEMPLATE=false'
to your gradle.properties
Learn more about hierarchy templates: https://kotl.in/hierarchy-template
""".trimIndent(),
throwable = trace
)
}
object KotlinDefaultHierarchyFallbackIllegalTargetNames : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(project: Project, illegalTargetNamesUsed: Iterable) = build(
"""
The Default Kotlin Hierarchy Template was not applied to '${project.displayName}':
Source sets created by the following targets will clash with source sets created by the template:
${illegalTargetNamesUsed.toSet()}
Consider renaming the targets or disabling the default template by adding
'$KOTLIN_MPP_APPLY_DEFAULT_HIERARCHY_TEMPLATE=false'
to your gradle.properties
Learn more about hierarchy templates: https://kotl.in/hierarchy-template
""".trimIndent()
)
}
object XCFrameworkDifferentInnerFrameworksName : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(xcFramework: String, innerFrameworks: String) = build(
"Name of XCFramework '$xcFramework' differs from inner frameworks name '$innerFrameworks'! Framework renaming is not supported yet"
)
}
object UnknownAppleFrameworkBuildType : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(envConfiguration: String) = build(
"""
Unable to detect Kotlin framework build type for CONFIGURATION=$envConfiguration automatically.
Specify 'KOTLIN_FRAMEWORK_BUILD_TYPE' to 'debug' or 'release'
""".trimIndent()
)
}
object ExperimentalArtifactsDslUsed : ToolingDiagnosticFactory(WARNING) {
operator fun invoke() = build(
"""
'kotlinArtifacts' DSL is experimental and may be changed in the future.
To suppress this warning add '$KOTLIN_NATIVE_SUPPRESS_EXPERIMENTAL_ARTIFACTS_DSL_WARNING=true' to your gradle.properties
""".trimIndent()
)
}
private val presetsDeprecationSeverity = ToolingDiagnostic.Severity.WARNING
object TargetFromPreset : ToolingDiagnosticFactory(presetsDeprecationSeverity) {
const val DEPRECATION_MESSAGE = "The targetFromPreset() $PRESETS_DEPRECATION_MESSAGE_SUFFIX"
operator fun invoke() = build(DEPRECATION_MESSAGE)
}
object FromPreset : ToolingDiagnosticFactory(presetsDeprecationSeverity) {
const val DEPRECATION_MESSAGE = "The fromPreset() $PRESETS_DEPRECATION_MESSAGE_SUFFIX"
operator fun invoke() = build(DEPRECATION_MESSAGE)
}
object CreateTarget : ToolingDiagnosticFactory(presetsDeprecationSeverity) {
const val DEPRECATION_MESSAGE = "The KotlinTargetPreset.createTarget() $PRESETS_DEPRECATION_MESSAGE_SUFFIX"
operator fun invoke() = build(DEPRECATION_MESSAGE)
}
object JvmWithJavaIsIncompatibleWithAndroid : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(androidPluginId: String, trace: Throwable?) = build(
"""
'withJava()' is not compatible with Android Plugins
Incompatible Android Plugin applied: '$androidPluginId'
kotlin {
jvm {
withJava() /* <- cannot be used when the Android Plugin is present */
}
}
""".trimIndent(),
throwable = trace
)
}
object KotlinTargetAlreadyDeclared : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(targetDslFunctionName: String) = build(
"""
Kotlin Target '$targetDslFunctionName()' is already declared.
Declaring multiple Kotlin Targets of the same type is not recommended
and will become an error in the upcoming Kotlin releases.
Read https://kotl.in/declaring-multiple-targets for details.
""".trimIndent()
)
}
object KotlinCompilationSourceDeprecation : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(trace: Throwable?) = build(
"""
`KotlinCompilation.source(KotlinSourceSet)` method is deprecated
and will be removed in upcoming Kotlin releases.
See https://kotl.in/compilation-source-deprecation for details.
""".trimIndent(),
throwable = trace,
)
}
object CircularDependsOnEdges : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(sourceSetsOnCycle: Collection) = build(
"""
Circular dependsOn hierarchy found in the Kotlin source sets: ${sourceSetsOnCycle.joinToString(" -> ")}
""".trimIndent()
)
}
object InternalKotlinGradlePluginPropertiesUsed : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(propertiesUsed: Collection) = build(
"""
|ATTENTION! This build uses the following Kotlin Gradle Plugin properties:
|
|${propertiesUsed.joinToString(separator = "\n")}
|
|Internal properties are not recommended for production use.
|Stability and future compatibility of the build is not guaranteed.
""".trimMargin()
)
}
object BuildToolsApiVersionInconsistency : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(expectedVersion: String, actualVersion: String?) = build(
"""
Artifact $KOTLIN_MODULE_GROUP:$KOTLIN_BUILD_TOOLS_API_IMPL must have version aligned with the version of KGP when compilation via the Build Tools API is disabled.
Expected version: $expectedVersion
Actual resolved version: ${actualVersion ?: "not found"}
""".trimIndent(),
)
}
object WasmSourceSetsNotFoundError : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(nameOfRequestedSourceSet: String) = build(
"""
KotlinSourceSet with name '$nameOfRequestedSourceSet' not found:
The SourceSet requested ('$nameOfRequestedSourceSet') was renamed in Kotlin 1.9.20
In order to migrate you might want to replace:
val wasmMain by getting -> val wasmJsMain by getting
val wasmTest by getting -> val wasmJsTest by getting
""".trimIndent()
)
}
object DuplicateSourceSetsError : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(duplicatedSourceSets: Map>): ToolingDiagnostic {
val duplicatesGroupsString = duplicatedSourceSets
.map { entry -> entry.value.joinToString(", ") }
.joinToString("], [", "[", "]")
return build(
"Duplicate Kotlin source sets have been detected: $duplicatesGroupsString." +
" Keep in mind that source set names are case-insensitive," +
" which means that `srcMain` and `sRcMain` are considered the same source set."
)
}
}
object CInteropRequiredParametersNotSpecifiedError : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(): ToolingDiagnostic {
return build(
"""
|For the Cinterop task, either the `definitionFile` or `packageName` parameter must be specified, however, neither has been provided.
|
|More info here: https://kotlinlang.org/docs/multiplatform-dsl-reference.html#cinterops
""".trimMargin()
)
}
}
object IncorrectCompileOnlyDependencyWarning : ToolingDiagnosticFactory(WARNING) {
data class CompilationDependenciesPair(
val compilation: KotlinCompilation<*>,
val dependencyCoords: List,
)
operator fun invoke(
compilationsWithCompileOnlyDependencies: List,
): ToolingDiagnostic {
val formattedPlatformNames = compilationsWithCompileOnlyDependencies
.map { it.compilation.platformType.prettyName }
.distinct()
.sorted()
.joinToString()
val formattedCompileOnlyDeps = compilationsWithCompileOnlyDependencies
.flatGroupBy(
keySelector = { it.dependencyCoords },
keyTransformer = { it },
valueTransformer = { it.compilation.defaultSourceSet.name },
)
.map { (dependency, sourceSetNames) ->
"$dependency (source sets: ${sourceSetNames.joinToString()})"
}
.distinct()
.sorted()
.joinToString("\n") { " - $it" }
return build(/* language=text */ """
|A compileOnly dependency is used in targets: $formattedPlatformNames.
|Dependencies:
|$formattedCompileOnlyDeps
|
|Using compileOnly dependencies in these targets is not currently supported, because compileOnly dependencies must be present during the compilation of projects that depend on this project.
|
|To ensure consistent compilation behaviour, compileOnly dependencies should be exposed as api dependencies.
|
|Example:
|
| kotlin {
| sourceSets {
| nativeMain {
| dependencies {
| compileOnly("org.example:lib:1.2.3")
| // additionally add the compileOnly dependency as an api dependency:
| api("org.example:lib:1.2.3")
| }
| }
| }
| }
|
|This warning can be suppressed in gradle.properties:
|
| ${KOTLIN_SUPPRESS_GRADLE_PLUGIN_WARNINGS_PROPERTY}=${id}
|
""".trimMargin()
)
}
}
private val resourcesBugReportRequest get() = "This is likely a bug in Kotlin Gradle Plugin configuration. Please report this issue to https://kotl.in/issue."
object ResourcePublishedMoreThanOncePerTarget : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(targetName: String) = build(
"""
Only one resources publication per target $targetName is allowed.
$resourcesBugReportRequest
""".trimIndent()
)
}
object AssetsPublishedMoreThanOncePerTarget : ToolingDiagnosticFactory(ERROR) {
operator fun invoke() = build(
"""
Only one assets publication per android target is allowed.
$resourcesBugReportRequest
""".trimIndent()
)
}
object ResourceMayNotBePublishedForTarget : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(targetName: String) = build(
"""
Resources publication for target $targetName is not supported yet.
$resourcesBugReportRequest
""".trimIndent()
)
}
object ResourceMayNotBeResolvedForTarget : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(targetName: String) = build(
"""
Resources resolution for target $targetName is not supported.
$resourcesBugReportRequest
""".trimIndent()
)
}
object ResourceMayNotBeResolvedWithGradleVersion : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(
targetName: String, currentGradleVersion: String, minimumRequiredVersion: String,
) = build(
"""
Resources for target $targetName may not be resolved. Minimum required Gradle version is ${minimumRequiredVersion} but current is ${currentGradleVersion}.
$resourcesBugReportRequest
""".trimIndent()
)
}
object UnknownValueProvidedForResourcesStrategy : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(value: String) = build(
"""
Unknown value $value provided for ${PropertiesProvider.PropertyNames.KOTLIN_MPP_RESOURCES_RESOLUTION_STRATEGY}
""".trimIndent()
)
}
object MissingRuntimeDependencyConfigurationForWasmTarget : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(targetName: String) = build(
"""
Resources will not be resolved for $targetName as it is missing runtimeDependencyConfiguration.
$resourcesBugReportRequest
""".trimIndent()
)
}
object MissingResourcesConfigurationForTarget : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(targetName: String) = build(
"""
Resources will not be resolved for $targetName as it is missing resourcesConfiguration.
$resourcesBugReportRequest
""".trimIndent()
)
}
object DependencyDoesNotPhysicallyExist : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(dependency: File) = build(
"""
Unable to find the dependency at the location '${dependency.absolutePath}'.
Please make sure that the dependency exists at the specified location or ensure that dependency declarations are correct in your project.
""".trimIndent()
)
}
object XcodeVersionTooHighWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(xcodeVersionString: String, maxTested: String) = build(
"""
Kotlin <-> Xcode compatibility issue:
The selected Xcode version ($xcodeVersionString) is higher than the maximum known to the Kotlin Gradle Plugin.
Stability in such configuration hasn't been tested, please report encountered issues to https://kotl.in/issue
Maximum tested Xcode version: $maxTested
To suppress this message add '${PropertiesProvider.PropertyNames.KOTLIN_APPLE_XCODE_COMPATIBILITY_NOWARN}=true' to your gradle.properties
""".trimIndent()
)
}
object ExperimentalFeatureWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(featureName: String, youtrackUrl: String) = build(
"""
Experimental Feature Notice ⚠️
$featureName is an experimental feature and subject to change in any future releases.
It may not function as you expect and you may encounter bugs. Use it at your own risk.
Thank you for your understanding. We would appreciate your feedback on this feature in YouTrack $youtrackUrl.
""".trimIndent()
)
}
object DeprecatedGradleProperties : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(usedDeprecatedProperty: String): ToolingDiagnostic {
return build(
"""
|The `$usedDeprecatedProperty` deprecated property is used in your build.
|Please, stop using it as it is unsupported and may apply no effect to your build.
""".trimMargin()
)
}
}
object RedundantDependsOnEdgesFound : ToolingDiagnosticFactory(WARNING) {
data class RedundantEdge(val from: String, val to: String)
operator fun invoke(redundantEdges: List): ToolingDiagnostic = build {
appendLine("Redundant dependsOn edges between Kotlin Source Sets found.")
appendLine("Please remove the following dependsOn invocations from your build scripts:")
redundantEdges.forEach { edge -> appendLine(" * ${edge.from}.dependsOn(${edge.to})") }
appendLine("They are already added from Kotlin Target Hierarchy template https://kotl.in/hierarchy-template")
}
}
object BrokenKotlinNativeBundleError : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(kotlinNativeHomePropertyValue: String?, kotlinNativeHomeProperty: String): ToolingDiagnostic =
build(
"The Kotlin/Native distribution ($kotlinNativeHomePropertyValue) used in this build does not provide required subdirectories." +
" Make sure that the '$kotlinNativeHomeProperty' property points to a valid Kotlin/Native distribution.",
)
}
object NoComposeCompilerPluginAppliedWarning : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(): ToolingDiagnostic =
build(
"The Compose compiler plugin is now a part of Kotlin, please apply the 'org.jetbrains.kotlin.plugin.compose' Gradle plugin " +
"to enable it. Learn more about this at https://kotl.in/compose-plugin"
)
}
object DeprecatedKotlinAbiSnapshotDiagnostic : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(): ToolingDiagnostic =
build(
"'${PropertiesProvider.PropertyNames.KOTLIN_ABI_SNAPSHOT}' property is deprecated and will be removed soon.\n" +
"By default this type of incremental compilation will not be supported.\n" +
"Please remove '${PropertiesProvider.PropertyNames.KOTLIN_ABI_SNAPSHOT}' usages from 'gradle.properties' file.\n"
)
}
object DeprecatedJvmHistoryBasedIncrementalCompilationDiagnostic : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(): ToolingDiagnostic =
build(
"History based incremental compilation approach for JVM platform is deprecated and will be removed" +
" soon in favor of approach based on ABI snapshots.\n" +
"Please remove '${PropertiesProvider.PropertyNames.KOTLIN_INCREMENTAL_USE_CLASSPATH_SNAPSHOT}=false' from 'gradle.properties' file."
)
}
object DeprecatedInKMPJavaPluginsDiagnostic : ToolingDiagnosticFactory(WARNING) {
operator fun invoke(pluginId: String): ToolingDiagnostic {
val pluginString = when(pluginId) {
"application" -> "'$pluginId' (also applies 'java' plugin)"
"java-library" -> "'$pluginId' (also applies 'java' plugin)"
else -> "'$pluginId'"
}
return build(
"""
|$pluginString Gradle plugin is not compatible with 'org.jetbrains.kotlin.multiplatform' plugin.
|
|Consider adding a new subproject with '$pluginId' plugin where the KMP project is added as a dependency.
""".trimMargin()
)
}
}
object XcodeUserScriptSandboxingDiagnostic : ToolingDiagnosticFactory(FATAL) {
operator fun invoke(userScriptSandboxingEnabled: Boolean) = build(
"""
${if (userScriptSandboxingEnabled) "You" else "BUILT_PRODUCTS_DIR is not accessible, probably you"} have sandboxing for user scripts enabled.
In your Xcode project, navigate to "Build Setting",
and under "Build Options" set "User script sandboxing" (ENABLE_USER_SCRIPT_SANDBOXING) to "NO".
Then, run "./gradlew --stop" to stop the Gradle daemon
For more information, see documentation: https://kotl.in/iq4uke
""".trimIndent()
)
}
object UnsupportedTargetShortcutError : ToolingDiagnosticFactory(ERROR) {
operator fun invoke(shortcutName: String, explicitTargets: String, trace: Throwable) = build(
"""
The $shortcutName target shortcut is deprecated and no longer supported.
Please explicitly declare your targets using:
""".trimIndent() + explicitTargets + """
For a complete list of supported targets, refer to the documentation: https://kotl.in/6ixl2f
""".trimIndent(),
throwable = trace
)
}
object ProjectIsolationIncompatibleWithIncludedBuildsWithOldKotlinVersion: ToolingDiagnosticFactory(WARNING) {
operator fun invoke(dependency: String, includedProjectPath: String): ToolingDiagnostic = build(
"""
Dependency '$dependency' resolved into included build project '$includedProjectPath'.
However Kotlin Multiplatform can't process such dependency with enabled Project Isolation support.
Please consider upgrading Kotlin Version to the latest one in '$includedProjectPath' project.
""".trimIndent()
)
}
}
private fun String.indentLines(nSpaces: Int = 4, skipFirstLine: Boolean = true): String {
val spaces = String(CharArray(nSpaces) { ' ' })
return lines()
.withIndex()
.joinToString(separator = "\n") { (index, line) ->
if (skipFirstLine && index == 0) return@joinToString line
if (line.isNotBlank()) "$spaces$line" else line
}
}
