Compose Report HTML

A tool to convert Compose Compiler metrics and reports into a fully formatted HTML report.

This project provides:

• Statistics overview: Find counts of composable, class types that are unstable, non-skippable, readonly, inline, or non-restartable.
• Full module details: Lists all classes, composables, and metrics in tables with their properties.
• Multi-variant support: View reports for all build variants in a single output.
• Multi-module support: No need to generate separate outputs per module.

---

Features

Feature	Description
Statistics overview	Counts unstable composables, non-skippable, readonly, inline, non-restartable items
Full module tables	Shows classes, composables, metrics with all properties
Multi-variant support	Includes all variants in one HTML report
Multi-module support	Generates one consolidated output for all modules

---

Installation

You can install the CLI globally via npm:

npm install -g compose-report-html

Or locally in a project:

npm install --save-dev compose-report-html

Make sure you have Node.js >= 18 and Java 17 installed.

---

How to Run

After installing via npm, you can use the CLI directly without manually calling java -jar:

composeHtml -p <rootPath> -r <reportsDir> -o <outputDirectory>

Arguments:

Argument	Short	Description	Required / Default
rootPath	-p	Root directory containing your Compose project	Required
reportsDir	-r	Path to Compose compiler reports directory, relative to each module's build folder	Required
outputDirectory	-o	Directory where formatted HTML report will be saved	Default: .

Note: reportsDir is relative to each module's build folder, e.g., compose-compiler/reports.

---

Example

composeHtml -p /Users/me/Projects/MyApp -r compose-compiler -o reports/html

This will generate a fully formatted HTML report in reports/html.

---

Example Screenshots

Dark Theme

Module View	Statistics View

Light Theme

Module View	Statistics View

---

License

This project is licensed under the MIT License.

---

Summary

This tool lets you quickly analyze Compose projects and produce a clean, navigable HTML report with all module information, metrics, and statistics in one place, supporting multi-variant and multi-module projects.