Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve generator test coverage #3622

Merged
merged 1 commit into from
Mar 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ inline fun MarkdownContent.list(listContent: MarkdownList.() -> Unit) {
}

inline fun MarkdownList.item(item: () -> String) = append("* ${item()}\n")
inline fun MarkdownList.description(description: () -> String) = append(" ${description()}\n")
inline fun MarkdownList.description(description: () -> String) = append(" ${description()}\n")
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,27 @@ import io.gitlab.arturbosch.detekt.generator.printer.rulesetpage.RuleSetPage

internal fun createRuleSetPage(): RuleSetPage {
val rules = createRules()
val ruleSetProvider = RuleSetProvider("style", "style rule set", Active("1.0.0"), rules.map { it.name })
val ruleSetProvider =
RuleSetProvider(
name = "style",
description = "style rule set",
defaultActivationStatus = Active("1.0.0"),
rules = rules.map { it.name },
configuration = listOf(
Configuration(
name = "rulesetconfig1",
description = "description rulesetconfig1",
defaultValue = "true",
deprecated = null
),
Configuration(
name = "rulesetconfig2",
description = "description rulesetconfig2",
defaultValue = "['foo', 'bar']",
deprecated = "is deprecated"
)
)
)
return RuleSetPage(ruleSetProvider, rules)
}

Expand All @@ -26,7 +46,8 @@ internal fun createRules(): List<Rule> {
parent = "",
configuration = listOf(
Configuration("conf1", "a config option", "foo", null),
Configuration("conf2", "deprecated config", "false", "use conf1 instead")
Configuration("conf2", "deprecated config", "false", "use conf1 instead"),
Configuration("conf3", "list config", "['a', 'b']", null),
)
)
val rule2 = Rule(
Expand Down
10 changes: 7 additions & 3 deletions detekt-generator/src/test/resources/RuleSet.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,17 @@ a wildcard import

* `conf1` (default: `foo`)

a config option
a config option

* ~~`conf2`~~ (default: `false`)

**Deprecated**: use conf1 instead
**Deprecated**: use conf1 instead

deprecated config
deprecated config

* `conf3` (default: `['a', 'b']`)

list config

#### Noncompliant Code:

Expand Down
3 changes: 3 additions & 0 deletions detekt-generator/src/test/resources/RuleSetConfig.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
style:
active: true
rulesetconfig1: true
rulesetconfig2: ['foo', 'bar']
WildcardImport:
active: true
excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
conf1: foo
conf3: ['a', 'b']
EqualsNull:
active: false
NoUnitKeyword:
Expand Down