Skip to content

Commit 3a7f3cd

Browse files
authored
Remove ModifierComposable rule (#395)
1 parent ffe7032 commit 3a7f3cd

File tree

10 files changed

+2
-168
lines changed

10 files changed

+2
-168
lines changed

docs/detekt.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,10 +86,6 @@ Compose:
8686
active: true
8787
# -- You can optionally add your own Modifier types
8888
# customModifiers: BananaModifier,PotatoModifier
89-
ModifierComposable:
90-
active: true
91-
# -- You can optionally add your own Modifier types
92-
# customModifiers: BananaModifier,PotatoModifier
9389
ModifierComposed:
9490
active: true
9591
# -- You can optionally add your own Modifier types

docs/rules.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -621,15 +621,13 @@ More info: [Modifier documentation](https://developer.android.com/reference/kotl
621621

622622
### Avoid Modifier extension factory functions
623623

624-
Using `@Composable` builder functions for modifiers is not recommended, as they cause unnecessary recompositions. To avoid this, you should use [Modifier.Node](https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.Node) instead. It will allow you to accomplish the same things while being very performant.
625-
626-
There is another API for creating custom modifiers, `composed {}`. This API is no longer recommended due to the performance issues it created, and like with the extension factory functions case, Modifier.Node is recommended instead.
624+
For `@Composable` extension factory functions, there is an API for creating custom modifiers, `composed {}`. This API is no longer recommended due to the performance issues it created, and like with the extension factory functions case, Modifier.Node is recommended instead.
627625

628626
More info: [Modifier.Node](https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.Node), [Compose Modifier.Node and where to find it, by Merab Tato Kutalia](https://proandroiddev.com/compose-modifier-node-and-where-to-find-it-merab-tato-kutalia-66f891c0e8), [Compose modifiers deep dive, with Leland Richardson](https://www.youtube.com/watch?v=BjGX2RftXsU) and [Composed modifier docs](https://developer.android.com/reference/kotlin/androidx/compose/ui/package-summary#(androidx.compose.ui.Modifier).composed(kotlin.Function1,kotlin.Function1)).
629627

630628
!!! info ""
631629

632-
:material-chevron-right-box: [compose:modifier-composable-check](https://github.com/mrmans0n/compose-rules/blob/main/rules/common/src/main/kotlin/io/nlopez/compose/rules/ModifierComposable.kt) and [compose:modifier-composed-check](https://github.com/mrmans0n/compose-rules/blob/main/rules/common/src/main/kotlin/io/nlopez/compose/rules/ModifierComposed.kt) ktlint :material-chevron-right-box: [ModifierComposable](https://github.com/mrmans0n/compose-rules/blob/main/rules/common/src/main/kotlin/io/nlopez/compose/rules/ModifierComposable.kt) and [ModifierComposed](https://github.com/mrmans0n/compose-rules/blob/main/rules/common/src/main/kotlin/io/nlopez/compose/rules/ModifierComposed.kt) detekt
630+
:material-chevron-right-box: [compose:modifier-composed-check](https://github.com/mrmans0n/compose-rules/blob/main/rules/common/src/main/kotlin/io/nlopez/compose/rules/ModifierComposed.kt) ktlint :material-chevron-right-box: [ModifierComposed](https://github.com/mrmans0n/compose-rules/blob/main/rules/common/src/main/kotlin/io/nlopez/compose/rules/ModifierComposed.kt) detekt
633631

634632
## ComponentDefaults
635633

rules/common/src/main/kotlin/io/nlopez/compose/rules/ModifierComposable.kt

Lines changed: 0 additions & 27 deletions
This file was deleted.

rules/detekt/src/main/kotlin/io/nlopez/compose/rules/detekt/ComposeRuleSetProvider.kt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ class ComposeRuleSetProvider : RuleSetProvider {
2323
LambdaParameterInRestartableEffectCheck(config),
2424
Material2Check(config),
2525
ModifierClickableOrderCheck(config),
26-
ModifierComposableCheck(config),
2726
ModifierComposedCheck(config),
2827
ModifierMissingCheck(config),
2928
ModifierNamingCheck(config),

rules/detekt/src/main/kotlin/io/nlopez/compose/rules/detekt/ModifierComposableCheck.kt

Lines changed: 0 additions & 22 deletions
This file was deleted.

rules/detekt/src/main/resources/config/config.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ Compose:
2525
active: false
2626
ModifierClickableOrder:
2727
active: true
28-
ModifierComposable:
29-
active: true
3028
ModifierComposed:
3129
active: true
3230
ModifierMissing:

rules/detekt/src/test/kotlin/io/nlopez/compose/rules/detekt/ModifierComposableCheckTest.kt

Lines changed: 0 additions & 43 deletions
This file was deleted.

rules/ktlint/src/main/kotlin/io/nlopez/compose/rules/ktlint/ComposeRuleSetProvider.kt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ class ComposeRuleSetProvider :
2323
RuleProvider { LambdaParameterInRestartableEffectCheck() },
2424
RuleProvider { Material2Check() },
2525
RuleProvider { ModifierClickableOrderCheck() },
26-
RuleProvider { ModifierComposableCheck() },
2726
RuleProvider { ModifierComposedCheck() },
2827
RuleProvider { ModifierMissingCheck() },
2928
RuleProvider { ModifierNamingCheck() },

rules/ktlint/src/main/kotlin/io/nlopez/compose/rules/ktlint/ModifierComposableCheck.kt

Lines changed: 0 additions & 14 deletions
This file was deleted.

rules/ktlint/src/test/kotlin/io/nlopez/compose/rules/ktlint/ModifierComposableCheckTest.kt

Lines changed: 0 additions & 50 deletions
This file was deleted.

0 commit comments

Comments
 (0)