Merge pull request #412 from square/ralf/sync-sources

Add an option in the Anvil DSL to sync generated sources in the IDE.

Author: vRallev

gradle-plugin/src/main/java/com/squareup/anvil/plugin/AnvilExtension.kt

@@ -44,6 +44,13 @@ public abstract class AnvilExtension @Inject constructor(objects: ObjectFactory)
   public val disableComponentMerging: Property<Boolean> = objects.property(Boolean::class.java)
     .convention(false)
 
+  /**
+   * Add Anvil generated source directories to sourceSets in Gradle for indexing visibility in the
+   * IDE. This can be useful in debugging and is disabled by default.
+   */
+  public val syncGeneratedSources: Property<Boolean> = objects.property(Boolean::class.java)
+    .convention(false)
+
   @Suppress("PropertyName")
   internal var _variantFilter: Action<VariantFilter>? = null
 

gradle-plugin/src/main/java/com/squareup/anvil/plugin/AnvilPlugin.kt

@@ -130,6 +130,22 @@ internal open class AnvilPlugin : KotlinCompilerPluginSupportPlugin {
       "anvil${File.separator}src-gen-${variant.name}"
     )
 
+    if (variant.variantFilter.syncGeneratedSources) {
+      val isIdeSyncProvider = project.providers
+        .systemProperty("idea.sync.active")
+        .forUseAtConfigurationTime()
+
+      if (isIdeSyncProvider.getOrElse("false").toBoolean()) {
+        // Only add source sets during the IDE sync. Don't add them for compilation, otherwise
+        // we'll see weird compile errors especially with incremental compilation. For a longer
+        // explanation why this is a bad idea, see here:
+        // https://github.com/square/anvil/pull/207#issuecomment-850768750
+        kotlinCompilation.defaultSourceSet {
+          kotlin.srcDir(srcGenDir)
+        }
+      }
+    }
+
     return project.provider {
       listOf(
         FilesSubpluginOption(

gradle-plugin/src/main/java/com/squareup/anvil/plugin/VariantFilter.kt

@@ -30,6 +30,12 @@ public interface VariantFilter : Named {
    * details.
    */
   public var disableComponentMerging: Boolean
+
+  /**
+   * Add Anvil generated source directories to sourceSets in Gradle for indexing visibility in the
+   * IDE. This can be useful in debugging and is disabled by default.
+   */
+  public var syncGeneratedSources: Boolean
 }
 
 internal class CommonFilter(
@@ -59,6 +65,13 @@ internal class CommonFilter(
     set(value) {
       disableComponentMergingOverride = value
     }
+
+  private var syncGeneratedSourcesOverride: Boolean? = null
+  override var syncGeneratedSources: Boolean
+    get() = syncGeneratedSourcesOverride ?: extension.syncGeneratedSources.get()
+    set(value) {
+      syncGeneratedSourcesOverride = value
+    }
 }
 
 public class JvmVariantFilter internal constructor(