Skip to content

Commit

Permalink
Fix Dokkatoo configurations default visibility (#204)
Browse files Browse the repository at this point in the history
* don't make Dokkatoo Configurations visible by default, Gradle adds an automatic link to assemble tasks for some weird reason

* fix dokkatooPlugin conf name
  • Loading branch information
aSemy authored Mar 24, 2024
1 parent 8fa0d52 commit bbff41c
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ dependencies {
dokkatooPluginHtml("org.jetbrains.dokka:kotlin-as-java-plugin")
dokkatooPluginJavadoc("org.jetbrains.dokka:kotlin-as-java-plugin")
dokkatooPluginJekyll("org.jetbrains.dokka:kotlin-as-java-plugin")
dokkatooPluginMarkdown("org.jetbrains.dokka:kotlin-as-java-plugin")
dokkatooPluginGfm("org.jetbrains.dokka:kotlin-as-java-plugin")
}
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ internal fun Configuration.declarable(
* ```
*/
internal fun Configuration.consumable(
visible: Boolean = true,
visible: Boolean = false,
) {
isCanBeResolved = false
isCanBeConsumed = true
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package dev.adamko.dokkatoo

import dev.adamko.dokkatoo.utils.addArguments
import dev.adamko.dokkatoo.utils.build
import dev.adamko.dokkatoo.utils.name
import dev.adamko.dokkatoo.utils.projects.initMultiModuleProject
import io.kotest.core.spec.style.FunSpec
import io.kotest.datatest.withData
import io.kotest.inspectors.shouldForAll
import io.kotest.inspectors.shouldForOne
import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldNotContainIgnoringCase

class DokkatooBaseTasksLinksTest : FunSpec({

context("Verify that the base lifecycle tasks do not trigger Dokkatoo tasks") {
val project = initMultiModuleProject("TaskLinks")

withData(
"assemble",
"build",
"check",
"clean",
) { baseTask ->
project.runner
.addArguments(
baseTask,
"--quiet",
)
.build {
tasks.shouldForOne { it.path shouldBe ":${baseTask}" }
tasks.shouldForOne { it.path shouldBe ":subproject-goodbye:${baseTask}" }
tasks.shouldForOne { it.path shouldBe ":subproject-hello:${baseTask}" }

tasks.shouldForAll { task ->
task.name shouldNotContainIgnoringCase "dokkatoo"
}
}
}
}
})

0 comments on commit bbff41c

Please sign in to comment.