Most of the documentation surrounding configuration of a rule always leaves me hunting for the right...

# detekt

[Colton Idle]

Most of the documentation surrounding configuration of a rule always leaves me hunting for the right spot to put it.

For example: https://detekt.dev/docs/introduction/compose/#unusedprivatemember

Where do I actually put that config?

Maybe im missing something right in front of my face?

[kenkyee]

UnusedPrivateMember:
active: true
allowedNames: ''
ignoreAnnotated: ['Preview']

[Colton Idle]

Run failed with 1 invalid config property.

- Property 'complexity>UnusedPrivateMember' is misspelled or does not exist.

[kenkyee]

looks like you put that in the wrong place...look at the default config file:
https://github.com/detekt/detekt/blob/main/detekt-core/src/main/resources/default-detekt-config.yml

[kenkyee]

UnusedPrivateMember is under "style"

[Colton Idle]

Yeah. Thats what i was (doing a bad job at) asking. like. is there no easy way to tell what section i need to put my rule under?

[kenkyee]

scroll up...it's under style

[Colton Idle]

even reading that default yaml i gotta pull out my ruler to figure out that it goes under style

[kenkyee]

indentations are pretty obvious to me blob shrug

[Colton Idle]

okay. so that helps. but im not just somehow missing "style" on this piece of docs right? https://detekt.dev/docs/introduction/compose/#unusedprivatemember

[Colton Idle]

seems like its typically to just open up the default and track it down from there

[kenkyee]

click on https://detekt.dev/docs/rules/style#unusedprivatemember

[kenkyee]

look on left side

[kenkyee]

it says style blob shrug

[Colton Idle]

gotcha. im k with that as long as i wasn't missing an easier way. lol

[Colton Idle]

thanks!

[Brais Gabin]

My recommendation: remove your current configuration (or move it to have a back-up). execute ./gradlew detektGenerateConfig. And now edit whatever you need from that file. I use it as an index of all the rules that I have to my disposal. Downside? Update it when you update detekt. To do that I use these steps: https://github.com/detekt/detekt/discussions/3558#discussioncomment-483027

[Brais Gabin]

But we know that our configuration process is not the cleanest so any ideas to improve it are more than welcome. It is a really complex topic.