chore: build config task refactor

Author: sureshg

gradle/build-logic/src/main/kotlin/common/ProjectExtns.kt

@@ -32,7 +32,7 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
 // val logger = LoggerFactory.getLogger("build-logic")
 
-/** Returns version catalog of this project. */
+/** Returns the version catalog of this project. */
 internal val Project.libs
   get() = the<LibrariesForLibs>()
 

gradle/build-logic/src/main/kotlin/dev.suresh.plugin.kotlin.jvm.gradle.kts

@@ -82,6 +82,11 @@ kopy { functions = KopyFunctions.Copy }
 val javaAgent by configurations.registering { isTransitive = false }
 
 tasks {
+  val buildConfigExtn = extensions.create<BuildConfigExtension>("buildConfig")
+  val buildConfig = register<BuildConfig>("buildConfig", buildConfigExtn)
+  buildConfig.configure { enabled = buildConfigExtn.enabled.get() }
+  kotlin.sourceSets.main { kotlin.srcDirs(buildConfig) }
+
   // Configure "compileJava" and "compileTestJava" tasks.
   withType<JavaCompile>().configureEach { configureJavac(project) }
 

gradle/build-logic/src/main/kotlin/dev.suresh.plugin.kotlin.mpp.gradle.kts

@@ -95,13 +95,11 @@ redacted {
 kopy { functions = KopyFunctions.Copy }
 
 tasks {
-  if (isSharedProject) {
-    val buildConfigExtn = extensions.create<BuildConfigExtension>("buildConfig")
-    val buildConfig by register<BuildConfig>("buildConfig", buildConfigExtn)
-    kotlin.sourceSets.commonMain { kotlin.srcDirs(buildConfig) }
-    // compileKotlinMetadata { dependsOn(buildConfig) }
-    // maybeRegister<Task>("prepareKotlinIdeaImport") { dependsOn(buildConfig) }
-  }
+  val buildConfigExtn = extensions.create<BuildConfigExtension>("buildConfig")
+  val buildConfig = register<BuildConfig>("buildConfig", buildConfigExtn)
+  buildConfig.configure { enabled = buildConfigExtn.enabled.get() }
+  kotlin.sourceSets.commonMain { kotlin.srcDirs(buildConfig) }
+  // compileKotlinMetadata { dependsOn(buildConfig) }
 
   withType<KspAATask>().configureEach { configureKspConfig() }
 

gradle/build-logic/src/main/kotlin/tasks/BuildConfig.kt

@@ -1,5 +1,6 @@
 package tasks
 
+import com.github.ajalt.mordant.rendering.TextColors
 import com.javiersc.semver.project.gradle.plugin.Commit
 import gg.jte.generated.precompiled.StaticTemplates
 import javax.inject.Inject
@@ -32,7 +33,7 @@ abstract class BuildConfig @Inject constructor(@Nested val extn: BuildConfigExte
     val pkg = fqName.substringBeforeLast(".", "")
 
     val file = dir.resolve("$className.kt")
-    logger.quiet("Generated build config file: ${file.name}")
+    logger.quiet(TextColors.magenta("Generated build config file: ${file.name}"))
 
     // Get git commit info
     val gitCommit = run {
@@ -76,10 +77,11 @@ abstract class BuildConfig @Inject constructor(@Nested val extn: BuildConfigExte
 }
 
 open class BuildConfigExtension @Inject constructor(layout: ProjectLayout, objects: ObjectFactory) {
+  @get:Input val enabled = objects.property<Boolean>().convention(false)
   @get:Input val classFqName = objects.property<String>().convention("BuildConfig")
-  @get:Input val projectVersion = objects.property<String>()
-  @get:Input val projectName = objects.property<String>()
-  @get:Input val projectDesc = objects.property<String>()
+  @get:Input val projectVersion = objects.property<String>().convention("")
+  @get:Input val projectName = objects.property<String>().convention("")
+  @get:Input val projectDesc = objects.property<String>().convention("")
   @get:Input val catalogVersions = objects.mapProperty<String, String>().convention(emptyMap())
   @get:Input val dependencies = objects.listProperty<String>().convention(emptyList())
   @Internal val gitCommit = objects.property<Commit>()

shared/build.gradle.kts

@@ -13,6 +13,7 @@ plugins {
 description = "Shared common module for all projects"
 
 buildConfig {
+  enabled = true
   projectName = rootProject.name
   projectVersion = project.version.toString()
   projectDesc = rootProject.description