What is CorrectableCodeSmell?

[pinkasey]

I've tries to understand what is CorrectableCodeSmell for, and how to use it in my custom rules.
It sounds useful - some of the custom-rules I wrote can auto-correct the smell they find easily.

The only attribute CorrectableCodeSmell adds on top of CodeSmell is autoCorrectEnabled: Boolean -
How do I tell Detekt how to auto-correct the smell?

I didn't find help in the documentation, or the code, or by googling CorrectableCodeSmell.

[cortinico]

CorrectableCodeSmell is defined here:

detekt/detekt-api/src/main/kotlin/io/gitlab/arturbosch/detekt/api/CodeSmell.kt

Lines 44 to 74 in 5048b8b

	/**
	* Represents a code smell for that can be auto corrected.
	*
	* @see CodeSmell
	*/
	open class CorrectableCodeSmell(
	issue: Issue,
	entity: Entity,
	message: String,
	metrics: List<Metric> = listOf(),
	references: List<Entity> = listOf(),
	val autoCorrectEnabled: Boolean
	) : CodeSmell(
	issue,
	entity,
	message,
	metrics,
	references
	) {
	override fun toString(): String {
	return "CorrectableCodeSmell(" +
	"autoCorrectEnabled=$autoCorrectEnabled," +
	"issue=$issue, " +
	"entity=$entity, " +
	"message=$message, " +
	"metrics=$metrics, " +
	"references=$references, " +
	"severity=$severity, " +
	"id='$id')"
	}
	}

If you're planning to use the autoCorrect feature in your custom rule, you should make sure your rule returns a CorrectableCodeSmell instance. From the practical point of view, a CorrectableCodeSmell is really similar to a classic CodeSmell, modulo a flag that tells if the report is correctable or not.

To implement a rule with auto-correction capability, you should check if the field autoCorrect is set to true in your rule. If so, you can edit the AST as you wish to correct the reporting.

You can see an example of it in #3811