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

KotlinCompilerPluginSupportPlugin

interface KotlinCompilerPluginSupportPlugin : Plugin<Project>

Gradle plugin implementing support for a Kotlin compiler plugin.

All supplemental Gradle plugins for Kotlin compiler plugins must implement this interface and be applied to the project as a regular Gradle Plugin before the Kotlin plugin inspects the project model in an afterEvaluate handler.

The Kotlin Gradle plugin then uses the isApplicable method to check if the Kotlin compiler plugin works for the KotlinCompilations of the project. For applicable KotlinCompilations, the Kotlin Gradle plugin calls applyToCompilation later during the configuration phase.

Functions

Link copied to clipboard
open override fun apply(target: Project)

Apply this plugin to the given target Project.

Link copied to clipboard
abstract fun applyToCompilation(kotlinCompilation: KotlinCompilation<*>): Provider<List<SubpluginOption>>

Applies this Kotlin compiler plugin to the specified applicable kotlinCompilation compilation with the provided compiler plugin options.

Link copied to clipboard
abstract fun getCompilerPluginId(): String

Retrieves the unique identifier for the Kotlin compiler plugin configuration options.

Link copied to clipboard
abstract fun getPluginArtifact(): SubpluginArtifact

Retrieves the Maven coordinates of the Kotlin compiler plugin associated with this supplemental Gradle plugin.

Link copied to clipboard
open fun getPluginArtifactForNative(): SubpluginArtifact?

Retrieves the Maven coordinates of the legacy Kotlin/Native-specific compiler plugin associated with this supplemental Gradle plugin.

Link copied to clipboard
abstract fun isApplicable(kotlinCompilation: KotlinCompilation<*>): Boolean

Determines if the Kotlin compiler plugin is applicable for the provided kotlinCompilation.