Make dokka-analysis dependency compileOnly in base plugin

Kotlin · Jun 6, 2022 · b210387 · b210387
1 parent 73f78dc
commit b210387
Show file tree

Hide file tree

Showing 9 changed files with 13 additions and 5 deletions.
diff --git a/integration-tests/cli/build.gradle.kts b/integration-tests/cli/build.gradle.kts
@@ -23,6 +23,7 @@ val basePluginShadow: Configuration by configurations.creating {
 
 dependencies {
     basePluginShadow(project(":plugins:base"))
+    basePluginShadow(project(":kotlin-analysis")) // compileOnly in base plugin
 }
 val basePluginShadowJar by tasks.register("basePluginShadowJar", ShadowJar::class) {
     configurations = listOf(basePluginShadow)

diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts
@@ -12,9 +12,7 @@ plugins {
 
 buildscript {
     dependencies {
-        classpath("org.jetbrains.dokka:dokka-base:${System.getenv("DOKKA_VERSION")}") {
-            exclude(group = "org.jetbrains.dokka", module = "dokka-analysis") // Gradle has embeddable Kotlin compiler
-        }
+        classpath("org.jetbrains.dokka:dokka-base:${System.getenv("DOKKA_VERSION")}")
     }
 }
 

diff --git a/plugins/all-modules-page/build.gradle.kts b/plugins/all-modules-page/build.gradle.kts
@@ -5,6 +5,7 @@ registerDokkaArtifactPublication("dokkaAllModulesPage") {
 }
 
 dependencies {
+    compileOnly(project(":kotlin-analysis"))
     implementation(project(":plugins:base"))
     implementation(project(":plugins:templating"))
     testImplementation(project(":plugins:base"))

diff --git a/plugins/base/build.gradle.kts b/plugins/base/build.gradle.kts
@@ -5,7 +5,7 @@ dependencies {
     val coroutines_version: String by project
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version")
 
-    api(project(":kotlin-analysis"))
+    compileOnly(project(":kotlin-analysis"))
     val jsoup_version: String by project
     implementation("org.jsoup:jsoup:$jsoup_version")
 
@@ -20,6 +20,8 @@ dependencies {
 
     val kotlinx_html_version: String by project
     implementation("org.jetbrains.kotlinx:kotlinx-html-jvm:$kotlinx_html_version")
+
+    testCompileOnly(project(":kotlin-analysis"))
 }
 
 val projectDistDir = project(":plugins:base:frontend").file("dist")

diff --git a/plugins/javadoc/build.gradle.kts b/plugins/javadoc/build.gradle.kts
@@ -1,6 +1,7 @@
 import org.jetbrains.registerDokkaArtifactPublication
 
 dependencies {
+    compileOnly(project(":kotlin-analysis"))
     implementation("com.soywiz.korlibs.korte:korte-jvm:2.7.0")
     implementation(project(":plugins:base"))
     implementation(project(":plugins:kotlin-as-java"))

diff --git a/plugins/kotlin-as-java/build.gradle.kts b/plugins/kotlin-as-java/build.gradle.kts
@@ -1,12 +1,14 @@
 import org.jetbrains.registerDokkaArtifactPublication
 
 dependencies {
+    compileOnly(project(":kotlin-analysis"))
     implementation(project(":plugins:base"))
     testImplementation(project(":plugins:base"))
     testImplementation(project(":plugins:base:base-test-utils"))
     testImplementation(project(":core:content-matcher-test-utils"))
     val jsoup_version: String by project
     testImplementation("org.jsoup:jsoup:$jsoup_version")
+    testCompileOnly(project(":kotlin-analysis"))
 }
 
 registerDokkaArtifactPublication("kotlinAsJavaPlugin") {

diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaArtifacts.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/DokkaArtifacts.kt
@@ -10,6 +10,7 @@ internal class DokkaArtifacts(private val project: Project) {
     private fun fromModuleName(name: String): Dependency =
         project.dependencies.create("org.jetbrains.dokka:$name:${DokkaVersion.version}")
 
+    val dokkaAnalysis get() = fromModuleName("dokka-analysis")
     val allModulesPage get() = fromModuleName("all-modules-page-plugin")
     val dokkaCore get() = fromModuleName("dokka-core")
     val dokkaBase get() = fromModuleName("dokka-base")

diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/gradleConfigurations.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/gradleConfigurations.kt
@@ -24,6 +24,7 @@ internal fun Project.maybeCreateDokkaPluginConfiguration(dokkaTaskName: String,
         extendsFrom(maybeCreateDokkaDefaultPluginConfiguration())
         attributes.attribute(Usage.USAGE_ATTRIBUTE, project.objects.named(Usage::class.java, "java-runtime"))
         isCanBeConsumed = false
+        dependencies.add(project.dokkaArtifacts.dokkaAnalysis) // compileOnly in base plugin
         dependencies.add(project.dokkaArtifacts.dokkaBase)
         dependencies.addAll(additionalDependencies)
     }

diff --git a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt
@@ -257,7 +257,8 @@ abstract class AbstractDokkaMojo(private val defaultDokkaPlugins: List<Dependenc
             offlineMode = offlineMode,
             cacheRoot = cacheRoot?.let(::File),
             sourceSets = listOf(sourceSet),
-            pluginsClasspath = getArtifactByMaven("org.jetbrains.dokka", "dokka-base", dokkaVersion) +
+            pluginsClasspath = getArtifactByMaven("org.jetbrains.dokka", "dokka-analysis", dokkaVersion) + // compileOnly in base plugin
+                    getArtifactByMaven("org.jetbrains.dokka", "dokka-base", dokkaVersion) +
                     dokkaPlugins.map { getArtifactByMaven(it.groupId, it.artifactId, it.version ?: dokkaVersion) }
                         .flatten(),
             pluginsConfiguration = pluginsConfiguration.toMutableList(),