Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
0xera committed Jan 27, 2024
1 parent b10d4ad commit 04adeec
Show file tree
Hide file tree
Showing 34 changed files with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Currently, the following compiler plugins are available:
- Functions skippability checker: Determines [function skippability](https://github.com/androidx/androidx/blob/androidx-main/compose/compiler/design/compiler-metrics.md#functions-that-are-restartable-but-not-skippable) based on checking function parameters stability.
- Recomposed function highlighter: Highlights recomposed functions with a colored border which increases the width when the recompositions count becomes larger. See [here](https://android-developers.googleblog.com/2022/03/play-time-with-jetpack-compose.html)
- Recomposed function reasons logger: Logs reasons for recomposed functions when arguments of that function has been changed. It's like a [Rebugger](https://github.com/theapache64/rebugger), but automated. You don’t need to register the logger/rebugger in suspected problem areas every time
- Test tag generator for Composable functions: Adds generated test tag for composable function if there is a default Modifier that does not have a applied testTag.
- Test tag generator for Composable functions: Adds generated test tag for composable function if there is a default Modifier that does not have an applied testTag.
- Test tag remover: Removes all test tags by replacing them with an empty string.
- Test tag drawer: Draws test tags in a dialog for long tap. (It`s very experimental. I am looking for a better solution)
- SourceInformation function calls remover: Yes, you can use sourceInformation option for Compose Compiler "-Pplugin:androidx.compose.compiler.plugins.kotlin:sourceInformation=false", but AGP enables that by default for debug builds.
Expand All @@ -21,11 +21,11 @@ How to use?
1. Apply Gradle plugin
```kotlin
plugins {
id("com.vk.vkompose") version "0.3.2"
id("com.vk.vkompose") version "0.4"
}
```

2. Enable and configure your desired features. For example:
2. Enable and configure your desired features. For example:r
```kotlin
vkompose {
skippabilityCheck = true
Expand Down Expand Up @@ -65,13 +65,13 @@ TestTagDrawConfig.isEnabled = true
Besides these plugins are published separately. So if you want to use only one, you can do.
```kotlin
plugins {
id("com.vk.recompose-highlighter") version "0.3.2"
id("com.vk.recompose-logger") version "0.3.2"
id("com.vk.compose-test-tag-applier") version "0.3.2"
id("com.vk.compose-test-tag-cleaner") version "0.3.2"
id("com.vk.compose-test-tag-drawer") version "0.3.2"
id("com.vk.compose-source-information-cleaner") version "0.3.2"
id("com.vk.composable-skippability-checker") version "0.3.2"
id("com.vk.recompose-highlighter") version "0.4"
id("com.vk.recompose-logger") version "0.4"
id("com.vk.compose-test-tag-applier") version "0.4"
id("com.vk.compose-test-tag-cleaner") version "0.4"
id("com.vk.compose-test-tag-drawer") version "0.4"
id("com.vk.compose-source-information-cleaner") version "0.4"
id("com.vk.composable-skippability-checker") version "0.4"
}

recomposeHighlighter {
Expand Down Expand Up @@ -125,13 +125,13 @@ The IDEA plugin currently offers two features:

Both features can be disabled in preferences:
![vkompose-idea-plugin-preferences.png](art/vkompose-idea-plugin-preferences.png)
You can download and install it from the jar file for [Hedgehog](idea-plugin/vkompose-idea-plugin/vkompose-idea-plugin-0.1.1-Hedgehog.jar), [Iguana](idea-plugin/vkompose-idea-plugin/vkompose-idea-plugin-0.1.1-Iguana.jar) or [Jellyfish](idea-plugin/vkompose-idea-plugin/vkompose-idea-plugin-0.1.1-Jellyfish.jar) versions of AS.
You can download and install it from the jar file for [Hedgehog](idea-plugin/vkompose/vkompose-idea-plugin-0.2-Hedgehog.jar), [Iguana](idea-plugin/vkompose/vkompose-idea-plugin-0.2-Iguana.jar) or [Jellyfish](idea-plugin/vkompose/vkompose-idea-plugin-0.2-Jellyfish.jar) versions of AS.

### [Detekt](https://github.com/detekt/detekt) Rule
There is one rule available that checks the skippability of functions. To use it, apply the dependency via the detektPlugin configuration in the dependencies block.
```kotlin
dependencies {
detektPlugins("com.vk.vkompose:detekt:0.3.2")
detektPlugins("com.vk.vkompose:detekt:0.4")
}
```

Expand Down
Binary file modified art/vkompose-idea-plugin-preferences.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 04adeec

Please sign in to comment.