Documentation generator truncates some configuration descriptions

[rock3r]

If the configuration description contains a - character, the description will be truncated in the generated documentation markdown. For example, ClassNaming:

/**
 * @configuration classPattern - naming pattern (default: '[A-Z$][a-zA-Z0-9$]*')
 * @active since v1.0.0
 * @author Marvin Ramin
 */

Results in this documentation being generated:

I suppose this is due to how the description is identified based on the - using an hardcoded splitting index in RuleVisitor:

https://github.com/arturbosch/detekt/blob/1a22cb5bf5e4f9cce7e70f1858d4b070d6bffa75/detekt-generator/src/main/kotlin/io/gitlab/arturbosch/detekt/generator/collection/RuleVisitor.kt#L95-L100

[rock3r]

I suppose the configuration name is a single word so we could instead tweak it like this:

val configurationOption = it.trim()
val name = configurationOption.substringBefore(' ').trimEnd()
val defaultValue = configurationDefaultValueRegex.find(configurationOption)
		?.groupValues?.get(1)?.trim() ?: ""
val description = configurationOption.substringAfter("-")
		.replace(configurationDefaultValueRegex, "")
		.trim()
Configuration(name, description, defaultValue) 

Which seems to fix the issue and is a bit more robust:

Unfortunately I don't have time to do a proper PR today :( But this needs to be properly tested too.

[rock3r]

CC @arturbosch @Mauin

[schalkms]

Thanks. I have also updated the corresponding test case.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related topics.