kotlin-gradle-plugin-api/org.jetbrains.kotlin.gradle.plugin/KotlinSourceSet

KotlinSourceSet

interface KotlinSourceSet : Named, HasProject, HasMutableExtras, HasKotlinDependencies

Represents a logical group of Kotlin files, including sources, resources and additional metadata describing how this group participates in the compilation of this project.

For example, here's a common way to access all available within Kotlin source sets:

kotlin.sourceSets.configureEach {
   // Here you can configure all Kotlin source sets.
   // For example, to add an additional source directory.
   kotlin.srcDir(project.layout.buildDirectory.dir("generatedSources"))
}

See also

KotlinSourceSetContainer

Types

object Companion

Constants for KotlinSourceSet.

Properties

apiConfigurationName

abstract val apiConfigurationName: String

The name of the Gradle Configuration that contains api dependencies.

compileOnlyConfigurationName

abstract val compileOnlyConfigurationName: String

The name of the Gradle Configuration containing compileOnly dependencies.

customSourceFilesExtensions

abstract val customSourceFilesExtensions: Iterable<String>

Contains a set of custom file extensions used to identify source files for this KotlinSourceSet.

abstract val dependsOn: Set<KotlinSourceSet>

Returns a set of source sets that have a dependsOn relationship with this source set.

abstract override val extras: MutableExtras

implementationConfigurationName

abstract val implementationConfigurationName: String

The name of the Gradle Configuration that contains implementation dependencies.

abstract val kotlin: SourceDirectorySet

Represents a set of Kotlin source files that are included in this KotlinSourceSet.

languageSettings

abstract val languageSettings: LanguageSettingsBuilder

Provides the DSL to configure a subset of Kotlin compilation language settings for this KotlinSourceSet.

abstract val project: Project

The Gradle Project associated with the entity.

abstract val resources: SourceDirectorySet

Represents a set of resource files that are included in this KotlinSourceSet.

runtimeOnlyConfigurationName

abstract val runtimeOnlyConfigurationName: String

The name of the Gradle Configuration containing runtimeOnly dependencies.

Functions

addCustomSourceFilesExtensions

open fun addCustomSourceFilesExtensions(extensions: List<String>)

Adds additional custom source file extensions for the KotlinSourceSet so that they are included as compilation inputs.

abstract fun dependencies(configure: KotlinDependencyHandler.() -> Unit)

abstract fun dependencies(configure: Action<KotlinDependencyHandler>)

Configures all dependencies for this entity.

abstract fun dependsOn(other: KotlinSourceSet)

Adds a Kotlin-specific relation to the other source set.

abstract fun getName(): String

abstract fun kotlin(configure: SourceDirectorySet.() -> Unit): SourceDirectorySet

abstract fun kotlin(configure: Action<SourceDirectorySet>): SourceDirectorySet

Configures the SourceDirectorySet containing Kotlin source files with the provided configuration.

languageSettings

abstract fun languageSettings(configure: LanguageSettingsBuilder.() -> Unit): LanguageSettingsBuilder

Configures the LanguageSettingsBuilder source set with the provided configuration.

abstract fun languageSettings(configure: Action<LanguageSettingsBuilder>): LanguageSettingsBuilder

Configures the LanguageSettingsBuilder in the source set with the provided configuration.