chore: fix publish task, dokka and dep updates

sureshg · sureshg · commit 5d1f0de6961c · 2023-09-04T02:48:53.000-07:00
diff --git a/benchmark/build.gradle.kts b/benchmark/build.gradle.kts
@@ -1,4 +1,3 @@
 plugins { plugins.kotlin.benchmark }
 
-// mppTargetName = "jvm"
 dependencies { commonMainImplementation(projects.common) }
diff --git a/client/build.gradle.kts b/client/build.gradle.kts
diff --git a/gradle/build-logic/common-plugins/build.gradle.kts b/gradle/build-logic/common-plugins/build.gradle.kts
@@ -128,8 +128,9 @@ dependencies {
   implementation(libs.build.kotlinx.kover)
   implementation(libs.build.kotlinx.benchmark)
   implementation(libs.build.kotlinx.bincompat)
-  implementation(libs.build.dokka)
-  implementation(libs.build.ksp.redacted)
+  implementation(libs.build.dokka.plugin)
+  implementation(libs.build.dokka.base)
+  implementation(libs.build.redacted.plugin)
   implementation(libs.build.gradle.enterprise)
   implementation(libs.build.nexus.plugin)
   implementation(libs.build.spotless.plugin)
diff --git a/gradle/build-logic/common-plugins/src/main/kotlin/common/CommonExtns.kt b/gradle/build-logic/common-plugins/src/main/kotlin/common/CommonExtns.kt
@@ -6,6 +6,7 @@ import java.nio.file.Files
 import java.nio.file.Path
 import java.text.DecimalFormat
 import java.text.NumberFormat
+import kotlin.jvm.optionals.getOrNull
 import kotlin.math.ln
 import kotlin.math.pow
 import kotlin.properties.ReadOnlyProperty
@@ -19,6 +20,35 @@ internal val DEC_FORMAT = DecimalFormat("#.##")
 /** OS temp location */
 val tmp: String = "${System.getProperty("java.io.tmpdir")}${File.separator}"
 
+/** Returns the method name contains this call-site */
+inline val methodName
+  get() = StackWalker.getInstance().walk { it.findFirst().getOrNull()?.methodName }
+
+/** Read the [Class] as [ByteArray] */
+fun <T : Class<*>> T.toBytes() =
+    classLoader.getResourceAsStream("${name.replace('.', '/')}.class")?.readBytes()
+
+/**
+ * Returns the actual class URL
+ *
+ * ```
+ * val url = LogManager::class.java.resourcePath
+ * ```
+ */
+val <T : Class<*>> T.resourcePath
+  get() = getResource("$simpleName.class")
+
+/** Run the lambda in the context of the receiver classloader. */
+fun ClassLoader.using(run: () -> Unit) {
+  val cl = Thread.currentThread().contextClassLoader
+  try {
+    Thread.currentThread().contextClassLoader = this
+    run()
+  } finally {
+    Thread.currentThread().contextClassLoader = cl
+  }
+}
+
 /** Returns the file size in a human-readable format. */
 val File.displaySize
   get() = length().byteDisplaySize()
@@ -55,6 +85,15 @@ fun Long.byteDisplaySize(si: Boolean = true): String {
   }
 }
 
+fun IntArray.codePointsToString(): String = buildString {
+  for (cp in this@codePointsToString) {
+    appendCodePoint(cp)
+  }
+}
+
+fun IntArray.codePointsToString(separator: String = "") =
+    joinToString(separator) { Character.toString(it) }
+
 /** Find the file ends with given [format] under the directory. */
 fun File.findPkg(format: String?) =
     when (format != null) {
diff --git a/gradle/build-logic/common-plugins/src/main/kotlin/common/ProjectExtns.kt b/gradle/build-logic/common-plugins/src/main/kotlin/common/ProjectExtns.kt
@@ -4,6 +4,7 @@ import java.io.ByteArrayOutputStream
 import java.io.File
 import java.nio.file.Path
 import org.gradle.accessors.dm.LibrariesForLibs
+import org.gradle.api.Action
 import org.gradle.api.JavaVersion
 import org.gradle.api.Project
 import org.gradle.api.Task
@@ -131,6 +132,7 @@ fun Project.jvmArguments(forAppRun: Boolean = false) = buildList {
             "-XX:+UseZGC",
             "-XX:+ZGenerational",
             "-XX:+UseCompressedOops",
+            "-XX:+UseStringDeduplication",
             "-XX:+UnlockExperimentalVMOptions",
             // os+thread,gc+heap=trace,
             """-Xlog:cds,safepoint,gc*:
@@ -189,6 +191,7 @@ fun Project.jvmArguments(forAppRun: Boolean = false) = buildList {
             // "-XshowSettings:system",
             // "-XshowSettings:properties",
             // "--show-module-resolution",
+            // "-XX:+UseCompactObjectHeaders",
             // "-XX:+ShowHiddenFrames",
             // "-XX:+AutoCreateSharedArchive",
             // "-XX:SharedArchiveFile=$tmp/$name.jsa"
@@ -613,10 +616,15 @@ fun Project.addFileToJavaComponent(file: File) {
 
 /** Lazy version of [TaskContainer.maybeCreate] */
 inline fun <reified T : Task> TaskContainer.maybeRegister(
-    taskName: String,
-    noinline configAction: T.() -> Unit
+    name: String,
+    action: Action<in T>? = null,
 ) =
-    when (taskName) {
-      in names -> named(taskName, T::class)
-      else -> register(taskName, T::class)
-    }.also { it.configure(configAction) }
+    when (name) {
+      // val taskCollection = withType<T>().matching { it.name == name }
+      in names -> named<T>(name = name)
+      else -> register<T>(name = name)
+    }.also {
+      if (action != null) {
+        it.configure(action)
+      }
+    }
diff --git a/gradle/build-logic/common-plugins/src/main/kotlin/plugins/common.gradle.kts b/gradle/build-logic/common-plugins/src/main/kotlin/plugins/common.gradle.kts
@@ -1,11 +1,12 @@
 package plugins
 
-import com.github.ajalt.mordant.rendering.TextColors
+import com.github.ajalt.mordant.rendering.TextColors.*
 import common.*
 import common.Platform
 import java.io.PrintWriter
 import java.io.StringWriter
 import java.util.spi.*
+import org.gradle.api.publish.plugins.PublishingPlugin.*
 import org.gradle.internal.os.OperatingSystem
 import org.gradle.kotlin.dsl.*
 import tasks.*
@@ -20,7 +21,7 @@ plugins {
 
 if (hasCleanTask) {
   logger.warn(
-      TextColors.yellow(
+      yellow(
               """
       | CLEANING ALMOST NEVER FIXES YOUR BUILD!
       | Cleaning is often a last-ditch effort to fix perceived build problems that aren't going to
@@ -32,7 +33,9 @@ if (hasCleanTask) {
   )
 }
 
-afterEvaluate { logger.lifecycle(TextColors.magenta("=== Project Configuration Completed ===")) }
+afterEvaluate {}
+
+gradle.projectsEvaluated { logger.lifecycle(magenta("=== Projects Configuration Completed ===")) }
 
 idea {
   module {
@@ -150,17 +153,36 @@ tasks {
     }
   }
 
+  // Auto format all source files
+  processResources { dependsOn(":spotlessApply") }
+
   // Set GitHub workflow action output for this build
   build { finalizedBy(githubActionOutput) }
 
   val buildAndPublish by registering {
     dependsOn(subprojects.map { it.tasks.build })
+    // Starting with column(:) means root project tasks
     dependsOn(":dokkaHtmlMultiModule", ":koverHtmlReport")
 
-    val publish = GithubAction.isTagBuild && Platform.isLinux
-    if (publish) {
-      logger.lifecycle("Publishing task is enabled for this build!")
-      subprojects.mapNotNull { it.tasks.findByName(":publish") }.forEach { dependsOn(it) }
+    when {
+      // Publishing to all repos on GitHub Action tag build
+      GithubAction.isTagBuild && Platform.isLinux -> {
+        logger.lifecycle(magenta("Publishing to all repositories is enabled!"))
+        allprojects
+            .mapNotNull { it.tasks.findByName(PUBLISH_LIFECYCLE_TASK_NAME) }
+            .forEach { dependsOn(it) }
+      }
+
+      // Publish is disabled on GitHub Action PR build
+      GithubAction.isEnabled -> logger.lifecycle(red("Publishing is disabled!"))
+
+      // Publishing to local repo on other platforms
+      else -> {
+        logger.lifecycle(yellow("Publishing to local repo is enabled!"))
+        allprojects
+            .mapNotNull { it.tasks.findByName("publishAllPublicationsToMavenLocal") }
+            .forEach { dependsOn(it) }
+      }
     }
   }
 
diff --git a/gradle/build-logic/common-plugins/src/main/kotlin/plugins/kotlin.docs.gradle.kts b/gradle/build-logic/common-plugins/src/main/kotlin/plugins/kotlin.docs.gradle.kts
@@ -1,13 +1,13 @@
 package plugins
 
-import common.githubRepo
-import common.githubUser
-import common.kotlinJvmTarget
+import common.*
 import java.net.URI
 import kotlinx.validation.ApiValidationExtension
 import org.gradle.kotlin.dsl.*
 import org.hildan.github.changelog.plugin.GitHubChangelogExtension
 import org.jetbrains.dokka.DokkaConfiguration.Visibility
+import org.jetbrains.dokka.base.DokkaBase
+import org.jetbrains.dokka.base.DokkaBaseConfiguration
 import org.jetbrains.dokka.gradle.DokkaMultiModuleTask
 import org.jetbrains.dokka.gradle.DokkaTaskPartial
 
@@ -22,8 +22,13 @@ if (project == rootProject) {
   apply(plugin = "org.hildan.github.changelog")
   apply(plugin = "org.jetbrains.kotlinx.binary-compatibility-validator")
 
-  // For combined Kotlin coverage report
-  dependencies { project.subprojects.forEach { kover(it) } }
+  // Combined test & coverage report
+  dependencies {
+    project.subprojects.forEach {
+      kover(it)
+      // testReportAggregation(it)
+    }
+  }
 
   // Dokka multi-module config.
   tasks.withType<DokkaMultiModuleTask>().configureEach {
@@ -43,47 +48,41 @@ plugins.withId("org.hildan.github.changelog") {
 
 tasks {
   withType<DokkaTaskPartial>().configureEach {
-    dokkaSourceSets.configureEach {
-      moduleName = project.name
-      jdkVersion = kotlinJvmTarget.map { it.target.toInt() }
-      noStdlibLink = false
-      noJdkLink = false
-      reportUndocumented = false
-      skipDeprecated = true
-      // includes.from("README.md")
+    dokkaSourceSets {
+      // register("customSourceSet") {}
+      configureEach {
+        moduleName = project.name
+        jdkVersion = kotlinJvmTarget.map { it.target.toInt() }
+        noStdlibLink = false
+        noJdkLink = false
+        reportUndocumented = false
+        skipDeprecated = true
+        // includes.from("README.md")
+        documentedVisibilities = setOf(Visibility.PUBLIC, Visibility.PROTECTED)
 
-      documentedVisibilities = setOf(Visibility.PUBLIC, Visibility.PROTECTED)
+        sourceLink {
+          localDirectory = rootProject.projectDir
+          remoteUrl = URI("${githubRepo}/tree/main").toURL()
+          remoteLineSuffix = "#L"
+        }
 
-      sourceLink {
-        localDirectory = rootProject.projectDir
-        remoteUrl = URI("${githubRepo}/tree/main").toURL()
-        remoteLineSuffix = "#L"
+        //  externalDocumentationLink(url = "https://kotlinlang.org/api/kotlinx.coroutines/")
+        //  externalDocumentationLink(url = "https://kotlinlang.org/api/kotlinx.serialization/")
+        //  externalDocumentationLink(url = "https://kotlinlang.org/api/kotlinx-datetime/",
+        // packageListUrl =
+        // "https://kotlinlang.org/api/kotlinx-datetime/kotlinx-datetime/package-list")
+        //  externalDocumentationLink(url = "https://api.ktor.io/")
       }
-
-      //  externalDocumentationLink(url = "https://kotlinlang.org/api/kotlinx.coroutines/")
-      //  externalDocumentationLink(url = "https://kotlinlang.org/api/kotlinx.serialization/")
-      //  externalDocumentationLink(
-      //      url = "https://kotlinlang.org/api/kotlinx-datetime/",
-      //      packageListUrl =
-      //          "https://kotlinlang.org/api/kotlinx-datetime/kotlinx-datetime/package-list",
-      //  )
-      //  externalDocumentationLink(url = "https://api.ktor.io/")
     }
 
-    pluginsMapConfiguration =
-        mapOf(
-            "org.jetbrains.dokka.base.DokkaBase" to
-                """{ "footerMessage": "Copyright &copy; 2023 Dokka"}""")
-
-    //  val rootPath = rootProject.rootDir.toPath()
-    //  val logoCss = rootPath.resolve("docs/css/logo-styles.css").toString().replace('\\', '/')
-    //  val paletteSvg = rootPath.resolve("docs/img/img.svg").toString().replace('\\', '/')
-    //  pluginsMapConfiguration = mapOf(
-    //      "org.jetbrains.dokka.base.DokkaBase" to """{
-    //          "customStyleSheets": ["$logoCss"],
-    //      "customAssets": ["$paletteSvg"],
-    //      "footerMessage": "Copyright &copy; 2021 AJ Alt"
-    //     }"""
-    //  )
+    pluginConfiguration<DokkaBase, DokkaBaseConfiguration> {
+      // Dokka's stylesheets and assets with conflicting names will be overridden.
+      // val rootPath = rootProject.rootDir.toPath()
+      // val logoCss = rootPath.resolve("docs/css/logo-styles.css").toString()
+      // val logSvg = rootPath.resolve("docs/img/app-logo.svg").toString()
+      customStyleSheets = listOf(file("logo-styles.css"))
+      customAssets = listOf(file("app-logo.svg"))
+      footerMessage = "Copyright &copy; 2023 suresh.dev"
+    }
   }
 }
diff --git a/gradle/build-logic/common-plugins/src/main/kotlin/plugins/kotlin.jvm.gradle.kts b/gradle/build-logic/common-plugins/src/main/kotlin/plugins/kotlin.jvm.gradle.kts
@@ -62,7 +62,10 @@ ksp {
   arg("autoserviceKsp.verbose", "true")
 }
 
-redacted { enabled = true }
+redacted {
+  enabled = true
+  replacementString = "█"
+}
 
 kover {
   // useJacoco()
@@ -142,9 +145,11 @@ dependencies {
   implementation(libs.kotlinx.serialization.json)
   implementation(libs.kotlinx.datetime)
   implementation(libs.kotlinx.atomicfu)
+  implementation(libs.kotlin.redacted.annotations)
   // Auto-service
   ksp(libs.ksp.auto.service)
   implementation(libs.google.auto.annotations)
+
   // Test dependencies
   testImplementation(platform(libs.junit.bom))
   testImplementation(kotlin("test-junit5"))
diff --git a/gradle/build-logic/common-plugins/src/main/kotlin/plugins/kotlin.mpp.gradle.kts b/gradle/build-logic/common-plugins/src/main/kotlin/plugins/kotlin.mpp.gradle.kts
@@ -5,6 +5,7 @@ import common.*
 import org.jetbrains.kotlin.gradle.dsl.*
 import org.jetbrains.kotlin.gradle.dsl.jvm.JvmTargetValidationMode
 import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
 import org.jetbrains.kotlin.gradle.targets.js.nodejs.*
 import org.jetbrains.kotlin.gradle.targets.js.npm.tasks.KotlinNpmInstallTask
 import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackConfig
@@ -98,7 +99,6 @@ kotlinMultiplatform.apply {
 
   // Disable wasm by default as some of the common dependencies are not compatible with wasm.
   if (project.hasProperty("experimental")) {
-
     wasm {
       binaries.executable()
       browser {
@@ -139,6 +139,7 @@ kotlinMultiplatform.apply {
         api(libs.kotlinx.atomicfu)
         api(libs.kotlinx.serialization.json)
         api(libs.kotlinx.collections.immutable)
+        api(libs.kotlin.redacted.annotations)
       }
     }
 
@@ -188,6 +189,7 @@ kotlinMultiplatform.apply {
       // kotlin.srcDir("src/main/kotlin")
       // resources.srcDir("src/main/resources")
     }
+
     val jsTest by getting
   }
 
@@ -206,7 +208,10 @@ atomicfu {
   jvmVariant = "VH"
 }
 
-redacted { enabled = true }
+redacted {
+  enabled = true
+  replacementString = "█"
+}
 
 kover {
   // useJacoco()
@@ -228,11 +233,13 @@ val commonJsResources by
     }
 
 tasks {
+  // Register buildConfig task only for common module
   if (project.name == commonProjectName) {
-    // Register buildConfig task only for common module
     val buildConfigExtn = extensions.create<BuildConfigExtension>("buildConfig")
     val buildConfig by register<BuildConfig>("buildConfig", buildConfigExtn)
-    kotlinMultiplatform.sourceSets.named("${commonProjectName}Main") { kotlin.srcDirs(buildConfig) }
+    kotlinMultiplatform.sourceSets.named(KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME) {
+      kotlin.srcDirs(buildConfig)
+    }
     // maybeRegister<Task>("prepareKotlinIdeaImport") { dependsOn(buildConfig) }
   }
 
diff --git a/gradle/build-logic/common-plugins/src/main/resources/BuildConfig.kte b/gradle/build-logic/common-plugins/src/main/resources/BuildConfig.kte
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
diff --git a/settings.gradle.kts b/settings.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`	`1`	`plugins { plugins.kotlin.benchmark }`
`2`	`2`
`3`		`-// mppTargetName = "jvm"`
`4`	`3`	`dependencies { commonMainImplementation(projects.common) }`