@Suppress("Detekt.ruleset") feature

[vanniktech]

I have this function that I use for testing quite often:

inline fun <reified T> assertThrows(block: () -> Unit): AbstractThrowableAssert<*, out Throwable> {
  try {
    block()
  } catch (e: Throwable) {
    if (e is T) {
      return assertThat(e)
    } else {
      throw e
    }
  }

  throw AssertionError("Expected ${T::class.simpleName}")
}

Detekt is going wild on it and flagging all of these: TooGenericExceptionCaught, InstanceOfCheckForException, RethrowCaughtException.

Instead of @Suppress("Detekt.TooGenericExceptionCaught", "Detekt.InstanceOfCheckForException", "Detekt.RethrowCaughtException") - I know Detekt is optional but I like to see where things are coming from - it would be cool if I could just do @Suppress("Detekt.exceptions").

[schalkms]

Looks good to me

[arturbosch]

Makes sense to suppress whole rulesets. Unfortunately detekt needs heavy chances to support this (suppression is checked for Finding.id, we do not have information about the rule set id anymore).
How about you just add them to your baseline xml file?

[vanniktech]

I don't have a baseline file since I'm trying to stay at 0 warnings / errors. Can't we rework that part in detekt?

[Mauin]

Something that should be easier to start with is excluding the entire function for all detekt rules. Just something like Suppress("Detekt"). Adding support for entire rulesets in the future might make sense as well.

[vanniktech]

I'd still like to get other things flagged, just not the exception part.

[arturbosch]

Thats a good feature after 1.0. That won't change the user interfaces but is a good candidate for a major version :D

[arturbosch]

Ok, new idea for this.

currently the suppression logic is within detekt-api which already feels kinda wrong.
Also we are checking for suppression inside the report function:

	override fun report(finding: Finding) {
		val ktElement = finding.entity.ktElement
		if (ktElement == null || !ktElement.isSuppressedBy(finding.id, finding.issue.aliases)) {
			_findings.add(finding)
		}
	}

If we move the logic inside detekt-core, more specific to DetektFacade we can make use of the
ruleSetId to findings sorting for this:

val findings = HashMap<String, List<Finding>>()

[vanniktech]

If we move the logic inside detekt-core, more specific to DetektFacade we can make use of the
ruleSetId to findings sorting for this:

Sounds breaking to me. And if so we should do it before 1.0.0. I've looked at it quickly but could not quite figure the bits out so if anyone else wants to take a stab at it - please do!