Add excludedSources to the KSP extension object
#1793
Merged
Conversation
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 new property allows users to create a Gradle task that generates Kotlin code, which can
then get excluded by KSP's processing step.
This can help avoid circular Gradle dependency issues, such as in the case where KSP
generates an intermediate file (like a resource) which a Gradle plugin then consumes
and uses to generate its own Kotlin source.
Without this change, KSP would want to rerun when the new source got generated, which
upsets Gradle because it already ran.
The following is one example of using the `excludedSources` property:
```kotlin
val generateCodeTask = tasks.register("generateCodeTask") {
val outputDir = project.layout.buildDirectory.dir("generated/src")
outputs.dir(outputDir)
doLast {
/* ... generate code into outputDir ... */
}
}
ksp.excludedSources.from(generateCodeTask)
kotlin {
sourceSets.main {
kotlin.srcDir(generateCodeTask)
}
}
```
Bug google#1791
Co-authored-by: David Herman <bitspittle@gmail.com>
Co-authored-by: Dennis Tsar <45399002+DennisTsar@users.noreply.github.com>
ting-yuan
approved these changes
Mar 20, 2024
|
Thanks for the patch! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This new property allows users to create a Gradle task that generates Kotlin code, which can then get excluded by KSP's processing step.
This can help avoid circular Gradle dependency issues, such as in the case where KSP generates an intermediate file (like a resource) which a Gradle plugin then consumes and uses to generate its own Kotlin source.
Without this change, KSP would want to rerun when the new source got generated, which upsets Gradle because it already ran.
The following is one example of using the
excludedSourcesproperty:Bug #1791