Last active
July 21, 2023 15:43
-
-
Save arunkumar9t2/60da93e4866b59dc440d8d291d2d5655 to your computer and use it in GitHub Desktop.
Gradle task to find reverse dependencies of a module
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
import com.google.common.graph.Graphs | |
import com.google.common.graph.MutableValueGraph | |
import com.google.common.graph.ValueGraphBuilder | |
import org.gradle.api.DefaultTask | |
import org.gradle.api.Project | |
import org.gradle.api.artifacts.Configuration | |
import org.gradle.api.artifacts.ProjectDependency | |
import org.gradle.api.tasks.Input | |
import org.gradle.api.tasks.TaskAction | |
import org.gradle.api.tasks.options.Option | |
abstract class DependantModulesTask : DefaultTask() { | |
@Option( | |
option = "project-path", | |
description = "The project path to find dependencies for" | |
) | |
@Input | |
lateinit var projectPath: String | |
@TaskAction | |
fun action() { | |
val rootProject = project.rootProject | |
val buildGraph: MutableValueGraph<Project, Configuration> = | |
ValueGraphBuilder.directed() | |
.allowsSelfLoops(false) | |
.expectedNodeCount(rootProject.subprojects.size) | |
.build() | |
rootProject.subprojects.forEach { sourceProject -> | |
buildGraph.addNode(sourceProject) | |
sourceProject | |
.configurations | |
.flatMap { configuration -> | |
configuration | |
.dependencies | |
.filterIsInstance<ProjectDependency>() | |
.map { projectDependency -> configuration to projectDependency } | |
}.forEach { (configuration, projectDependency) -> | |
if (sourceProject != projectDependency.dependencyProject) { | |
// Invert the order since we are only interested in reverse dependencies | |
buildGraph.putEdgeValue( | |
projectDependency.dependencyProject, | |
sourceProject, | |
configuration | |
) | |
} | |
} | |
} | |
val projectToFind = rootProject.project(projectPath) | |
val dependants = Graphs.reachableNodes(buildGraph.asGraph(), projectToFind) | |
logger.quiet(buildString { | |
appendLine() | |
append("${projectToFind.path}'s dependants :") | |
appendLine() | |
append( | |
dependants | |
.filter { it != projectToFind } | |
.joinToString(separator = "\n") { it.path } | |
) | |
}) | |
logger.quiet("----------\n") | |
val subgraph = Graphs.inducedSubgraph(buildGraph, dependants) | |
subgraph | |
.edges() | |
.forEach { endpointPair -> | |
val configuration = buildGraph | |
.edgeValue(endpointPair) | |
.map { it.name } | |
.orElse("") | |
val sourceProject = endpointPair.nodeV().path | |
val dependencyProject = endpointPair.nodeU().path | |
logger.quiet( | |
"""|$sourceProject | |
| $configuration(project("$dependencyProject"))""" | |
.trimMargin() | |
) | |
} | |
} | |
} |
Beautiful! Maybe the output could look like:
:sample-android-flavor
implementation(project(":sample-kotlin-lib"))
:sample-android
implementation(project(":sample-kotlin-lib"))
This is super nice, thank you!
Thanks @handstandsam updated to print like that now
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Example usage when registered as
dependantModules
task.