kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.dsl/KotlinTopLevelExtension

KotlinTopLevelExtension

interface ~~KotlinTopLevelExtension~~ : KotlinTopLevelExtensionConfig, KotlinSourceSetContainer

Deprecated

Replaced with 'KotlinBaseExtension'

Replace with

KotlinBaseExtension

A plugin DSL extension for configuring common options for the entire project.

Use the extension in your build script in the kotlin block:

kotlin {
   // Your extension configuration
}

Since

2.1.0

Inheritors

KotlinBaseExtension

Properties

compilerVersion

abstract val compilerVersion: Property<String>

The version of the Kotlin compiler.

coreLibrariesVersion

abstract var coreLibrariesVersion: String

Specifies the version of the core Kotlin libraries that are added to the Kotlin compile classpath, unless there is already a dependency added to this project.

explicitApi

abstract var explicitApi: ExplicitApiMode?

Configures default explicit API mode for all non-test compilations in the project.

kotlinDaemonJvmArgs

abstract var kotlinDaemonJvmArgs: List<String>

Configures Kotlin daemon JVM arguments for all tasks in this project.

sourceSets

abstract val sourceSets: NamedDomainObjectContainer<KotlinSourceSet>

A NamedDomainObjectContainer containing all registered KotlinSourceSets in this project.

Functions

explicitApi

abstract fun explicitApi()

Sets explicitApi option to report issues as errors.

explicitApiWarning

abstract fun explicitApiWarning()

Sets explicitApi option to report issues as warnings.

invokeWhenCreated

abstract fun <T : Named> NamedDomainObjectContainer<T>.invokeWhenCreated(name: String, configure: T.() -> Unit)

Can be used to configure objects that are not yet created, or will be created in 'afterEvaluate' (for example, typically for Android source sets containing flavors and buildTypes).

jvmToolchain

abstract fun jvmToolchain(jdkVersion: Int)

abstract fun jvmToolchain(action: Action<JavaToolchainSpec>)

Configures Java toolchain both for Kotlin JVM and Java tasks in the project.