Unify multiplatform targets into named groups (#2070)

This gives us more control over what targets are built for which parts of the codebase based on their type.

The big change is the drop of MacOS targets which were wholly unused. They will likely return at some point, along with new targets for common modules as well as for Compose UI, and this new grouping will make that easy to do.

Before:

    $ gw build --dry-run | grep -c SKIPPED
    7469

After:

    $ gw build --dry-run | grep -c SKIPPED
    6405

Author: JakeWharton

CHANGELOG.md

@@ -24,6 +24,8 @@ Breaking:
  non-null if it's detached due to exception.
 -`Content.awaitContent()` now accepts an optional `Int` parameter for the number of updates to
  observe before the function returns.
+- MacOS targets have been (temporarily) removed from all modules.
+
 
 ## [0.11.0] - 2024-05-15
 [0.11.0]: https://github.com/cashapp/redwood/releases/tag/0.11.0

build-support/src/main/kotlin/app/cash/redwood/buildsupport/KmpTargets.kt

@@ -16,6 +16,8 @@
 package app.cash.redwood.buildsupport
 
 interface RedwoodBuildExtension {
+  fun targets(group: TargetGroup)
+
   /** Add the Compose compiler plugin. */
   fun composeCompiler()
 
@@ -39,3 +41,27 @@ interface RedwoodBuildExtension {
   /** Consume a Zipline application in an Android application and embed it within assets. */
   fun embedZiplineApplication(dependencyNotation: Any)
 }
+
+enum class TargetGroup {
+  /** Common targets supported by core modules which are not specific to any platform. */
+  Common,
+
+  /** Same as [Common], but with an additional Android target rather than relying on JVM. */
+  CommonWithAndroid,
+
+  /** Tooling only runs on the JVM. */
+  Tooling,
+
+  /** All toolkit targets for common modules. Includes JVM but not Android. */
+  ToolkitAllWithoutAndroid,
+  ToolkitAndroid,
+  ToolkitIos,
+  ToolkitHtml,
+  ToolkitComposeUi,
+
+  /** Guest code which runs inside Treehouse. This also includes the JVM for easier testing. */
+  TreehouseGuest,
+
+  /** Host code which supports loading Treehouse guest code. */
+  TreehouseHost,
+}

build-support/src/main/kotlin/app/cash/redwood/buildsupport/RedwoodBuildExtension.kt

@@ -15,6 +15,16 @@
  */
 package app.cash.redwood.buildsupport
 
+import app.cash.redwood.buildsupport.TargetGroup.Common
+import app.cash.redwood.buildsupport.TargetGroup.CommonWithAndroid
+import app.cash.redwood.buildsupport.TargetGroup.Tooling
+import app.cash.redwood.buildsupport.TargetGroup.ToolkitAllWithoutAndroid
+import app.cash.redwood.buildsupport.TargetGroup.ToolkitAndroid
+import app.cash.redwood.buildsupport.TargetGroup.ToolkitComposeUi
+import app.cash.redwood.buildsupport.TargetGroup.ToolkitHtml
+import app.cash.redwood.buildsupport.TargetGroup.ToolkitIos
+import app.cash.redwood.buildsupport.TargetGroup.TreehouseGuest
+import app.cash.redwood.buildsupport.TargetGroup.TreehouseHost
 import com.android.build.api.variant.AndroidComponentsExtension
 import com.android.build.gradle.BaseExtension
 import com.diffplug.gradle.spotless.SpotlessExtension
@@ -276,6 +286,73 @@ class RedwoodBuildPlugin : Plugin<Project> {
 }
 
 private class RedwoodBuildExtensionImpl(private val project: Project) : RedwoodBuildExtension {
+  override fun targets(group: TargetGroup) {
+    when (group) {
+      Common -> {
+        project.applyKotlinMultiplatform {
+          iosTargets()
+          js().browser()
+          jvm()
+        }
+      }
+      CommonWithAndroid -> {
+        project.plugins.apply("com.android.library")
+        project.applyKotlinMultiplatform {
+          androidTarget().publishLibraryVariants("release")
+          iosTargets()
+          js().browser()
+          jvm()
+        }
+      }
+      Tooling -> {
+        project.plugins.apply("org.jetbrains.kotlin.jvm")
+      }
+      ToolkitAllWithoutAndroid -> {
+        project.applyKotlinMultiplatform {
+          iosTargets()
+          js().browser()
+          jvm()
+        }
+      }
+      ToolkitAndroid -> {
+        project.plugins.apply("com.android.library")
+        project.plugins.apply("org.jetbrains.kotlin.android")
+      }
+      ToolkitIos -> {
+        project.applyKotlinMultiplatform {
+          iosTargets()
+        }
+      }
+      ToolkitHtml -> {
+        project.applyKotlinMultiplatform {
+          js().browser()
+        }
+      }
+      ToolkitComposeUi -> {
+        project.plugins.apply("com.android.library")
+        project.applyKotlinMultiplatform {
+          androidTarget().publishLibraryVariants("release")
+          iosTargets()
+          jvm()
+        }
+      }
+      TreehouseGuest -> {
+        project.applyKotlinMultiplatform {
+          js().nodejs()
+          jvm() // For easier testing.
+        }
+      }
+      TreehouseHost -> {
+        project.plugins.apply("com.android.library")
+        project.applyKotlinMultiplatform {
+          androidTarget().publishLibraryVariants("release")
+          iosTargets()
+          jvm()
+        }
+      }
+    }
+  }
+
   override fun composeCompiler() {
     project.plugins.apply(ComposePlugin::class.java)
   }
@@ -506,3 +583,16 @@ private fun Project.withKotlinPlugins(block: KotlinProjectExtension.() -> Unit)
   pluginManager.withPlugin("org.jetbrains.kotlin.jvm", handler)
   pluginManager.withPlugin("org.jetbrains.kotlin.multiplatform", handler)
 }
+
+private fun Project.applyKotlinMultiplatform(block: KotlinMultiplatformExtension.() -> Unit) {
+  pluginManager.apply("org.jetbrains.kotlin.multiplatform")
+  val kotlin = extensions.getByType(KotlinMultiplatformExtension::class.java)
+  kotlin.block()
+  kotlin.applyDefaultHierarchyTemplate()
+}
+
+private fun KotlinMultiplatformExtension.iosTargets() {
+  iosArm64()
+  iosSimulatorArm64()
+  iosX64()
+}

build-support/src/main/kotlin/app/cash/redwood/buildsupport/RedwoodBuildPlugin.kt

@@ -2300,7 +2300,7 @@ source-map-loader@4.0.1:
     iconv-lite "^0.6.3"
     source-map-js "^1.0.2"
 
-source-map-support@~0.5.20:
+source-map-support@0.5.21, source-map-support@~0.5.20:
   version "0.5.21"
   resolved "https://registry.yarnpkg.com/source-map-support/-/source-map-support-0.5.21.tgz#04fe7c7f9e1ed2d662233c28cb2b35b9f63f6e4f"
   integrity sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==

kotlin-js-store/yarn.lock

@@ -1,17 +1,14 @@
 import app.cash.redwood.buildsupport.ComposeHelpers
-import app.cash.redwood.buildsupport.KmpTargets
 
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
-apply plugin: 'com.android.library'
+import static app.cash.redwood.buildsupport.TargetGroup.CommonWithAndroid
 
 redwoodBuild {
+  targets(CommonWithAndroid)
   composeCompiler()
   publishing()
 }
 
 kotlin {
-  KmpTargets.addAllTargets(project)
-
   sourceSets {
     commonMain {
       kotlin.srcDir(ComposeHelpers.get(tasks, 'app.cash.redwood.compose'))

redwood-compose/build.gradle

@@ -1,16 +1,12 @@
-import app.cash.redwood.buildsupport.KmpTargets
-
-apply plugin: 'com.android.library'
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
+import static app.cash.redwood.buildsupport.TargetGroup.ToolkitComposeUi
 
 redwoodBuild {
+  targets(ToolkitComposeUi)
   composeCompiler()
   publishing()
 }
 
 kotlin {
-  KmpTargets.addAllTargets(project, true /* skipJs */)
-
   sourceSets {
     commonMain {
       dependencies {

redwood-composeui/build.gradle

@@ -1,16 +1,14 @@
-import app.cash.redwood.buildsupport.KmpTargets
-
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
-apply plugin: 'org.jetbrains.kotlin.plugin.serialization'
+import static app.cash.redwood.buildsupport.TargetGroup.Common
 
 redwoodBuild {
+  targets(Common)
   composeCompiler()
   publishing()
 }
 
-kotlin {
-  KmpTargets.addAllTargets(project)
+apply plugin: 'org.jetbrains.kotlin.plugin.serialization'
 
+kotlin {
   sourceSets {
     commonMain {
       dependencies {

redwood-layout-api/build.gradle

@@ -1,15 +1,13 @@
-import app.cash.redwood.buildsupport.KmpTargets
-
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
-apply plugin: 'app.cash.redwood.generator.compose'
+import static app.cash.redwood.buildsupport.TargetGroup.Common
 
 redwoodBuild {
+  targets(Common)
   publishing()
 }
 
-kotlin {
-  KmpTargets.addAllTargets(project)
+apply plugin: 'app.cash.redwood.generator.compose'
 
+kotlin {
   sourceSets {
     commonMain {
       dependencies {

redwood-layout-compose/build.gradle

@@ -1,19 +1,17 @@
 import app.cash.redwood.buildsupport.FlexboxHelpers
-import app.cash.redwood.buildsupport.KmpTargets
 
-apply plugin: 'com.android.library'
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
-apply plugin: 'org.jetbrains.kotlin.plugin.serialization'
-apply plugin: 'app.cash.paparazzi'
+import static app.cash.redwood.buildsupport.TargetGroup.ToolkitComposeUi
 
 redwoodBuild {
+  targets(ToolkitComposeUi)
   composeCompiler()
   publishing()
 }
 
-kotlin {
-  KmpTargets.addAllTargets(project, true /* skipJs */)
+apply plugin: 'org.jetbrains.kotlin.plugin.serialization'
+apply plugin: 'app.cash.paparazzi'
 
+kotlin {
   sourceSets {
     commonMain {
       kotlin.srcDir(FlexboxHelpers.get(tasks, 'app.cash.redwood.layout.composeui').get())

redwood-layout-composeui/build.gradle

@@ -1,14 +1,11 @@
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
+import static app.cash.redwood.buildsupport.TargetGroup.ToolkitHtml
 
 redwoodBuild {
+  targets(ToolkitHtml)
   publishing()
 }
 
 kotlin {
-  js {
-    browser()
-  }
-
   sourceSets {
     commonMain {
       dependencies {

redwood-layout-dom/build.gradle

@@ -1,15 +1,13 @@
-import app.cash.redwood.buildsupport.KmpTargets
-
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
-apply plugin: 'app.cash.redwood.generator.modifiers'
+import static app.cash.redwood.buildsupport.TargetGroup.Common
 
 redwoodBuild {
+  targets(Common)
   publishing()
 }
 
-kotlin {
-  KmpTargets.addAllTargets(project)
+apply plugin: 'app.cash.redwood.generator.modifiers'
 
+kotlin {
   sourceSets {
     commonMain {
       dependencies {

redwood-layout-modifiers/build.gradle

@@ -1,10 +1,12 @@
-apply plugin: 'org.jetbrains.kotlin.jvm'
-apply plugin: 'app.cash.redwood.schema'
+import static app.cash.redwood.buildsupport.TargetGroup.Tooling
 
 redwoodBuild {
+  targets(Tooling)
   publishing()
 }
 
+apply plugin: 'app.cash.redwood.schema'
+
 dependencies {
   api projects.redwoodLayoutApi
 }

redwood-layout-schema/build.gradle

@@ -1,10 +1,10 @@
-import app.cash.redwood.buildsupport.KmpTargets
+import static app.cash.redwood.buildsupport.TargetGroup.ToolkitAllWithoutAndroid
 
-apply plugin: 'org.jetbrains.kotlin.multiplatform'
+redwoodBuild {
+  targets(ToolkitAllWithoutAndroid)
+}
 
 kotlin {
-  KmpTargets.addAllTargets(project, true /* skipJs */)
-
   sourceSets {
     commonMain {
       dependencies {