aboutsummaryrefslogtreecommitdiff
path: root/dokka-runners/runner-gradle-plugin-classic/build.gradle.kts
blob: 4b142cc85c2862eb994f6b9aec28b86cc8d0ab4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*
 * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
 */

import dokkabuild.PublicationName
import dokkabuild.overridePublicationArtifactId

plugins {
    id("dokkabuild.gradle-plugin")
    alias(libs.plugins.kotlinx.binaryCompatibilityValidator)
}

overridePublicationArtifactId("dokka-gradle-plugin", PublicationName.GRADLE_PLUGIN)

dependencies {
    // the version is required for Gradle plugin publishing
    api("org.jetbrains.dokka:dokka-core:$version")

    compileOnly(libs.gradlePlugin.kotlin)
    compileOnly(libs.gradlePlugin.kotlin.klibCommonizerApi)
    compileOnly(libs.gradlePlugin.android)

    testImplementation(kotlin("test"))
    testImplementation(libs.gradlePlugin.kotlin)
    testImplementation(libs.gradlePlugin.kotlin.klibCommonizerApi)
    testImplementation(libs.gradlePlugin.android)
}

@Suppress("UnstableApiUsage")
gradlePlugin {
    plugins {
        create("dokka") {
            id = "org.jetbrains.dokka"
            implementationClass = "org.jetbrains.dokka.gradle.DokkaPlugin"

            displayName = "Dokka plugin"
            description = "Dokka is an API documentation engine for Kotlin"
            tags.addAll("dokka", "kotlin", "kdoc", "android", "documentation", "api")
        }
    }
}

// Gradle will put its own version of the stdlib in the classpath, so not pull our own we will end up with
// warnings like 'Runtime JAR files in the classpath should have the same version'
listOf(
    configurations.api,
    configurations.implementation,
    configurations.runtimeOnly
).forEach {
    it.configure { excludeGradleCommonDependencies() }
}

/**
 * These dependencies will be provided by Gradle, and we should prevent version conflict
 * Code taken from the Kotlin Gradle plugin:
 * https://github.com/JetBrains/kotlin/blob/70e15b281cb43379068facb82b8e4bcb897a3c4f/buildSrc/src/main/kotlin/GradleCommon.kt#L72
 */
fun Configuration.excludeGradleCommonDependencies() {
    dependencies
        .withType<ModuleDependency>()
        .configureEach {
            exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib")
            exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib-jdk7")
            exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib-jdk8")
            exclude(group = "org.jetbrains.kotlin", module = "kotlin-stdlib-common")
            exclude(group = "org.jetbrains.kotlin", module = "kotlin-reflect")
            exclude(group = "org.jetbrains.kotlin", module = "kotlin-script-runtime")
        }
}