A new task to build type usage report (ComputeTypeUsageTask). by Laimiux · Pull Request #1639 · autonomousapps/dependency-analysis-gradle-plugin

Laimiux · 2026-02-10T18:53:38Z

Summary

A new task to build type usage report (#1637).

Introducing a new ComputeTypeUsageTask task. It generates type-usage.json reporting which types (classes) your code uses from each dependency. Designed for analyzing module dependency usage and complexity.

{
  "projectPath": ":app",
  "summary": {
    "totalTypes": 245,
    "totalFiles": 67,
    "internalTypes": 12,
    "projectDependencies": 3,
    "libraryDependencies": 18
  },
  "internal": {
    "com.example.MyClass": 5
  },
  "projectDependencies": {
    ":core": {
      "com.example.core.Utils": 2
    }
  },
  "libraryDependencies": {
    "org.apache.commons:commons-collections4": {
      "org.apache.commons.collections4.bag.HashBag": 3
    }
  }
}

Usage:

./gradlew computeTypeUsageMain

Output location:

build/reports/dependency-analysis/main/intermediates/type-usage.json

Configuration:

dependencyAnalysis {
  typeUsage {
    excludePackages("kotlin.jvm.internal")
    excludeTypes("kotlin.Unit")
    excludeRegex(".*_Factory$", ".*Companion$")
  }
}

Key design decisions:

Task runs on-demand only (not part of buildHealth or other critical paths)
Uses existing intermediate files (synthetic-project.json, exploded-jars.json.gz)
Tracks both annotation and non-annotation class usage
Sensible defaults exclude common generated/internal types

Laimiux · 2026-02-10T18:54:20Z

api/api.txt

  public abstract class AbstractExtension {
    ctor @javax.inject.Inject public AbstractExtension(org.gradle.api.model.ObjectFactory objects, org.gradle.api.invocation.Gradle gradle);
    method public final org.gradle.api.file.RegularFileProperty adviceOutput();
+    method public final org.gradle.api.file.RegularFileProperty typeUsageOutput();


Please provide guidance here - I've added this, but I'm not sure what should actually be included here.

Whatever the abi generation task requires!

Is there a Gradle task to generate this?

./gradlew :updateApi

Laimiux · 2026-02-10T18:54:50Z

src/functionalTest/groovy/com/autonomousapps/jvm/projects/TypeUsageProject.groovy

+
+import static com.autonomousapps.kit.gradle.dependencies.Dependencies.*
+
+final class TypeUsageProject extends AbstractProject {


Added a functional test for this task (tried to follow project conventions)

Laimiux · 2026-02-10T18:55:17Z

src/functionalTest/groovy/com/autonomousapps/jvm/projects/TypeUsageWithFiltersProject.groovy

+
+import static com.autonomousapps.kit.gradle.dependencies.Dependencies.*
+
+final class TypeUsageWithFiltersProject extends AbstractProject {


Another functional test for the new task (tried to follow project conventions)

Laimiux · 2026-02-10T18:56:36Z

src/functionalTest/groovy/com/autonomousapps/jvm/TypeUsageSpec.groovy

+import static com.autonomousapps.utils.Runner.build
+import static com.google.common.truth.Truth.assertThat
+
+final class TypeUsageSpec extends AbstractJvmSpec {


Following project convention to test computeTypeUsageMain task

Laimiux · 2026-02-10T18:57:18Z

src/main/kotlin/com/autonomousapps/extension/TypeUsageHandler.kt

+  // Excluded specific types
+  internal val excludedTypes: SetProperty<String> = objects.setProperty(String::class.java)
+    .convention(setOf(
+      "kotlin.Unit",


Curious if we should provide certain defaults here for exclusion out of the report

src/main/kotlin/com/autonomousapps/internal/OutputPaths.kt

Laimiux · 2026-02-10T18:58:19Z

src/main/kotlin/com/autonomousapps/model/ProjectTypeUsage.kt

+ * enabling coupling analysis and complexity metrics.
+ */
+@JsonClass(generateAdapter = false)
+public data class ProjectTypeUsage(


Json serialized models for type usage task.

Laimiux · 2026-02-10T18:58:38Z

src/main/kotlin/com/autonomousapps/subplugin/ProjectPlugin.kt

    }

+    // Computes type-level usage statistics for complexity analysis.
+    val computeTypeUsageTask = tasks.register("computeTypeUsage$taskNameSuffix", ComputeTypeUsageTask::class.java) { t ->


New task registration

src/main/kotlin/com/autonomousapps/extension/TypeUsageHandler.kt

src/main/kotlin/com/autonomousapps/tasks/ComputeTypeUsageTask.kt

autonomousapps

Thanks for this! Left some comments.

src/functionalTest/groovy/com/autonomousapps/jvm/projects/TypeUsageMultiModuleProject.groovy

src/functionalTest/groovy/com/autonomousapps/jvm/projects/TypeUsageProject.groovy

src/functionalTest/groovy/com/autonomousapps/jvm/projects/TypeUsageWithFiltersProject.groovy

autonomousapps · 2026-02-19T04:43:48Z

src/functionalTest/groovy/com/autonomousapps/jvm/TypeUsageSpec.groovy

+    then: 'has correct summary'
+    def usage = project.actualTypeUsage()
+    assertThat(usage.projectPath).isEqualTo(':proj')
+    assertThat(usage.summary.totalTypes).isGreaterThan(0)


why a fuzzy match here?

Also in general, I think it might be better to just create an instance of a type usage and check equality directly?

autonomousapps · 2026-02-19T04:47:09Z

src/functionalTest/groovy/com/autonomousapps/jvm/TypeUsageSpec.groovy

Solid specs! I'm curious why we can't make more straightforward equality checks.

autonomousapps · 2026-02-19T05:09:45Z

src/main/kotlin/com/autonomousapps/tasks/ComputeTypeUsageTask.kt

+
+  fun shouldExclude(className: String): Boolean {
+    if (excludedTypes.contains(className)) return true
+    if (excludedPackages.any { className.startsWith("$it.") }) return true


Here we answer one of my questions from earlier about how the packages are treated. I wonder if it might be cleaner if, when accepting the user input, map it and affix a . to what they pass in. Also, we need to handle the case where a user might think they have to pass in a . themselves. I have some functions that do similar stuff:

internal fun String.ensurePrefix(prefix: String = ":"): String { return if (startsWith(prefix)) this else "$prefix$this" }

That function is in another context. For your use-case, please add a similar function named ensureSuffix that ensures all packages end with exactly one ..

Good call, added ensureSuffix

src/main/kotlin/com/autonomousapps/tasks/ComputeTypeUsageTask.kt

autonomousapps · 2026-02-19T05:11:41Z

src/main/kotlin/com/autonomousapps/tasks/ComputeTypeUsageTask.kt

+      val allUsedClasses = source.usedNonAnnotationClasses + source.usedAnnotationClasses
+
+      allUsedClasses.forEach { className ->
+        if (filter.shouldExclude(className)) return@forEach


I generally prefer using filter() to this pattern.

autonomousapps · 2026-02-19T05:12:21Z

src/main/kotlin/com/autonomousapps/tasks/ComputeTypeUsageTask.kt

+        // Determine coordinates: check project classes first, then external
+        val coords = when {
+          projectClasses.contains(className) -> project.coordinates.identifier
+          else -> classToCoords[className] ?: "UNKNOWN"


When would UNKNOWN happen? Would !! or error("shouldn't happen") be more appropriate?

I've seen cases with R classes. Instead of failure, I suggest exposing this via separate unknownDependencies property.

autonomousapps · 2026-02-19T05:14:31Z

src/main/kotlin/com/autonomousapps/tasks/ComputeTypeUsageTask.kt

+  private val filter: TypeFilter
+) {
+  fun analyze(): ProjectTypeUsage {
+    val usageMap = mutableMapOf<String, MutableMap<String, Int>>()


You might be better off using Coordinates instead of String here for the key.

Laimiux · 2026-03-06T22:25:30Z

api/api.txt

    field public static final com.autonomousapps.Flags INSTANCE;
  }

+  @org.gradle.work.DisableCachingByDefault(because="Writes to console") public abstract class ListSourceFilesTask extends org.gradle.api.DefaultTask {


This is not related to this PR

Laimiux commented Feb 10, 2026

View reviewed changes

src/main/kotlin/com/autonomousapps/internal/OutputPaths.kt Outdated Show resolved Hide resolved

Laimiux commented Feb 10, 2026

View reviewed changes

Laimiux commented Feb 11, 2026

View reviewed changes

src/main/kotlin/com/autonomousapps/extension/TypeUsageHandler.kt Show resolved Hide resolved

Laimiux commented Feb 11, 2026

View reviewed changes

src/main/kotlin/com/autonomousapps/tasks/ComputeTypeUsageTask.kt Show resolved Hide resolved

autonomousapps requested changes Feb 19, 2026

View reviewed changes

Laimiux added 2 commits March 6, 2026 12:08

Add new ComputeTypeUsageTest.

e3c73ec

PR feedback.

b3c127e

Laimiux force-pushed the laimonas/compute-type-usage-task branch from 840d8ec to b3c127e Compare March 6, 2026 22:24

Laimiux commented Mar 6, 2026

View reviewed changes


		import static com.autonomousapps.kit.gradle.dependencies.Dependencies.*

		final class TypeUsageProject extends AbstractProject {


		import static com.autonomousapps.kit.gradle.dependencies.Dependencies.*

		final class TypeUsageWithFiltersProject extends AbstractProject {

Uh oh!

Conversation

Laimiux commented Feb 10, 2026

Summary

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

autonomousapps left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants