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
Copy file name to clipboardExpand all lines: README.md
+32-1Lines changed: 32 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,8 @@ Compose Stability Analyzer provides real-time analysis of your Jetpack Compose c
18
18
19
19
Additionally, you can trace the reason of your composable function is triggered recomposition with a `TraceRecomposition` annotation, and export stability compatibility reports using Gradle tasks for reviewing the new stability changes.
20
20
21
+
You can change the colors used for stability indicators to match your IDE theme, enabling Strong Skipping mode for analyzing, visual indicators (showing gutter icons, warnings, inline hints), change parameter hint colors, enabling analysis in test source sets, set a stability configuration file, add ignored type patterns to exclude from the stability analysis.
22
+
21
23
## 💝 Sponsors
22
24
23
25
The sponsors listed below made it possible for this project to be released as open source. Many thanks to all of them for their support!
@@ -113,11 +115,40 @@ You can change the colors used for stability indicators to match your IDE theme,
113
115
114
116
You can change the configuration on the way below:
The Compose Stability Analyzer allows you to mark your own custom types as stable, even if they don't have `@Stable` or `@Immutable` annotations. This is useful when:
126
+
127
+
- You have immutable data classes from third-party libraries that aren't annotated
128
+
- You're using code generation tools that produce stable types
129
+
- You want to treat certain types as stable without modifying their source code
130
+
- You have legacy code that you know is stable but can't easily refactor
131
+
132
+
**Setting up the configuration file:**
133
+
134
+
**Global settings (applies to all projects):**
135
+
136
+
1. Create your configuration file anywhere on your system
137
+
2. Go to **Settings → Tools → Compose Stability Analyzer**
138
+
3. Scroll to "Ignored Type Patterns" and add your patterns directly
139
+
4. Or reference a file path in the "Stability configuration file" field (global)
140
+
141
+
**Per-project settings (recommended for teams):**
142
+
143
+
1. Create a configuration file in your project (e.g., `config/stability-config.txt`)
144
+
2. Go to **Settings → Tools → Compose Stability Analyzer → Project Configuration**
145
+
3. Set the path to your configuration file
146
+
4. Commit the file to version control so your team shares the same configuration
147
+
148
+
**Per-project settings take precedence** over global settings. This means you can have:
149
+
- Global settings for your personal preferences
150
+
- Project-specific settings that your entire team uses
151
+
121
152
## Gradle Plugin for Tracking Runtime Recomposition and Stability Validation
122
153
123
154
You can track the recomposition for specific composable functions with the `@TraceRecomposition` annotation at runtime (KMP supports). You don't need to write any logging code yourself, just add the annotation, run your app, and watch detailed recomposition logs appear in Logcat. This compiler plugin supports Kotlin Multiplatform.
0 commit comments