chore: refactor build config plugin

sureshg · Jan 26, 2025 · f5fbc83 · f5fbc83
1 parent 4ea2a0f
commit f5fbc83
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 15 deletions.
diff --git a/plugins/project/src/main/kotlin/dev.suresh.plugin.kotlin.jvm.gradle.kts b/plugins/project/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) }
 

diff --git a/plugins/project/src/main/kotlin/dev.suresh.plugin.kotlin.mpp.gradle.kts b/plugins/project/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() }
 

diff --git a/plugins/project/src/main/kotlin/tasks/BuildConfig.kt b/plugins/project/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>()

diff --git a/sandbox/build.gradle.kts b/sandbox/build.gradle.kts
@@ -8,8 +8,17 @@ plugins {
   alias(libs.plugins.shadow)
 }
 
-kotlin { jvmTarget(project) }
-
 description = "Sandbox App"
 
+buildConfig {
+  enabled = true
+  projectName = rootProject.name
+  projectVersion = project.version.toString()
+  projectDesc = rootProject.description
+  gitCommit = semver.commits.get().first()
+  catalogVersions = project.versionCatalogMapOf()
+}
+
+kotlin { jvmTarget(project) }
+
 application { mainClass = "MainKt" }
diff --git a/sandbox/settings.gradle.kts b/sandbox/settings.gradle.kts
@@ -1,5 +1,7 @@
 @file:Suppress("UnstableApiUsage")
 
+import com.javiersc.semver.settings.gradle.plugin.SemverSettingsExtension
+
 pluginManagement {
   repositories {
     gradlePluginPortal()
@@ -46,6 +48,8 @@ dependencyResolutionManagement {
   }
 }
 
+configure<SemverSettingsExtension> { gitDir = file("$rootDir/../.git") }
+
 plugins { id("dev.suresh.plugin.repos") version "+" }
 
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")

diff --git a/sandbox/src/jvmMain/kotlin/Main.kt b/sandbox/src/jvmMain/kotlin/Main.kt
@@ -1,4 +1,4 @@
 fun main() {
-  println("Hello, sandbox project! 🏖")
-  println("Java: ${System.getProperty("java.runtime.version")},  Kotlin: ${KotlinVersion.CURRENT}")
+  println("Hello, ${BuildConfig.name}! 🏖")
+  println("Java: ${BuildConfig.java}, Kotlin: ${BuildConfig.kotlin}")
 }