forked from square/dagger
-
Notifications
You must be signed in to change notification settings - Fork 2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Hilt Android Gradle plugin for KSP support.
Specifically the plugin will now find the KSP tasks (if available) and configure the annotation processor options suitable for Hilt in Gradle. Meanwhile no change was needed for classpath aggregation since AGP's JavaCompile task includes KSP outputs. RELNOTES=N/A PiperOrigin-RevId: 544169233
- Loading branch information
1 parent
c41ba9f
commit 843a6a2
Showing
12 changed files
with
233 additions
and
59 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
...plugin/main/src/main/kotlin/dagger/hilt/android/plugin/HiltCommandLineArgumentProvider.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| /* | ||
| * Copyright (C) 2023 The Dagger Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package dagger.hilt.android.plugin | ||
|
|
||
| import dagger.hilt.processor.internal.optionvalues.GradleProjectType | ||
| import org.gradle.api.tasks.Input | ||
| import org.gradle.process.CommandLineArgumentProvider | ||
|
|
||
| /** | ||
| * Plugin configured annotation processor options provider. | ||
| */ | ||
| internal class HiltCommandLineArgumentProvider( | ||
| @get:Input | ||
| val forKsp: Boolean, | ||
| @get:Input | ||
| val projectType: GradleProjectType, | ||
| @get:Input | ||
| val enableAggregatingTask: Boolean, | ||
| @get:Input | ||
| val disableCrossCompilationRootValidation: Boolean | ||
| ): CommandLineArgumentProvider { | ||
|
|
||
| private val prefix = if (forKsp) "" else "-A" | ||
|
|
||
| override fun asArguments() = mutableMapOf<String, String>().apply { | ||
| // Enable Dagger's fast-init, the best mode for Hilt. | ||
| put("dagger.fastInit", "enabled") | ||
| // Disable @AndroidEntryPoint superclass validation. | ||
| put("dagger.hilt.android.internal.disableAndroidSuperclassValidation", "true") | ||
| // Report project type for root validation. | ||
| put("dagger.hilt.android.internal.projectType", projectType.toString()) | ||
|
|
||
| // Disable the aggregating processor if aggregating task is enabled. | ||
| if (enableAggregatingTask) { | ||
| put("dagger.hilt.internal.useAggregatingRootProcessor", "false") | ||
| } | ||
| // Disable cross compilation root validation. | ||
| // The plugin option duplicates the processor flag because it is an input of the | ||
| // aggregating task. | ||
| if (disableCrossCompilationRootValidation) { | ||
| put("dagger.hilt.disableCrossCompilationRootValidation", "true") | ||
| } | ||
| }.map { (key, value) -> "$prefix$key=$value" } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
75 changes: 75 additions & 0 deletions
75
.../dagger/hilt/android/plugin/main/src/main/kotlin/dagger/hilt/android/plugin/util/Tasks.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /* | ||
| * Copyright (C) 2023 The Dagger Authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package dagger.hilt.android.plugin.util | ||
|
|
||
| import com.google.devtools.ksp.gradle.KspTaskJvm | ||
| import org.gradle.api.Project | ||
| import org.gradle.api.Task | ||
| import org.gradle.api.tasks.compile.JavaCompile | ||
| import org.gradle.process.CommandLineArgumentProvider | ||
| import org.jetbrains.kotlin.gradle.internal.KaptTask | ||
|
|
||
| internal fun addJavaTaskProcessorOptions( | ||
| project: Project, | ||
| component: ComponentCompat, | ||
| produceArgProvider: (Task) -> CommandLineArgumentProvider | ||
| ) = project.tasks.withType(JavaCompile::class.java) { task -> | ||
| if (task.name == "compile${component.name.capitalize()}JavaWithJavac") { | ||
| task.options.compilerArgumentProviders.add(produceArgProvider.invoke(task)) | ||
| } | ||
| } | ||
|
|
||
| internal fun addKaptTaskProcessorOptions( | ||
| project: Project, | ||
| component: ComponentCompat, | ||
| produceArgProvider: (Task) -> CommandLineArgumentProvider | ||
| ) = project.plugins.withId("kotlin-kapt") { | ||
| project.tasks.withType(KaptTask::class.java) { task -> | ||
| if (task.name == "kapt${component.name.capitalize()}Kotlin") { | ||
| val argProvider = produceArgProvider.invoke(task) | ||
| // TODO: Update once KT-58009 is fixed. | ||
| try { | ||
| // Because of KT-58009, we need to add a `listOf(argProvider)` instead | ||
| // of `argProvider`. | ||
| task.annotationProcessorOptionProviders.add(listOf(argProvider)) | ||
| } catch (e: Throwable) { | ||
| // Once KT-58009 is fixed, adding `listOf(argProvider)` will fail, we will | ||
| // pass `argProvider` instead, which is the correct way. | ||
| task.annotationProcessorOptionProviders.add(argProvider) | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| internal fun addKspTaskProcessorOptions( | ||
| project: Project, | ||
| component: ComponentCompat, | ||
| produceArgProvider: (Task) -> CommandLineArgumentProvider | ||
| ) = project.plugins.withId("com.google.devtools.ksp") { | ||
| project.tasks.withType(KspTaskJvm::class.java) { task -> | ||
| if (task.name == "ksp${component.name.capitalize()}Kotlin") { | ||
| task.commandLineArgumentProviders.add(produceArgProvider.invoke(task)) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| internal fun Task.isKspTask(): Boolean = try { | ||
| val kspTaskClass = Class.forName("com.google.devtools.ksp.gradle.KspTask") | ||
| kspTaskClass.isAssignableFrom(this::class.java) | ||
| } catch (ex: ClassNotFoundException) { | ||
| false | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.