Skip to content

Commit 9c56914

Browse files
committed
Improve README
1 parent 77a58de commit 9c56914

1 file changed

Lines changed: 32 additions & 1 deletion

File tree

README.md

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Compose Stability Analyzer provides real-time analysis of your Jetpack Compose c
1818

1919
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.
2020

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+
2123
## 💝 Sponsors
2224

2325
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,
113115

114116
You can change the configuration on the way below:
115117

116-
**Settings → Tools → Compose Stability Analyzer → Colors**
118+
**Settings → Tools → Compose Stability Analyzer**
117119

118120
![preview](art/preview4.png)
119121
![preview](art/preview5.png)
120122

123+
#### Stability Configuration File
124+
125+
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+
121152
## Gradle Plugin for Tracking Runtime Recomposition and Stability Validation
122153

123154
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

Comments
 (0)