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

KotlinDependencyHandler

interface KotlinDependencyHandler : HasProject

Represents a DSL for managing the dependencies of Kotlin entities that implement a HasKotlinDependencies interface.

Functions

api

abstract fun api(dependencyNotation: Any): Dependency?

abstract fun api(dependencyNotation: String, configure: ExternalModuleDependency.() -> Unit): ExternalModuleDependency

open fun api(dependencyNotation: String, configure: Action<ExternalModuleDependency>): ExternalModuleDependency

Adds an api module dependency to this entity.

abstract fun <T : Dependency> api(dependency: T, configure: T.() -> Unit): T

open fun <T : Dependency> api(dependency: T, configure: Action<T>): T

Adds an api dependency to this entity.

compileOnly

abstract fun compileOnly(dependencyNotation: Any): Dependency?

abstract fun compileOnly(dependencyNotation: String, configure: ExternalModuleDependency.() -> Unit): ExternalModuleDependency

open fun compileOnly(dependencyNotation: String, configure: Action<ExternalModuleDependency>): ExternalModuleDependency

Adds a compileOnly module dependency to this entity.

abstract fun <T : Dependency> compileOnly(dependency: T, configure: T.() -> Unit): T

open fun <T : Dependency> compileOnly(dependency: T, configure: Action<T>): T

Adds a compileOnly dependency to this entity.

devNpm

abstract fun devNpm(directory: File): Dependency

Creates a dependency to a NPM module that is added to devDependencies. The name of the dependency is derived either from the package.json file located in the directory or the directory name itself.

abstract fun devNpm(name: String, directory: File): Dependency

abstract fun devNpm(name: String, version: String): Dependency

Creates a dependency to a NPM module that is added to devDependencies.

implementation

abstract fun implementation(dependencyNotation: Any): Dependency?

abstract fun implementation(dependencyNotation: String, configure: ExternalModuleDependency.() -> Unit): ExternalModuleDependency

open fun implementation(dependencyNotation: String, configure: Action<ExternalModuleDependency>): ExternalModuleDependency

Adds an implementation module dependency to this entity.

abstract fun <T : Dependency> implementation(dependency: T, configure: T.() -> Unit): T

open fun <T : Dependency> implementation(dependency: T, configure: Action<T>): T

Adds an implementation dependency to this entity.

kotlin

open fun kotlin(simpleModuleName: String): ExternalModuleDependency

Creates a dependency to an official Kotlin library with the same version that is configured in KotlinBaseExtension.coreLibrariesVersion.

abstract fun kotlin(simpleModuleName: String, version: String?): ExternalModuleDependency

Creates a dependency to an official Kotlin library.

npm

abstract fun npm(directory: File): Dependency

Creates a dependency on the NPM module. The name of the dependency is derived either from the package.json file located in the directory or the directory name itself.

abstract fun npm(name: String, directory: File): Dependency

abstract fun npm(name: String, version: String): Dependency

Creates a dependency on the NPM module.

optionalNpm

abstract fun optionalNpm(directory: File): Dependency

Creates a dependency to a NPM module that is added to optionalDependencies. The name of the dependency is derived either from the package.json file located in the directory or the directory name itself.

abstract fun optionalNpm(name: String, directory: File): Dependency

abstract fun optionalNpm(name: String, version: String): Dependency

Creates a dependency to a NPM module that is added to optionalDependencies.

peerNpm

abstract fun peerNpm(name: String, version: String): Dependency

Creates a dependency to a NPM module that is added to peerDependencies.

project

open fun project(path: String): ProjectDependency

abstract fun project(notation: Map<String, Any?>): ProjectDependency

open fun project(path: String, configuration: String? = null): ProjectDependency

Creates a Gradle project dependency.

runtimeOnly

abstract fun runtimeOnly(dependencyNotation: Any): Dependency?

abstract fun runtimeOnly(dependencyNotation: String, configure: ExternalModuleDependency.() -> Unit): ExternalModuleDependency

open fun runtimeOnly(dependencyNotation: String, configure: Action<ExternalModuleDependency>): ExternalModuleDependency

Adds a runtimeOnly module dependency to this entity.

abstract fun <T : Dependency> runtimeOnly(dependency: T, configure: T.() -> Unit): T

open fun <T : Dependency> runtimeOnly(dependency: T, configure: Action<T>): T

Adds a runtimeOnly dependency to this entity.