Update Compose Configuration docs for UseDataClass

[drinkthestars]

Issue

UseDataClass currently triggers for a common Compose class pattern that uses mutableStateOf vars and @Stable annotation:

@Stable
class FooState(
    val fooA: String,
    val fooB: Int
) {
    var fooC by mutableStateOf(false)
    var fooD by mutableStateOf<Float>(0f)
}

(see this common pattern also showcased in android/compose-samples.)

Suggestion

Update Configuration for Compose doc with a section for how to customize UseDataClass, maybe by suggesting Set ignoreAnnotated to ['Stable'], to ensure UseDataClass doesn't trigger for that pattern.

Let me know if this suggestion makes sense, happy to open a PR with suggested change!

[tinder-cesardiez]

That's what we did at Tinder. I wonder if the the main maintainers have an opinion about it.

[schalkms]

Maintainer here:
I’d say go for it. We always appreciate PRs from the community helping to form some best practices. This way, the detekt documentation improves incrementally.

[drinkthestars]

Great, thanks! Will have one up

[chao2zhang]

I would personally suggest that @Immutable might also be considered as ignoreAnnotated as it is a stricter form of @Stable.