Select projects to include via spotlight and/or ArtifactSwapModuleSelector (#82)

This completes the integration of the `ArtifactSwapModuleSelector` code
that lived in setupIdeModules (internal tool) previously into the
settings plugin. Users would now indicate via spotlight
(`ide-projects.txt`) what they want to work on, and the other required
projects are automatically computed at the start of each sync instead of
via some helper tool like `./setupIdeModules`.

Author: joshfriend

.github/workflows/check.yml

@@ -21,10 +21,10 @@ jobs:
 
     steps:
       - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
-      - name: Set up JDK 17
+      - name: Set up JDK 21
         uses: actions/setup-java@f2beeb24e141e01a676f977032f5a29d81c9e27e # v5
         with:
-          java-version: '17'
+          java-version: '21'
           distribution: 'temurin'
 
       # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.

.github/workflows/publish.yml

@@ -18,10 +18,10 @@ jobs:
       contents: read
     steps:
       - uses: actions/checkout@93cb6efe18208431cddfb8368fd83d5badbf9bfd # v5
-      - name: Set up JDK 17
+      - name: Set up JDK 21
         uses: actions/setup-java@f2beeb24e141e01a676f977032f5a29d81c9e27e # v5
         with:
-          java-version: '17'
+          java-version: '21'
           distribution: 'temurin'
 
       # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.

build-logic/conventions/build.gradle.kts

@@ -26,11 +26,10 @@ gradlePlugin {
 
 dependencies {
   implementation(gradleApi())
-
   implementation(libs.android.gradle)
-  implementation(libs.ktfmt.gradle)
-  implementation(libs.vanniktech.gradle)
-  implementation(libs.kotlin.gradle)
   implementation(libs.dagp.gradle)
   implementation(libs.develocity.gradle)
+  implementation(libs.kotlin.gradle)
+  implementation(libs.ktfmt.gradle)
+  implementation(libs.vanniktech.gradle)
 }

cli/build.gradle.kts

@@ -1,11 +1,11 @@
 plugins {
-    application
-    id("com.gradleup.shadow")
+  application
+  id("com.gradleup.shadow")
 }
 
 application {
-    mainClass = "xyz.block.artifactswap.cli.MainKt"
-    applicationName = "artifactswap"
+  mainClass = "xyz.block.artifactswap.cli.MainKt"
+  applicationName = "artifactswap"
 }
 
 dependencies {
@@ -22,23 +22,23 @@ dependencies {
   implementation(libs.okhttp)
   implementation(libs.okhttp.logging)
   implementation(libs.picocli.core)
-  implementation(libs.retrofit.core)
   implementation(libs.retrofit.converter.jackson)
+  implementation(libs.retrofit.core)
   implementation(libs.retrofit.wire)
   implementation(libs.slf4j.api)
 
   runtimeOnly(libs.log4j.slf4j2.impl) {
     because("JGit uses SLF4J for logging")
   }
 
-  // Test dependencies
   testImplementation(platform(libs.junit.bom))
+  testImplementation(testFixtures(project(":core")))
   testImplementation(libs.junit.jupiter.api)
   testImplementation(libs.kotlin.test)
   testImplementation(libs.kotlinx.coroutines.test)
   testImplementation(libs.mockito.core)
   testImplementation(libs.mockito.kotlin)
-  testImplementation(testFixtures(project(":core")))
+
   testRuntimeOnly(libs.junit.launcher)
 }
 

core/build.gradle.kts

@@ -4,7 +4,6 @@ plugins {
 }
 
 dependencies {
-  // API - exposed to consumers
   api(libs.jackson.databind)
   api(libs.jackson.dataformat.xml)
   api(libs.jgit.core)
@@ -15,15 +14,12 @@ dependencies {
   api(libs.slf4j.api)
   api(libs.spotlight.buildscriptUtils)
 
-  // Implementation
   implementation(libs.jackson.core)
   implementation(libs.jackson.module.kotlin)
   implementation(libs.log4j.kotlin)
-  implementation(libs.okhttp)
   implementation(libs.okio)
   implementation(libs.wire.runtime)
 
-  // Runtime only
   runtimeOnly(libs.log4j.api)
   runtimeOnly(libs.log4j.core)
 

core/src/main/kotlin/xyz/block/artifactswap/core/config/ArtifactSwapConfig.kt

@@ -1,5 +1,7 @@
 package xyz.block.artifactswap.core.config
 
+import java.io.Serializable
+
 /**
  * Central configuration for all artifact swap operations.
  *
@@ -115,6 +117,6 @@ data class ArtifactSwapConfig(
   // Artifactory
   // ============================================================================
   val artifactoryBaseUrl: String = "https://artifactory.example.com",
-) {
+) : Serializable {
   val primaryArtifactsMavenGroupArtifactoryPath = primaryArtifactsMavenGroup.replace('.', '/')
 }

core/src/main/kotlin/xyz/block/artifactswap/core/module_selector/AlwaysKeepProjectsList.kt

@@ -0,0 +1,48 @@
+package xyz.block.artifactswap.core.module_selector
+
+import com.fueledbycaffeine.spotlight.buildscript.GradlePath
+import java.nio.file.Files
+import java.nio.file.Path
+import kotlin.io.path.exists
+import kotlin.io.path.isRegularFile
+
+/**
+ * Manages the list of projects that must always be included in the build, even if they have
+ * available artifacts.
+ *
+ * This is useful for cases where:
+ * - A project is a SQLDelight schema dependency (SQLDelight cannot use binary artifacts as schema
+ *   dependencies)
+ * - A project has special build-time requirements that prevent artifact substitution
+ *
+ * The list is stored in `gradle/artifact-swap-always-keep.txt` with one project path per line. The
+ * file format is the same as Spotlight project list files:
+ * - One project path per line (e.g., `:common:schema`)
+ * - Lines starting with `#` are comments
+ * - Empty lines are ignored
+ */
+object AlwaysKeepProjectsList {
+  private const val ALWAYS_KEEP_FILE = "gradle/artifact-swap-always-keep.txt"
+
+  /**
+   * Reads the list of projects that should always be kept from the configuration file.
+   *
+   * Uses the same file format as SpotlightProjectList for consistency.
+   *
+   * @param rootDir The root directory of the Gradle project
+   * @return Set of GradlePath objects that must always be included (e.g., ":common:schema")
+   */
+  fun read(rootDir: Path): Set<GradlePath> {
+    val file = rootDir.resolve(ALWAYS_KEEP_FILE)
+    if (!file.exists() || !file.isRegularFile()) {
+      return emptySet()
+    }
+
+    return Files.readAllLines(file)
+      .asSequence()
+      .map { it.trim() }
+      .filter { it.isNotEmpty() && !it.startsWith("#") } // Support comments like Spotlight
+      .map { GradlePath(rootDir, it) } // Convert string paths to GradlePath objects
+      .toSet()
+  }
+}