Add projectSpecificSources back to the DackkaPlugin #4110
Merged
Conversation
This file contains hidden or 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
Size Report 1Affected ProductsNo changes between base commit (607dafc) and merge commit (8354df8).Test Logs |
Coverage Report 1Affected Products
Test Logs |
vkryachko
reviewed
Sep 16, 2022
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/DackkaPlugin.kt
Show resolved
Hide resolved
buildSrc/src/main/java/com/google/firebase/gradle/plugins/ProjectUtils.kt
Show resolved
Hide resolved
vkryachko
reviewed
Sep 16, 2022
| clientName.set(project.firebaseConfigValue { artifactId }) | ||
| // this will become useful with the agp upgrade, as they're separate in 7.x+ | ||
| val sourcesForKotlin = emptyList<File>() | ||
| if (!isKotlin) dependsOnAndMustRunAfter(docStubs) |
There was a problem hiding this comment.
isn't it cleaner to wire this dependency up via javaSources.set(docStubs.flatMap { it.output })?
There was a problem hiding this comment.
Yeah, but you'd be invoking docStubs for kotlin modules as well.
There was a problem hiding this comment.
sure, but it can be conditional right?
javaSources.set(if(isKotlin) sourcesForJava else docStubs.flatMap { it.output })There was a problem hiding this comment.
Sure, but I would argue that's less readable. Especially when all the other inputs are being defined in their own variables for readability. Because under that practice, we could restructure this section to this:
docsTask.configure {
if (!isKotlin) dependsOnAndMustRunAfter(docStubs)
javaSources.set(if (!isKotlin) listOf(project.docStubs) else sourcesForJava)
suppressedFiles.set(projectSpecificSuppressedFiles(project))
packageListFiles.set(fetchPackageLists(project))
kotlinSources.set(projectSpecificSources(project))
dependencies.set(classpath)
applyCommonConfigurations()
}which I would argue is less readable than this:
docsTask.configure {
if (!isKotlin) dependsOnAndMustRunAfter(docStubs)
val sourcesForKotlin = emptyList<File>() + projectSpecificSources(project)
val packageLists = fetchPackageLists(project)
val excludedFiles = projectSpecificSuppressedFiles(project)
val fixedJavaSources = if (!isKotlin) listOf(project.docStubs) else sourcesForJava
javaSources.set(fixedJavaSources)
suppressedFiles.set(excludedFiles)
packageListFiles.set(packageLists)
kotlinSources.set(sourcesForKotlin)
dependencies.set(classpath)
applyCommonConfigurations()
}But if you feel strongly about inlining it, I'm comfortable with it.
vkryachko
approved these changes
Sep 19, 2022
qdpham13
pushed a commit
that referenced
this pull request
Sep 20, 2022
* Added extra method for TaskProviders * Added specificSources method back * Revert to dependsOn for docstubs dep
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 fixes: b/246972998
Removing
projectSpecificSourceswas an over-sight, and led tocom.google.firebase.Timestampnot being generated during doc generation. Adding the method back fixes this.Additionally, I removed the
isKotlincheck forexcludedFilesas it was redundant (since the method checks for a specific project, it would be ignored when needed as a by-product).I also added an additional util method for
dependsOnAndMustRunAfterand changed ourdependsOn(docStubs)as such. We needdocStubsto run beforegenerateDackkaDocumentation, and not havingmustRunAfterwas leading to not-so-fun gradle "optimizations".And some restructuring for readability and consistency :')