Add --summary-only flag (#471)

Goooler · web-flow · commit 3ed6cf0f4cce · 2026-03-07T19:29:25.000-05:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,8 @@
 
 ## [Unreleased]
 [Unreleased]: https://github.com/JakeWharton/diffuse/compare/0.3.0...HEAD
-
+**Added**
+- Add `--summary-only` flag.
 
 ## [0.3.0] - 2024-02-20
 [0.3.0]: https://github.com/JakeWharton/diffuse/releases/tag/0.3.0
diff --git a/diffuse/src/main/kotlin/com/jakewharton/diffuse/diffuse.kt b/diffuse/src/main/kotlin/com/jakewharton/diffuse/diffuse.kt
@@ -127,9 +127,16 @@ private class OutputOptions(outputFs: FileSystem, private val output: PrintStrea
         }
       }
 
+  private val summaryOnly by
+    option(
+        "--summary-only",
+        help = "Skip generating detailed reports, outputting only the summary.",
+      )
+      .flag()
+
   fun write(reportFactory: Report.Factory) {
-    val textReport by lazy(NONE) { reportFactory.toTextReport().toString() }
-    val htmlReport by lazy(NONE) { reportFactory.toHtmlReport().toString() }
+    val textReport by lazy(NONE) { reportFactory.toTextReport(summaryOnly).toString() }
+    val htmlReport by lazy(NONE) { reportFactory.toHtmlReport(summaryOnly).toString() }
 
     text?.writeText(textReport)
     html?.writeText(htmlReport)
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/diff/AabDiff.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/diff/AabDiff.kt
@@ -29,5 +29,5 @@ internal class AabDiff(val oldAab: Aab, val newAab: Aab) : BinaryDiff {
         ModuleDiff(oldModule, newAab.featureModules.getValue(name))
       }
 
-  override fun toTextReport(): Report = AabDiffTextReport(this)
+  override fun toTextReport(summaryOnly: Boolean): Report = AabDiffTextReport(this, summaryOnly)
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/diff/AarDiff.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/diff/AarDiff.kt
@@ -15,5 +15,5 @@ internal class AarDiff(
   val jars = JarsDiff(oldAar.jars, oldMapping, newAar.jars, newMapping)
   val manifest = ManifestDiff(oldAar.manifest, newAar.manifest)
 
-  override fun toTextReport(): Report = AarDiffTextReport(this)
+  override fun toTextReport(summaryOnly: Boolean): Report = AarDiffTextReport(this, summaryOnly)
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/diff/ApkDiff.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/diff/ApkDiff.kt
@@ -24,5 +24,5 @@ internal class ApkDiff(
 
   val lintMessages = listOfNotNull(archive.resourcesArscCompression())
 
-  override fun toTextReport(): Report = ApkDiffTextReport(this)
+  override fun toTextReport(summaryOnly: Boolean): Report = ApkDiffTextReport(this, summaryOnly)
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/diff/DexDiff.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/diff/DexDiff.kt
@@ -32,7 +32,7 @@ internal class DexDiff(val oldDexes: List<Dex>, val newDexes: List<Dex>) : Binar
 
   val changed = strings.changed || types.changed || methods.changed || fields.changed
 
-  override fun toTextReport(): Report = DexDiffTextReport(this)
+  override fun toTextReport(summaryOnly: Boolean): Report = DexDiffTextReport(this, summaryOnly)
 }
 
 internal fun DexDiff.toSummaryTable() =
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/diff/JarDiff.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/diff/JarDiff.kt
@@ -16,5 +16,5 @@ internal class JarDiff(
 
   val changed = jars.changed || archive.changed
 
-  override fun toTextReport(): Report = JarDiffTextReport(this)
+  override fun toTextReport(summaryOnly: Boolean): Report = JarDiffTextReport(this, summaryOnly)
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/info/AabInfo.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/info/AabInfo.kt
@@ -6,7 +6,7 @@ import com.jakewharton.diffuse.report.Report
 import com.jakewharton.diffuse.report.text.AabInfoTextReport
 
 class AabInfo(private val aab: Aab) : BinaryDiff {
-  override fun toTextReport(): Report {
+  override fun toTextReport(summaryOnly: Boolean): Report {
     return AabInfoTextReport(aab)
   }
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/info/AarInfo.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/info/AarInfo.kt
@@ -5,7 +5,7 @@ import com.jakewharton.diffuse.report.Report
 import com.jakewharton.diffuse.report.text.AarInfoTextReport
 
 class AarInfo(private val aar: Aar) : BinaryInfo {
-  override fun toTextReport(): Report {
+  override fun toTextReport(summaryOnly: Boolean): Report {
     return AarInfoTextReport(aar)
   }
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/info/ApkInfo.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/info/ApkInfo.kt
@@ -5,7 +5,7 @@ import com.jakewharton.diffuse.report.Report
 import com.jakewharton.diffuse.report.text.ApkInfoTextReport
 
 class ApkInfo(private val apk: Apk) : BinaryInfo {
-  override fun toTextReport(): Report {
+  override fun toTextReport(summaryOnly: Boolean): Report {
     return ApkInfoTextReport(apk)
   }
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/info/DexInfo.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/info/DexInfo.kt
@@ -5,7 +5,7 @@ import com.jakewharton.diffuse.report.Report
 import com.jakewharton.diffuse.report.text.DexInfoTextReport
 
 class DexInfo(private val dex: Dex) : BinaryInfo {
-  override fun toTextReport(): Report {
+  override fun toTextReport(summaryOnly: Boolean): Report {
     return DexInfoTextReport(dex)
   }
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/info/JarInfo.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/info/JarInfo.kt
@@ -5,7 +5,7 @@ import com.jakewharton.diffuse.report.Report
 import com.jakewharton.diffuse.report.text.JarInfoTextReport
 
 class JarInfo(private val jar: Jar) : BinaryInfo {
-  override fun toTextReport(): Report {
+  override fun toTextReport(summaryOnly: Boolean): Report {
     return JarInfoTextReport(jar)
   }
 }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/report/Report.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/report/Report.kt
@@ -4,9 +4,9 @@ interface Report {
   fun write(appendable: Appendable)
 
   interface Factory {
-    fun toTextReport(): Report
+    fun toTextReport(summaryOnly: Boolean): Report
 
-    fun toHtmlReport(): Report {
+    fun toHtmlReport(summaryOnly: Boolean): Report {
       TODO("Implement HTML reporting")
     }
   }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/AabDiffTextReport.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/AabDiffTextReport.kt
@@ -8,7 +8,8 @@ import com.jakewharton.picnic.TextAlignment.BottomLeft
 import com.jakewharton.picnic.TextAlignment.MiddleCenter
 import com.jakewharton.picnic.TextAlignment.MiddleRight
 
-internal class AabDiffTextReport(private val aabDiff: AabDiff) : Report {
+internal class AabDiffTextReport(private val aabDiff: AabDiff, private val summaryOnly: Boolean) :
+  Report {
   override fun write(appendable: Appendable) {
     appendable.apply {
       append("OLD: ")
@@ -48,6 +49,7 @@ internal class AabDiffTextReport(private val aabDiff: AabDiff) : Report {
           .toString()
       )
 
+      if (summaryOnly) return@apply
       appendLine("==================")
       appendLine("====   base   ====")
       appendLine("==================")
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/AarDiffTextReport.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/AarDiffTextReport.kt
@@ -6,7 +6,8 @@ import com.jakewharton.diffuse.diff.toSummaryTable
 import com.jakewharton.diffuse.format.ArchiveFile.Type
 import com.jakewharton.diffuse.report.Report
 
-internal class AarDiffTextReport(private val aarDiff: AarDiff) : Report {
+internal class AarDiffTextReport(private val aarDiff: AarDiff, private val summaryOnly: Boolean) :
+  Report {
   override fun write(appendable: Appendable) {
     appendable.apply {
       append("OLD: ")
@@ -25,6 +26,8 @@ internal class AarDiffTextReport(private val aarDiff: AarDiff) : Report {
       )
       appendLine()
       appendLine(aarDiff.jars.toSummaryTable("JAR"))
+
+      if (summaryOnly) return@apply
       if (aarDiff.archive.changed) {
         appendLine()
         appendLine("=================")
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/ApkDiffTextReport.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/ApkDiffTextReport.kt
@@ -9,7 +9,8 @@ import com.jakewharton.diffuse.format.ArchiveFile.Type
 import com.jakewharton.diffuse.report.Report
 import com.jakewharton.diffuse.report.toSummaryString
 
-internal class ApkDiffTextReport(private val apkDiff: ApkDiff) : Report {
+internal class ApkDiffTextReport(private val apkDiff: ApkDiff, private val summaryOnly: Boolean) :
+  Report {
   override fun write(appendable: Appendable) {
     appendable.apply {
       append("OLD: ")
@@ -58,6 +59,8 @@ internal class ApkDiffTextReport(private val apkDiff: ApkDiff) : Report {
       appendLine(apkDiff.dex.toSummaryTable())
       appendLine()
       appendLine(apkDiff.arsc.toSummaryTable())
+
+      if (summaryOnly) return@apply
       if (apkDiff.archive.changed || apkDiff.signatures.changed) {
         appendLine()
         appendLine("=================")
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/DexDiffTextReport.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/DexDiffTextReport.kt
@@ -4,7 +4,8 @@ import com.jakewharton.diffuse.diff.DexDiff
 import com.jakewharton.diffuse.diff.toDetailReport
 import com.jakewharton.diffuse.report.Report
 
-internal class DexDiffTextReport(private val dexDiff: DexDiff) : Report {
+internal class DexDiffTextReport(private val dexDiff: DexDiff, private val summaryOnly: Boolean) :
+  Report {
   private val oldDex =
     requireNotNull(dexDiff.oldDexes.singleOrNull()) {
       "Dex diff report only supports a single old dex. Found: ${dexDiff.oldDexes}"
@@ -21,6 +22,8 @@ internal class DexDiffTextReport(private val dexDiff: DexDiff) : Report {
       append("NEW: ")
       appendLine(newDex.filename)
       appendLine()
+
+      if (summaryOnly) return@apply
       appendLine(dexDiff.toDetailReport())
     }
   }
diff --git a/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/JarDiffTextReport.kt b/reports/src/main/kotlin/com/jakewharton/diffuse/report/text/JarDiffTextReport.kt
@@ -6,7 +6,8 @@ import com.jakewharton.diffuse.diff.toSummaryTable
 import com.jakewharton.diffuse.format.ArchiveFile.Type
 import com.jakewharton.diffuse.report.Report
 
-internal class JarDiffTextReport(private val jarDiff: JarDiff) : Report {
+internal class JarDiffTextReport(private val jarDiff: JarDiff, private val summaryOnly: Boolean) :
+  Report {
   override fun write(appendable: Appendable) {
     appendable.apply {
       append("OLD: ")
@@ -19,6 +20,8 @@ internal class JarDiffTextReport(private val jarDiff: JarDiff) : Report {
       appendLine(jarDiff.archive.toSummaryTable("JAR", Type.JAR_TYPES))
       appendLine()
       appendLine(jarDiff.jars.toSummaryTable("CLASSES"))
+
+      if (summaryOnly) return@apply
       if (jarDiff.archive.changed) {
         appendLine()
         appendLine("=================")

Original file line number	Diff line number	Diff line change
`@@ -29,5 +29,5 @@ internal class AabDiff(val oldAab: Aab, val newAab: Aab) : BinaryDiff {`
`29`	`29`	`ModuleDiff(oldModule, newAab.featureModules.getValue(name))`
`30`	`30`	`}`
`31`	`31`
`32`		`- override fun toTextReport(): Report = AabDiffTextReport(this)`
	`32`	`+ override fun toTextReport(summaryOnly: Boolean): Report = AabDiffTextReport(this, summaryOnly)`
`33`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,5 @@ internal class AarDiff(`
`15`	`15`	`val jars = JarsDiff(oldAar.jars, oldMapping, newAar.jars, newMapping)`
`16`	`16`	`val manifest = ManifestDiff(oldAar.manifest, newAar.manifest)`
`17`	`17`
`18`		`- override fun toTextReport(): Report = AarDiffTextReport(this)`
	`18`	`+ override fun toTextReport(summaryOnly: Boolean): Report = AarDiffTextReport(this, summaryOnly)`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,5 +24,5 @@ internal class ApkDiff(`
`24`	`24`
`25`	`25`	`val lintMessages = listOfNotNull(archive.resourcesArscCompression())`
`26`	`26`
`27`		`- override fun toTextReport(): Report = ApkDiffTextReport(this)`
	`27`	`+ override fun toTextReport(summaryOnly: Boolean): Report = ApkDiffTextReport(this, summaryOnly)`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ internal class DexDiff(val oldDexes: List<Dex>, val newDexes: List<Dex>) : Binar`
`32`	`32`
`33`	`33`	`val changed = strings.changed \|\| types.changed \|\| methods.changed \|\| fields.changed`
`34`	`34`
`35`		`- override fun toTextReport(): Report = DexDiffTextReport(this)`
	`35`	`+ override fun toTextReport(summaryOnly: Boolean): Report = DexDiffTextReport(this, summaryOnly)`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`internal fun DexDiff.toSummaryTable() =`
Original file line number	Diff line number	Diff line change
`@@ -16,5 +16,5 @@ internal class JarDiff(`
`16`	`16`
`17`	`17`	`val changed = jars.changed \|\| archive.changed`
`18`	`18`
`19`		`- override fun toTextReport(): Report = JarDiffTextReport(this)`
	`19`	`+ override fun toTextReport(summaryOnly: Boolean): Report = JarDiffTextReport(this, summaryOnly)`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import com.jakewharton.diffuse.report.Report`
`6`	`6`	`import com.jakewharton.diffuse.report.text.AabInfoTextReport`
`7`	`7`
`8`	`8`	`class AabInfo(private val aab: Aab) : BinaryDiff {`
`9`		`- override fun toTextReport(): Report {`
	`9`	`+ override fun toTextReport(summaryOnly: Boolean): Report {`
`10`	`10`	`return AabInfoTextReport(aab)`
`11`	`11`	`}`
`12`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import com.jakewharton.diffuse.report.Report`
`5`	`5`	`import com.jakewharton.diffuse.report.text.AarInfoTextReport`
`6`	`6`
`7`	`7`	`class AarInfo(private val aar: Aar) : BinaryInfo {`
`8`		`- override fun toTextReport(): Report {`
	`8`	`+ override fun toTextReport(summaryOnly: Boolean): Report {`
`9`	`9`	`return AarInfoTextReport(aar)`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import com.jakewharton.diffuse.report.Report`
`5`	`5`	`import com.jakewharton.diffuse.report.text.ApkInfoTextReport`
`6`	`6`
`7`	`7`	`class ApkInfo(private val apk: Apk) : BinaryInfo {`
`8`		`- override fun toTextReport(): Report {`
	`8`	`+ override fun toTextReport(summaryOnly: Boolean): Report {`
`9`	`9`	`return ApkInfoTextReport(apk)`
`10`	`10`	`}`
`11`	`11`	`}`