New rule: `Modifier` Should have default value about detekt-rules-compose HOT 6 CLOSED

I found a thread in compose slack in which Google's Leland Richardson said that the convention is to have the default value be simply Modifier, not Modifier.fillMaxWidth() or something else, as this could lead to unwanted problems, as that thread indicates.

This rule can check this also, and report error a) in case there's no default value b) in case default value is something more than Modifier

from detekt-rules-compose.

Hah, nice! No need then, it's on my TODO list also, will do soon.

from detekt-rules-compose.

I have actually made two new rules:

• ModifierDefaultValue checks that default value (if present) is nothing other than Modifier, having a complex expressions there can lead to issues as I described in the comment above
• MissingModifierDefaultValue which reports an error if modifier has no default value. Lint rules bundled with compose do not enforce modifier having a default value, so I thought that some folks might want to disable this rule.

from detekt-rules-compose.

I have also thought about adding a separate rule which would enforce putting optional parameters after required parameters, (+not allowing to intersperse them). Looks like this makes sense specifically for composable functions (not generally) and follows Compose internal style: so that you can write e.g. Text("Hello", TextStyle.H2). This would require named args if at least one optional parameter is present before required ones. Not yet sure how useful such rule would be, thought about trying it on our private codebases first.

from detekt-rules-compose.

😂 I had on my TODO list "Open an issue to enforce required parameters first". I just crosslined it (Unless you want the issue to track this kind of things)

from detekt-rules-compose.

Sounds good!

from detekt-rules-compose.