You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Compose Compiler plugin can generate reports / metrics around certain compose-specific concepts that can be useful to understand what is happening with some of your compose code at a fine-grained level.
This generates reports in `json`, `csv` and `txt` files which are not easily trace-able for developers.
28
28
Also, Composable function and class reports becomes large and tedious to check.
29
-
This tool parses the reports and metrics generated by Compose compiler and beautifies into a HTML page and intelligently distinguishes problematic and non-problematic composable functions and classes.
29
+
This tool parses the reports and metrics generated by Compose compiler and beautifies into a HTML page and intelligently
30
+
distinguishes problematic and non-problematic composable functions and classes.
30
31
31
-
_This utility doesn't generate Compose Metrics and Reports. First, raw Compose report should be generated from the Compiler and those generated files should be feed to this utility. By parsing that data, this utility generates the beautified report._
32
+
_This utility doesn't generate Compose Metrics and Reports. First, raw Compose report should be generated from the
33
+
Compiler and those generated files should be feed to this utility. By parsing that data, this utility generates the
34
+
beautified report._
32
35
33
36
## 🧑💻 Usage
34
37
@@ -40,7 +43,8 @@ To install the CLI utility, there are two ways
40
43
41
44
#### 1.1 Directly use `.jar` distribution
42
45
43
-
Navigate to the [releases](https://github.com/PatilShreyas/compose-report-to-html/releases) and download the latest JAR artifact.
46
+
Navigate to the [releases](https://github.com/PatilShreyas/compose-report-to-html/releases) and download the latest JAR
47
+
artifact.
44
48
45
49
#### 1.2 Install from NPM
46
50
@@ -84,7 +88,10 @@ Options:
84
88
85
89
### 3. Generate report
86
90
87
-
Make sure to generate Compose compiler metrics and reports as mentioned [here](https://github.com/androidx/androidx/blob/androidx-main/compose/compiler/design/compiler-metrics.md) or [this good read article by Chris Banes](https://chris.banes.dev/composable-metrics/). These files are then needed to this CLI utility to feed the data.
91
+
Make sure to generate Compose compiler metrics and reports as
In the above example, it will create report with name **"NotyKT"** with specified metric and report files and finally report will be generated in the specified path i.e. `notyReport/index.html`.
122
+
In the above example, it will create report with name **"NotyKT"** with specified metric and report files and finally
123
+
report will be generated in the specified path i.e. `notyReport/index.html`.
124
+
125
+
## Utility as a library
126
+
127
+
This utility is also published as a maven artifact on Maven Central so that you can make use of it as you want to use it
128
+
(_For example: automation in CI_).
129
+
130
+
Refer to the Wiki for more information: [**Using this utility as a library**](https://github.com/PatilShreyas/compose-report-to-html/wiki/Using-utility-as-a-library)
116
131
117
-
## 📈 Report Overview
132
+
## 📈 Report Overview
118
133
119
134
Once report is generated, it looks like this.
120
135
@@ -126,7 +141,7 @@ Once report is generated, it looks like this.
126
141
|**Class Report**| Parses `-classes.txt` file and separates out stable and unstable classes out of it and properly highlights issues associated with them. <br><br> |
127
142
128
143
Right now, work is in progress and more improvements related to the report
129
-
will happen in some time. If you have any feedback / suggestions related to
144
+
will happen in some time. If you have any feedback / suggestions related to
130
145
the report, feel free to discuss it (_find discussion link in the below section_).
131
146
132
147
## 🙋♂️ Contribute
@@ -135,7 +150,8 @@ Read [contribution guidelines](CONTRIBUTING.md) for more information regarding c
135
150
136
151
## 💬 Discuss?
137
152
138
-
Have any questions, doubts or want to present your opinions, views? You're always welcome. You can [start discussions](https://github.com/PatilShreyas/compose-report-to-html/discussions).
153
+
Have any questions, doubts or want to present your opinions, views? You're always welcome. You
154
+
can [start discussions](https://github.com/PatilShreyas/compose-report-to-html/discussions).
0 commit comments