Apply requested changes

Kotlin · Jan 7, 2022 · be5060c · be5060c
1 parent 0ae0222
commit be5060c
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 67 deletions.
diff --git a/core/src/main/kotlin/utilities/json.kt b/core/src/main/kotlin/utilities/json.kt
@@ -31,9 +31,7 @@ internal class TypeReference<T> private constructor(
 @PublishedApi
 internal fun toJsonString(value: Any): String = objectMapper.writeValueAsString(value)
 
-@PublishedApi
-internal inline fun <reified T : Any> parseJson(json: String): T = parseJson(json, TypeReference())
-
+inline fun <reified T : Any> parseJson(json: String): T = parseJson(json, TypeReference())
 
 @PublishedApi
 internal fun <T : Any> parseJson(json: String, typeReference: TypeReference<T>): T =

diff --git a/...ion-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt b/...ion-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt
@@ -264,7 +264,7 @@ class CliIntegrationTest : AbstractCliIntegrationTest() {
 
 
     @Test
-    fun json() {
+    fun `should accept json as input configuration`() {
         val dokkaOutputDir = File(projectDir, "output")
         assertTrue(dokkaOutputDir.mkdirs())
         val jsonPath = javaClass.getResource("/my-file.json")?.path ?: throw IllegalStateException("No JSON found!")
@@ -303,7 +303,7 @@ class CliIntegrationTest : AbstractCliIntegrationTest() {
      * make sure that global settings apply to dokka context.
      */
     @Test
-    fun jsonWithGlobals() {
+    fun `global settings should overwrite package options in configuration`() {
         val dokkaOutputDir = File(projectDir, "output")
         assertTrue(dokkaOutputDir.mkdirs())
         val jsonPath = javaClass.getResource("/my-file.json")?.path ?: throw IllegalStateException("No JSON found!")

diff --git a/plugins/all-modules-page/out/index.md b/plugins/all-modules-page/out/index.md
diff --git a/runners/cli/src/main/kotlin/cli/JsonMapperForCLI.kt b/runners/cli/src/main/kotlin/cli/JsonMapperForCLI.kt
diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt
@@ -404,11 +404,24 @@ fun parseLinks(links: List<String>): List<ExternalDocumentationLink> {
             }
 }
 
+
+/**
+ * Global options are applied to all packages and modules and overwrite package configuration.
+ *
+ * These are handy if we have multiple sourcesets sharing the same global options as it reduces the size of the boilerplate.
+ * Otherwise, the user would be enforced to repeat all these options per each sourceset.
+ */
+data class GlobalDokkaConfiguration(
+    val perPackageOptions: List<PackageOptionsImpl>?,
+    val externalDocumentationLinks: List<ExternalDocumentationLinkImpl>?,
+    val sourceLinks: List<SourceLinkDefinitionImpl>?
+)
+
 fun initializeConfiguration(globalArguments: GlobalArguments): DokkaConfiguration = if (globalArguments.json != null) {
         val jsonContent = Paths.get(checkNotNull(globalArguments.json)).toFile().readText()
         val globals: GlobalDokkaConfiguration = parseJson(jsonContent)
         val dokkaConfigurationImpl = DokkaConfigurationImpl(jsonContent)
-        dokkaConfigurationImpl.run {
+        dokkaConfigurationImpl.apply {
             sourceSets.forEach {
                 it.perPackageOptions.cast<MutableList<DokkaConfiguration.PackageOptions>>().addAll(globals.perPackageOptions ?: emptyList())
             }
@@ -425,7 +438,6 @@ fun initializeConfiguration(globalArguments: GlobalArguments): DokkaConfiguratio
                 it.externalDocumentationLinks.cast<MutableSet<ExternalDocumentationLink>>().addAll(defaultLinks(it))
             }
         }
-        dokkaConfigurationImpl
     } else {
         globalArguments
     }

diff --git a/runners/cli/src/test/kotlin/cli/CliTest.kt b/runners/cli/src/test/kotlin/cli/CliTest.kt
@@ -3,13 +3,14 @@ package org.jetbrains.dokka
 import junit.framework.Assert.assertTrue
 import org.junit.Test
 import java.lang.IllegalStateException
+import java.nio.file.Paths
 import kotlin.test.assertEquals
 
 class CliIntegrationTest {
 
     @Test
-    fun testGlobalArgs() {
-        val jsonPath = javaClass.getResource("/my-file.json")?.path ?: throw IllegalStateException("No JSON found!")
+    fun `should apply global settings to all source sets`() {
+        val jsonPath = Paths.get(javaClass.getResource("/my-file.json")?.toURI() ?: throw IllegalStateException("No JSON found!")).toFile().toString()
         val globalArguments = GlobalArguments(arrayOf(jsonPath))
 
         val configuration = initializeConfiguration(globalArguments)