Enhances Gradle projects with dynamic web reports for static analysis, revealing module dependencies and dependents. Supports custom analysis plugins and continuous updates via GitHub Actions.
Invert is a tool that collects and analyzes project statistics at scale, providing actionable insights through a dynamic web-based report. It helps developers and organizations track dependencies, migration progress, and code usage, making large-scale source management more efficient.
The name Invert originates from its initial purpose: a dynamic web report to explore the inverted dependency graph of a large multi-module project. While it has since evolved into a broader tool, this core capability remains. Invert continues to provide a unique perspective on a codebase by leveraging Collectors to extract insights, enabling developers and teams to see their project structure in a new light.
This tool is currently used on Android and iOS repositories at Square, and we are working to make it more generally useful. There is quick plug-and-play capabilities with Gradle projects, but it can be used with any project that can be configured to use the Invert API. It is especially useful for large projects with many modules, where it can be difficult to understand the full scope of the project.
At this point in time we have a plug-n-play method to use Invert from a Gradle project. We have other mechanisms for integrating with other build systems, and will open source any if they end up being generally applicable.
APIs and internals may change as it's used by Square's 6,600+ module Gradle project internally and requirements are heavily driven by Square's needs.
Invert excels in large, source-based monorepo projects, enabling:
By leveraging code references, Invert transforms raw data into meaningful insights, making it easier for developers and leadership to drive informed decisions.
Invert consists of two primary components:
Invert operates on the following core concepts:
Each module is defined by its name and filesystem path. Additionally, a module may include:
Modules and code references can have an assigned owner, which enhances the Invert Report by attributing insights to teams or individuals. If a code reference does not specify ownership, it inherits ownership from the module it is in. While optional, ownership is recommended when available.
Invert collects various types of statistics:
Code references provide precise data points:
graph LR;
A[Collectors]
A --> B[Shared Models]
B --> C[Invert Web Report]
Invert is a Gradle Plugin with a dynamic web report that lets you gain insights into your Gradle project via static analysis. Instead of seeing what a module depends on, you can see the inverted view of who depends on it. This is done by fully configuring your project and using transitive dependencies by configuration to calculate it. Additionally it is a great tool for collecting static analysis data about your project, by module. Custom static analysis plugins can be added, based on your project’s needs. The report can be computed on every merge to your main branch (via GitHub actions + GitHub pages), to have an always up-to-date view of your project without waiting for your project to configure.
// Root build.gradle
plugins {
id("com.squareup.invert") version "0.0.15"
}
repositories {
mavenCentral() // Released Versions
maven { url "https://central.sonatype.com/repository/maven-snapshots/" } // SNAPSHOT Versions
}
./gradlew :invert
invert {
addStatCollector(<<stat collector instance>>)
includeSubproject {suproject: Project ->
// By default this returns true, but you can use this filter to limit the projects that the root `:invert` task targets.
true
}
includeConfigurations { project: Project, configurationNames ->
// You can filter out the configurations you want to analyze. By default all ending in `RuntimeClasspath` will be used.
configurationNames
}
ownershipCollector(<<ownership collector instance>>)
// Optional: disable only the aggregate `sarif/stats.sarif` artifact for very large repos.
// Per-stat `sarif/code_references_*.sarif` artifacts are still generated.
aggregateStatsSarifReport(false)
}
The report will be generated at build/reports/invert.
Copyright (c) 2024 Block, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
Surfaced from shared tags and platforms — no rankings paid for.