[gradle] Don't fail import if compose compiler plugin misconfigured.

JetBrains · Apr 24, 2024 · a99a95a · a99a95a
1 parent 3a5f52c
commit a99a95a
Show file tree

Hide file tree

Showing 7 changed files with 47 additions and 31 deletions.
diff --git a/...ugins/compose/src/main/kotlin/org/jetbrains/compose/ComposeCompilerKotlinSupportPlugin.kt b/...ugins/compose/src/main/kotlin/org/jetbrains/compose/ComposeCompilerKotlinSupportPlugin.kt
@@ -11,6 +11,7 @@ import org.jetbrains.compose.internal.ComposeCompilerArtifactProvider
 import org.jetbrains.compose.internal.KOTLIN_JVM_PLUGIN_ID
 import org.jetbrains.compose.internal.KOTLIN_MPP_PLUGIN_ID
 import org.jetbrains.compose.internal.Version
+import org.jetbrains.compose.internal.ideaIsInSyncProvider
 import org.jetbrains.compose.internal.mppExtOrNull
 import org.jetbrains.compose.internal.service.ConfigurationProblemReporterService
 import org.jetbrains.compose.internal.webExt
@@ -34,10 +35,12 @@ internal fun Project.configureComposeCompilerPlugin() {
     }
 }
 
-internal const val newCompilerIsAvailableVersion = "2.0.0-RC1"
+internal const val newCompilerIsAvailableVersion = "2.0.0-RC2"
 internal const val newComposeCompilerKotlinSupportPluginId = "org.jetbrains.kotlin.plugin.compose"
-internal const val newComposeCompilerError = "Since Kotlin $newCompilerIsAvailableVersion " +
-        "to use Compose Multiplatform you must apply \"$newComposeCompilerKotlinSupportPluginId\" plugin."
+internal const val newComposeCompilerError =
+    "Since Kotlin $newCompilerIsAvailableVersion to use Compose Multiplatform " +
+            "you must apply \"$newComposeCompilerKotlinSupportPluginId\" plugin."
+            //"More info: URL" TODO add documentation link
 
 private fun Project.configureComposeCompilerPlugin(kgp: KotlinBasePlugin) {
     val kgpVersion = kgp.pluginVersion
@@ -50,7 +53,9 @@ private fun Project.configureComposeCompilerPlugin(kgp: KotlinBasePlugin) {
         afterEvaluate {
             logger.info("Check that new '$newComposeCompilerKotlinSupportPluginId' was applied")
             if (!project.plugins.hasPlugin(newComposeCompilerKotlinSupportPluginId)) {
-                error("e: Configuration problem: $newComposeCompilerError")
+                val ideaIsInSync = project.ideaIsInSyncProvider().get()
+                if (ideaIsInSync) logger.error("e: Configuration problem: $newComposeCompilerError")
+                else error("e: Configuration problem: $newComposeCompilerError")
             }
         }
     }

diff --git a/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/internal/IdeaImportTask.kt b/gradle-plugins/compose/src/main/kotlin/org/jetbrains/compose/internal/IdeaImportTask.kt
@@ -0,0 +1,32 @@
+package org.jetbrains.compose.internal
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.Project
+import org.gradle.api.provider.Provider
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.TaskAction
+
+internal fun Project.ideaIsInSyncProvider(): Provider<Boolean> = provider {
+    System.getProperty("idea.sync.active", "false").toBoolean()
+}
+
+/**
+ * This task should be FAST and SAFE! Because it is being run during IDE import.
+ */
+internal abstract class IdeaImportTask : DefaultTask() {
+    @get:Input
+    val ideaIsInSync: Provider<Boolean> = project.ideaIsInSyncProvider()
+
+    @TaskAction
+    fun run() {
+        try {
+            safeAction()
+        } catch (e: Exception) {
+            //message must contain two ':' symbols to be parsed by IDE UI!
+            logger.error("e: $name task was failed:", e)
+            if (!ideaIsInSync.get()) throw e
+        }
+    }
+
+    abstract fun safeAction()
+}
diff --git a/...ins/compose/src/main/kotlin/org/jetbrains/compose/resources/ComposeResourcesGeneration.kt b/...ins/compose/src/main/kotlin/org/jetbrains/compose/resources/ComposeResourcesGeneration.kt
@@ -4,6 +4,7 @@ import org.gradle.api.Project
 import org.gradle.api.provider.Provider
 import org.jetbrains.compose.ComposePlugin
 import org.jetbrains.compose.internal.IDEA_IMPORT_TASK_NAME
+import org.jetbrains.compose.internal.IdeaImportTask
 import org.jetbrains.compose.internal.utils.uppercaseFirstChar
 import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension
 import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet

diff --git a/...e-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/GenerateResClassTask.kt b/...e-plugins/compose/src/main/kotlin/org/jetbrains/compose/resources/GenerateResClassTask.kt
@@ -1,38 +1,13 @@
 package org.jetbrains.compose.resources
 
-import org.gradle.api.DefaultTask
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.provider.Property
-import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.OutputDirectory
-import org.gradle.api.tasks.TaskAction
+import org.jetbrains.compose.internal.IdeaImportTask
 import java.io.File
 
-/**
- * This task should be FAST and SAFE! Because it is being run during IDE import.
- */
-internal abstract class IdeaImportTask : DefaultTask() {
-    @get:Input
-    val ideaIsInSync: Provider<Boolean> = project.provider {
-        System.getProperty("idea.sync.active", "false").toBoolean()
-    }
-
-    @TaskAction
-    fun run() {
-        try {
-            safeAction()
-        } catch (e: Exception) {
-            //message must contain two ':' symbols to be parsed by IDE UI!
-            logger.error("e: $name task was failed:", e)
-            if (!ideaIsInSync.get()) throw e
-        }
-    }
-
-    abstract fun safeAction()
-}
-
 internal abstract class GenerateResClassTask : IdeaImportTask() {
     companion object {
         private const val RES_FILE_NAME = "Res"

diff --git a/.../compose/src/main/kotlin/org/jetbrains/compose/resources/GenerateResourceAccessorsTask.kt b/.../compose/src/main/kotlin/org/jetbrains/compose/resources/GenerateResourceAccessorsTask.kt
@@ -10,6 +10,7 @@ import org.gradle.api.tasks.PathSensitive
 import org.gradle.api.tasks.PathSensitivity
 import org.gradle.api.tasks.SkipWhenEmpty
 import org.gradle.api.tasks.TaskAction
+import org.jetbrains.compose.internal.IdeaImportTask
 import java.io.File
 import java.nio.file.Path
 import kotlin.io.path.relativeTo

diff --git a/...lugins/compose/src/main/kotlin/org/jetbrains/compose/resources/PrepareComposeResources.kt b/...lugins/compose/src/main/kotlin/org/jetbrains/compose/resources/PrepareComposeResources.kt
@@ -14,6 +14,7 @@ import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.OutputFiles
 import org.gradle.api.tasks.SkipWhenEmpty
 import org.gradle.api.tasks.TaskProvider
+import org.jetbrains.compose.internal.IdeaImportTask
 import org.jetbrains.compose.internal.utils.uppercaseFirstChar
 import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
 import org.w3c.dom.Node

diff --git a/...e/src/test/kotlin/org/jetbrains/compose/test/tests/integration/KotlinCompatibilityTest.kt b/...e/src/test/kotlin/org/jetbrains/compose/test/tests/integration/KotlinCompatibilityTest.kt
@@ -5,6 +5,7 @@
 
 package org.jetbrains.compose.test.tests.integration
 
+import org.jetbrains.compose.newCompilerIsAvailableVersion
 import org.jetbrains.compose.newComposeCompilerError
 import org.jetbrains.compose.test.utils.GradlePluginTestBase
 import org.jetbrains.compose.test.utils.TestProjects
@@ -52,7 +53,7 @@ class KotlinCompatibilityTest : GradlePluginTestBase() {
     fun testNewCompilerPluginError() {
         val testProject = testProject(
             TestProjects.mpp,
-            testEnvironment = defaultTestEnvironment.copy(kotlinVersion = "2.0.0-RC1")
+            testEnvironment = defaultTestEnvironment.copy(kotlinVersion = newCompilerIsAvailableVersion)
         )
         testProject.gradleFailure("tasks").checks {
             check.logContains(newComposeCompilerError)