Is there a reasonable way to emit a warning from a custom detekt rule?

# detekt

[Will Hawkins]

Is there a reasonable way to emit a warning from a custom detekt rule?

[gammax]

short answer: no

[Will Hawkins]

okay! No problem

[Will Hawkins]

I just added a superclass to my custom rules that has such a checkConfig method that I call

[Will Hawkins]

it would be neat to add such a function to the Rule class. Would you accept such a PR?

[gammax]

long answer: So you can technically report an issue, and specify Severity.Warning in the severity.

[gammax]

Like how it's done here: https://github.com/arturbosch/detekt/blob/379461fd1a297f6e3e3f31c5c2e4a4c45ee18ee5/detekt-rules/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/bugs/UnreachableCode.kt#L41-L42

[Will Hawkins]

That seems like a good way to implement a log message in the config, thanks!

[gammax]

Just to clarify my initial no : This Severity.Warning that you can specify in the custom rule, is not playing any role in the detekt inspection result other than any other rule.

[Will Hawkins]

right

[Will Hawkins]

completely understood

[gammax]

In other words: a Severity.Warning will let your build fail as much as any other rule will do. Is more like a "label" that you can have to inform the user.

[Will Hawkins]

yeah, I don't want to fail the build. I just want to alert the user that their configuration might not be exactly what they wanted

[gammax]

👆 that's exactly the opposite of what I said 😅

[Will Hawkins]

okay, then perhaps I am misunderstanding

[Will Hawkins]

would you be open to a PR for somethign like a checkConfig method?

[gammax]

I'm not sure I follow you, but there is already configuration validation implemented in Detekt

[Will Hawkins]

sorry, I have to go afk for a minute, but I will explain when I return, if that's okay?