replace the Dokka Gradle plugin with Dokkatoo

https://github.com/adamko-dev/dokkatoo
square · Nov 20, 2023 · 4e79743 · 4e79743
1 parent 18ae172
commit 4e79743
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 9 deletions.
diff --git a/build-logic/build.gradle b/build-logic/build.gradle
@@ -31,6 +31,7 @@ dependencies {
   compileOnly(gradleApi())
   implementation libs.ktlintRaw
   implementation libs.kgx
+  implementation libs.dokkatoo.plugin
   implementation libs.kotlinpoet
   implementation libs.kotlin.dokka
   implementation libs.kotlin.gradlePlugin

diff --git a/build-logic/src/main/kotlin/com/squareup/anvil/PublishConventionPlugin.kt b/build-logic/src/main/kotlin/com/squareup/anvil/PublishConventionPlugin.kt
@@ -1,9 +1,14 @@
 package com.squareup.anvil
 
+import com.rickbusarow.kgx.libsCatalog
+import com.rickbusarow.kgx.version
 import com.vanniktech.maven.publish.JavadocJar
 import com.vanniktech.maven.publish.KotlinJvm
 import com.vanniktech.maven.publish.MavenPublishBaseExtension
+import com.vanniktech.maven.publish.MavenPublishBasePlugin
 import com.vanniktech.maven.publish.Platform
+import dev.adamko.dokkatoo.DokkatooExtension
+import dev.adamko.dokkatoo.DokkatooPlugin
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.publish.PublishingExtension
@@ -14,9 +19,9 @@ import javax.inject.Inject
 
 open class PublishConventionPlugin : Plugin<Project> {
   override fun apply(target: Project) {
+    target.plugins.apply(MavenPublishBasePlugin::class.java)
 
-    target.plugins.apply("com.vanniktech.maven.publish.base")
-    target.plugins.apply("org.jetbrains.dokka")
+    target.applyDokkatoo()
 
     target.extensions.create("publish", PublishExtension::class.java)
 
@@ -30,7 +35,6 @@ open class PublishConventionPlugin : Plugin<Project> {
     mavenPublishing.signAllPublications()
 
     target.plugins.withId("org.jetbrains.kotlin.jvm") {
-
       when {
         target.plugins.hasPlugin(pluginPublishId) -> {
           // Gradle's 'plugin-publish' plugin creates its own publication.  We only apply this plugin
@@ -41,13 +45,23 @@ open class PublishConventionPlugin : Plugin<Project> {
           configurePublication(
             target,
             mavenPublishing,
-            KotlinJvm(javadocJar = JavadocJar.Dokka("dokkaHtml"), sourcesJar = true),
+            KotlinJvm(
+              javadocJar = JavadocJar.Dokka("dokkatooGeneratePublicationHtml"),
+              sourcesJar = true,
+            ),
           )
         }
       }
     }
   }
 
+  private fun Project.applyDokkatoo() {
+    plugins.apply(DokkatooPlugin::class.java)
+    extensions.configure(DokkatooExtension::class.java) {
+      it.versions.jetbrainsDokka.set(libsCatalog.version("dokka"))
+    }
+  }
+
   @Suppress("UnstableApiUsage")
   private fun configurePublication(
     target: Project,

diff --git a/compiler/build.gradle b/compiler/build.gradle
@@ -52,11 +52,6 @@ dependencies {
   testImplementation libs.truth
 }
 
-// Fixes:
-// Reason: Task ':compiler:dokkaHtml' uses this output of task ':compiler:kaptKotlin'
-// without declaring an explicit or implicit dependency.
-tasks.named("dokkaHtml") { mustRunAfter("kaptKotlin") }
-
 tasks.withType(KotlinCompile).configureEach {
   compilerOptions {
     // The flag is needed because we extend an interface that uses @JvmDefault and the Kotlin

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -18,6 +18,7 @@ autoValue = "1.10.4"
 buildconfig = "4.1.2"
 dagger = "2.46.1"
 dokka = "1.9.10"
+dokkatoo = "2.0.0"
 espresso = "3.5.1"
 gradlePublish = "1.2.1"
 kct = "0.3.1"
@@ -48,6 +49,7 @@ config-generateDaggerFactoriesWithAnvil = "true"
 agp-application = { id = "com.android.application", version.ref = "agp" }
 agp-library = { id = "com.android.library", version.ref = "agp" }
 buildconfig = { id = "com.github.gmazzo.buildconfig", version.ref = "buildconfig" }
+dokkatoo = { id = "dev.adamko.dokkatoo", version.ref = "dokkatoo" }
 gradlePublish = { id = "com.gradle.plugin-publish", version.ref = "gradlePublish" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 kotlin-dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
@@ -78,6 +80,8 @@ auto-value-processor = { module = "com.google.auto.value:auto-value", version.re
 dagger2 = { module = "com.google.dagger:dagger", version.ref = "dagger" }
 dagger2-compiler = { module = "com.google.dagger:dagger-compiler", version.ref = "dagger" }
 
+dokkatoo-plugin = { module = "dev.adamko.dokkatoo:dokkatoo-plugin", version.ref = "dokkatoo" }
+
 gradlePublishRaw = { module = "com.gradle.publish:plugin-publish-plugin", version.ref = "gradlePublish" }
 
 inject = "javax.inject:javax.inject:1"