Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the ability to get serialized configuration of a task #3008

Merged
merged 3 commits into from
May 30, 2023
Merged

Add the ability to get serialized configuration of a task #3008

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acd6257
Add the ability to get serialized configuration of a task
IgnatBeresnev May 23, 2023
8a62144
Rename the function to not be suggested under "get" autocompletion
IgnatBeresnev May 23, 2023
795b1b4
Add the ability to build compact json
IgnatBeresnev May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions runners/gradle-plugin/api/gradle-plugin.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,11 @@ public final class org/jetbrains/dokka/gradle/SourceSetKotlinGistConfigurationKt
public static final fun configureWithKotlinSourceSet (Lorg/jetbrains/dokka/gradle/GradleDokkaSourceSetBuilder;Lorg/jetbrains/kotlin/gradle/plugin/KotlinSourceSet;)V
}

public final class org/jetbrains/dokka/gradle/internal/AbstractDokkaTaskExtensionsKt {
public static final fun buildJsonConfiguration (Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;Z)Ljava/lang/String;
public static synthetic fun buildJsonConfiguration$default (Lorg/jetbrains/dokka/gradle/AbstractDokkaTask;ZILjava/lang/Object;)Ljava/lang/String;
}

public final class org/jetbrains/dokka/gradle/kotlin/KotlinClasspathUtilsKt {
public static final fun isHMPPEnabled (Lorg/gradle/api/Project;)Z
}
Expand Down
24 changes: 24 additions & 0 deletions ...plugin/src/main/kotlin/org/jetbrains/dokka/gradle/internal/AbstractDokkaTaskExtensions.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package org.jetbrains.dokka.gradle.internal

import org.jetbrains.dokka.InternalDokkaApi
import org.jetbrains.dokka.gradle.AbstractDokkaTask
import org.jetbrains.dokka.toPrettyJsonString
import org.jetbrains.dokka.DokkaConfiguration
import org.jetbrains.dokka.toCompactJsonString

/**
* Serializes [DokkaConfiguration] of this [AbstractDokkaTask] as json
*
* Should be used for short-term debugging only, no guarantees are given for the support of this API.
*
* Better alternative should be introduced as part of [#2873](https://github.com/Kotlin/dokka/issues/2873).
*/
@InternalDokkaApi
fun AbstractDokkaTask.buildJsonConfiguration(prettyPrint: Boolean = true): String {
val configuration = this.buildDokkaConfiguration()
return if (prettyPrint) {
configuration.toPrettyJsonString()
} else {
configuration.toCompactJsonString()
}
}