Make ktlint follow @Suppress/@SuppressWarning annotations

[sjcqs]

I just read #263 thinking it would also provide a way to use @Suppress/@SuppressWarning for the other rules but it's only for RemoveCurlyBracesFromTemplate.

I was going to make a PR to fix the issue but I'd like to discuss possible implementations.

Currently

Annotations are read and the rule name inside is then mapped to the ktlint rule-name.
(RemoveCurlyBracesFromTemplate is the rule name from Jetbrains Kotlin code inspections for Intellij)

ktlint/ktlint-core/src/main/kotlin/com/pinterest/ktlint/core/KtLint.kt

Lines 482 to 518 in 3a87624

	private val suppressAnnotationRuleMap = mapOf(
	"RemoveCurlyBracesFromTemplate" to "string-template"
	)
	private val suppressAnnotations = setOf("Suppress", "SuppressWarnings")
	/**
	* Creates [SuppressionHint] from annotations of given [psi]
	* Returns null if no [targetAnnotations] present or no mapping exists
	* between annotations' values and ktlint rules
	*/
	private fun createSuppressionHintFromAnnotations(
	psi: KtAnnotated,
	targetAnnotations: Collection<String>,
	annotationValueToRuleMapping: Map<String, String>
	): SuppressionHint? {
	return psi.annotationEntries
	.filter {
	it.calleeExpression?.constructorReferenceExpression
	?.getReferencedName() in targetAnnotations
	}.flatMap(KtAnnotationEntry::getValueArguments)
	.mapNotNull { it.getArgumentExpression()?.text?.removeSurrounding("\"") }
	.mapNotNull(annotationValueToRuleMapping::get)
	.let { suppressedRules ->
	if (suppressedRules.isNotEmpty()) {
	SuppressionHint(
	IntRange(psi.startOffset, psi.endOffset),
	suppressedRules.toSet()
	)
	} else {
	null
	}
	}
	}
	}
	}

To support other rules

1. Use ktlint rule name inside suppress annotations
2. Use Jetbrains rules name inside suppress annotations and map it to ktlint rule name (if it exists, otherwise create a PascalCase name).

In the second case, we could either keep the suppressAnnotationRuleMap and just add every rule inside of it, which is not SOLID since every time a rule is added, this map needs to change and it's not really the concern of Ktlint object to know it's rules' name...
The other solution would be to add an attribute suppressRuleName to Rule so that every rule will have it's own.

The argument of using @Suppress along with Kotlin code inspections name would be to have both your favorite editor and ktlint inspection support it.

[Tapchicoma]

suppressAnnotationRuleMap is a temp workaround until better solution. Ideally rules themselves should provide such information, rather then collect it inside KtLint.kt.

Let me think how to do it properly and come back to you.

[sjcqs]

Hey @Tapchicoma did you have so spare time to think about this ?

[ghost]

+1