Merge pull request #63 from PatilShreyas/report-extend

Provide report options to limit the content of report

Author: PatilShreyas

cli/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/cli/Main.kt

@@ -28,6 +28,7 @@ import dev.shreyaspatil.composeCompilerMetricsGenerator.core.ComposeCompilerRawR
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.utils.ensureDirectory
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.utils.ensureFileExists
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.HtmlReportGenerator
+import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.ReportOptions
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.ReportSpec
 import kotlinx.cli.ArgParser
 import kotlinx.cli.ArgType
@@ -43,7 +44,14 @@ import java.nio.file.Paths
 fun main(args: Array<String>) {
     val arguments = CliArguments(args, Paths.get("").toAbsolutePath())
 
-    val reportSpec = ReportSpec(arguments.applicationName)
+    val reportSpec = ReportSpec(
+        name = arguments.applicationName,
+        options = ReportOptions(
+            includeStableComposables = arguments.includeStableComposables,
+            includeStableClasses = arguments.includeStableClasses,
+            includeClasses = arguments.includeClasses,
+        ),
+    )
     val rawReportProvider = arguments.getRawReportProvider()
 
     printHeader("Generating Composable HTML Report")
@@ -128,6 +136,21 @@ class CliArguments(args: Array<String>, private val path: Path) {
         description = "Output directory name",
     ).default(path.toAbsolutePath().toString())
 
+    val includeStableComposables by parser.option(
+        ArgType.Boolean,
+        description = "Whether to include stable Composable functions in the report",
+    ).default(true)
+
+    val includeStableClasses by parser.option(
+        ArgType.Boolean,
+        description = "Whether to include stable classes in the report",
+    ).default(true)
+
+    val includeClasses by parser.option(
+        ArgType.Boolean,
+        description = "Whether to include all the classes in the report",
+    ).default(true)
+
     init {
         parser.parse(args)
 
@@ -185,5 +208,5 @@ fun printHeader(header: String) = println(
 )
 
 object Constants {
-    const val VERSION = "v1.0.1"
+    const val VERSION = "v1.1.0"
 }

docs/use/using-cli.md

@@ -56,7 +56,7 @@ Run the command to know the usage of CLI
 !!! success "▶️Output"
 
     ```shell
-    Usage: Compose Compiler Report to HTML Generator ~ v1.0.1 options_list
+    Usage: Compose Compiler Report to HTML Generator ~ v1.1.0 options_list
     Options:
         --applicationName, -app -> Application name (To be displayed in the report) (always required) { String }
         --inputDirectory, -i -> Input directory where composable report and metrics are available { String }
@@ -65,6 +65,9 @@ Run the command to know the usage of CLI
         --composableMetricsFile, -composableMetrics -> Composable Metrics TXT files (separated by commas) { String }
         --classMetricsFile, -classMetrics -> Class Metrics TXT files (separated by commas) { String }
         --outputDirectory, -o -> Output directory name { String }
+        --includeStableComposables [true] -> Whether to include stable Composable functions in the report
+        --includeStableClasses [true] -> Whether to include stable classes in the report
+        --includeClasses [true] -> Whether to include all the classes in the report
         --help, -h -> Usage info
     ```
 

docs/use/using-gradle-plugin.md

@@ -19,15 +19,15 @@ Apply the plugin to the module in which _**compose is enabled**_.
 
     ```groovy title="build.gradle"
     plugins {
-      id "dev.shreyaspatil.compose-compiler-report-generator" version "1.0.1"
+      id "dev.shreyaspatil.compose-compiler-report-generator" version "1.1.0"
     }
     ```
 
 === "Kotlin"
 
     ```kotlin title="build.gradle.kts"
     plugins {
-      id("dev.shreyaspatil.compose-compiler-report-generator") version "1.0.1"
+      id("dev.shreyaspatil.compose-compiler-report-generator") version "1.1.0"
     }    
     ```
 
@@ -45,7 +45,7 @@ Add this to top project level `build.gradle`
         }
       }
       dependencies {
-        classpath "dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.1"
+        classpath "dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.1.0"
       }
     }
     ```
@@ -66,7 +66,7 @@ Add this to top project level `build.gradle`
         }
       }
       dependencies {
-        classpath("dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.0.1")
+        classpath("dev.shreyaspatil.compose-compiler-report-generator:gradle-plugin:1.1.0")
       }
     }
     ```
@@ -122,8 +122,17 @@ If you have to configure plugin parameters manually (which is completely optiona
         // Sets the name for a report
         name = "Report Name" // Default: Module name
 
-        // Output path where report will be generated
-        outputPath = project.buildDir.absolutePath + "/custom_path" // Default: module/buildDir/compose_report
+        // Output directory where report will be generated
+        outputDirectory = layout.buildDirectory.dir("custom_dir").get().asFile // Default: module/buildDir/compose_report
+        
+        // Whether to include stable composable functions in the final report or not.
+        includeStableComposables = true/false // Default: true
+
+        // Whether to include stable classes in the final report or not.
+        includeStableClasses = true/false // Default: true
+
+        // Whether to include the ALL classes in the final report or not.
+        includeClasses = true/false // Default: true
     }
     ```
 
@@ -140,7 +149,16 @@ If you have to configure plugin parameters manually (which is completely optiona
         // Sets the name for a report
         name.set("Report Name") // Default: Module name
 
-        // Output path where report will be generated
-        outputPath.set(project.buildDir.resolve("custom_path").absolutePath) // Default: module/buildDir/compose_report
+        // Output directory where report will be generated
+        outputDirectory.set(layout.buildDirectory.dir("custom_dir").get().asFile) // Default: module/buildDir/compose_report
+
+        // Whether to include stable composable functions in the final report or not.
+        includeStableComposables.set(true/false) // Default: true
+
+        // Whether to include stable classes in the final report or not.
+        includeStableClasses.set(true/false) // Default: true
+
+        // Whether to include the ALL classes in the final report or not.
+        includeClasses.set(true/false) // Default: true
     }
     ```

docs/use/using-utility-as-library.md

@@ -25,7 +25,10 @@ Refer to the latest release on [GitHub Releases](https://github.com/PatilShreyas
 
 ```kotlin
 // Create a report specification with application name
-val reportSpec = ReportSpec("Your Application Name")
+val reportSpec = ReportSpec(
+    name = "Your Application Name",
+    options = ReportOptions() // Customize it as per need
+)
 
 // Get provider for raw reports (generated by compose compiler)
 val rawReportProvider = ComposeCompilerRawReportProvider.FromDirectory("path/to/raw-reports")

gradle-plugin/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/plugin/ComposeCompilerReportExtension.kt

@@ -51,6 +51,21 @@ interface ComposeCompilerReportExtension {
      */
     val outputDirectory: Property<File>
 
+    /**
+     * Include the report for stable composable functions in the module which doesn't need optimizations.
+     */
+    val includeStableComposables: Property<Boolean>
+
+    /**
+     * Include the report for stable classes in the module which doesn't need optimizations.
+     */
+    val includeStableClasses: Property<Boolean>
+
+    /**
+     * Include the report for all classes in the module.
+     */
+    val includeClasses: Property<Boolean>
+
     val composeRawMetricsOutputDirectory: File
         get() = outputDirectory.get().resolve("raw")
 
@@ -63,6 +78,9 @@ interface ComposeCompilerReportExtension {
         fun create(target: Project) = target.extensions.create<ComposeCompilerReportExtension>(NAME).apply {
             enableReport.convention(true)
             enableMetrics.convention(true)
+            includeStableComposables.convention(true)
+            includeStableClasses.convention(true)
+            includeClasses.convention(true)
             name.convention("${target.rootProject.name}:${target.name}")
             outputDirectory.convention(target.buildDir.resolve("compose_report"))
         }

gradle-plugin/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/plugin/task/ComposeCompilerReportGenerateTask.kt

@@ -27,15 +27,14 @@ import com.android.build.api.variant.Variant
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.ComposeCompilerMetricsProvider
 import dev.shreyaspatil.composeCompilerMetricsGenerator.core.ComposeCompilerRawReportProvider
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.HtmlReportGenerator
+import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.ReportOptions
 import dev.shreyaspatil.composeCompilerMetricsGenerator.generator.ReportSpec
 import dev.shreyaspatil.composeCompilerMetricsGenerator.plugin.ComposeCompilerReportExtension
 import org.gradle.api.DefaultTask
 import org.gradle.api.Project
-import org.gradle.api.file.Directory
 import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Input
-import org.gradle.api.tasks.InputDirectory
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
 import org.gradle.api.tasks.TaskProvider
@@ -52,12 +51,21 @@ abstract class ComposeCompilerReportGenerateTask : DefaultTask() {
     @get:Input
     abstract val reportName: Property<String>
 
-    @get:InputDirectory
+    @get:OutputDirectory
     abstract val composeRawMetricsOutputDirectory: DirectoryProperty
 
     @get:OutputDirectory
     abstract val outputDirectory: DirectoryProperty
 
+    @get:Input
+    abstract val includeStableComposables: Property<Boolean>
+
+    @get:Input
+    abstract val includeStableClasses: Property<Boolean>
+
+    @get:Input
+    abstract val includeClasses: Property<Boolean>
+
     @TaskAction
     fun generate() {
         val outputDirectory = outputDirectory.get().asFile
@@ -91,7 +99,14 @@ abstract class ComposeCompilerReportGenerateTask : DefaultTask() {
 
     private fun generateReport(outputDirectory: File) {
         // Create a report specification with application name
-        val reportSpec = ReportSpec(reportName.get())
+        val reportSpec = ReportSpec(
+            name = reportName.get(),
+            options = ReportOptions(
+                includeStableComposables = includeStableComposables.get(),
+                includeStableClasses = includeStableClasses.get(),
+                includeClasses = includeClasses.get(),
+            ),
+        )
 
         val rawReportProvider = ComposeCompilerRawReportProvider.FromDirectory(
             directory = composeRawMetricsOutputDirectory.get().asFile,
@@ -135,6 +150,9 @@ fun Project.registerComposeCompilerReportGenTaskForVariant(variant: Variant): Ta
         reportName.set(reportExtension.name)
         composeRawMetricsOutputDirectory.set(reportExtension.composeRawMetricsOutputDirectory)
         outputDirectory.set(layout.dir(reportExtension.outputDirectory))
+        includeStableComposables.set(reportExtension.includeStableComposables)
+        includeStableClasses.set(reportExtension.includeStableClasses)
+        includeClasses.set(reportExtension.includeClasses)
 
         group = "compose compiler report"
         description = "Generate Compose Compiler Metrics and Report"

gradle.properties

@@ -1,7 +1,7 @@
 kotlin.code.style=official
 
 GROUP=dev.shreyaspatil.compose-compiler-report-generator
-VERSION_NAME=1.0.1
+VERSION_NAME=1.1.0
 
 # Library configuration
 SONATYPE_HOST=DEFAULT

package.json

@@ -7,7 +7,7 @@
   "main": "index.js",
   "preferGlobal": true,
   "repository": "https://github.com/PatilShreyas/compose-report-to-html",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "jdeploy": {
     "jdk": false,
     "javaVersion": "11",

report-generator/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/generator/ReportSpec.kt

@@ -25,9 +25,17 @@ package dev.shreyaspatil.composeCompilerMetricsGenerator.generator
 
 /**
  * Specification of a report
- *
- * TODO: See if more specifications needed in future
  */
 data class ReportSpec(
     val name: String,
+    val options: ReportOptions = ReportOptions(),
+)
+
+/**
+ * Options for a report
+ */
+data class ReportOptions(
+    val includeStableComposables: Boolean = true,
+    val includeStableClasses: Boolean = true,
+    val includeClasses: Boolean = true,
 )

report-generator/src/main/kotlin/dev/shreyaspatil/composeCompilerMetricsGenerator/generator/content/ClassReport.kt

@@ -43,7 +43,10 @@ import kotlinx.html.td
 import kotlinx.html.th
 import kotlinx.html.tr
 
-fun FlowContent.ClassesReport(report: ClassesReport) {
+fun FlowContent.ClassesReport(
+    includeStableClasses: Boolean,
+    report: ClassesReport,
+) {
     if (report.classes.isEmpty()) {
         EmptyContent("No Class Report")
         return
@@ -65,10 +68,10 @@ fun FlowContent.ClassesReport(report: ClassesReport) {
                         ClassesReport(report.unstableClasses)
                     }
                 } else {
-                    EmptyContent("No Unstable classes found")
+                    EmptyContent("No Unstable classes found 😁")
                 }
 
-                if (report.stableClasses.isNotEmpty()) {
+                if (report.stableClasses.isNotEmpty() && !includeStableClasses) {
                     CollapsibleContent(
                         summary = "Stable Classes",
                         summaryAttr = {
@@ -83,7 +86,12 @@ fun FlowContent.ClassesReport(report: ClassesReport) {
                     }
                 } else {
                     br { }
-                    EmptyContent("No Stable classes found")
+                    val message = if (!includeStableClasses) {
+                        "Report for stable classes is disabled in the options"
+                    } else {
+                        "No Stable classes found"
+                    }
+                    EmptyContent(message)
                 }
             }
         }