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.

Sign up for GitHub

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

Jump to bottom

Improve raw strings format #5244

Merged
merged 1 commit into from Aug 22, 2022
Merged

Improve raw strings format #5244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion detekt-cli/src/test/kotlin/io/gitlab/arturbosch/detekt/cli/runners/ElementPrinterSpec.kt
View file
Open in desktop
Expand Up @@ -18,7 +18,8 @@ class ElementPrinterSpec {
}
}

private val expected = """0: KtFile
private val expected = """
0: KtFile
1: KtPackageDirective
1: KtNameReferenceExpression
1: KtImportList
Expand Down
6 changes: 4 additions & 2 deletions ...n/io/gitlab/arturbosch/detekt/generator/printer/defaultconfig/RuleSetConfigPrinterTest.kt
View file
Open in desktop
Expand Up @@ -194,7 +194,8 @@ internal class RuleSetConfigPrinterTest {
fun `string list default value`() {
val given = configurationTemplate.copy(defaultValue = DefaultValue.of(listOf("a", "b", "c")))
val actual = yaml { printConfiguration(given) }
val expected = """name:
val expected = """
|name:
| - 'a'
| - 'b'
| - 'c'
Expand All @@ -221,7 +222,8 @@ internal class RuleSetConfigPrinterTest {
)
)
val actual = yaml { printConfiguration(given) }
val expected = """name:
val expected = """
|name:
| - reason: 'reason a'
| value: 'a'
| - value: 'b'
Expand Down
6 changes: 4 additions & 2 deletions ...ity/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/LongParameterListSpec.kt
View file
Open in desktop
Expand Up @@ -150,8 +150,10 @@ class LongParameterListSpec {

@Test
fun `does not report long parameter list for functions if enough function parameters are annotated with ignored annotation`() {
val code = """class Data {
fun foo(@kotlin.Suppress("") a: Int) {} }
val code = """
class Data {
fun foo(@kotlin.Suppress("") a: Int) {}
}
"""
assertThat(rule.compileAndLint(code)).isEmpty()
}
Expand Down
10 changes: 5 additions & 5 deletions ...in/io/gitlab/arturbosch/detekt/rules/documentation/KDocReferencesNonPublicPropertySpec.kt
View file
Open in desktop
Expand Up @@ -9,7 +9,7 @@ class KDocReferencesNonPublicPropertySpec {

@Test
fun `reports referenced non-public properties`() {
val code = """
val code = """
/**
* Comment
* [prop1] - non-public property
Expand All @@ -26,7 +26,7 @@ class KDocReferencesNonPublicPropertySpec {

@Test
fun `reports referenced non-public properties in private class`() {
val code = """
val code = """
/**
* Comment
* [prop1] - non-public property
Expand All @@ -43,7 +43,7 @@ class KDocReferencesNonPublicPropertySpec {

@Test
fun `reports referenced non-public properties in nested objects`() {
val code = """
val code = """
/**
* Comment
* [prop1] - non-public property
Expand Down Expand Up @@ -72,7 +72,7 @@ class KDocReferencesNonPublicPropertySpec {

@Test
fun `does not report properties with no KDoc`() {
val code = """
val code = """
class Test {
private val prop1 = 0
val prop2 = 0
Expand Down Expand Up @@ -109,7 +109,7 @@ class KDocReferencesNonPublicPropertySpec {

@Test
fun `does not report referenced public properties in nested objects`() {
val code = """
val code = """
/**
* Comment
* [prop1] - public property
Expand Down
10 changes: 5 additions & 5 deletions ...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/CanBeNonNullableSpec.kt
View file
Open in desktop
Expand Up @@ -579,7 +579,7 @@ class CanBeNonNullableSpec(val env: KotlinCoreEnvironment) {
inner class `in a non-return statement` {
@Test
fun `does report when the safe-qualified expression is the only expression of the function`() {
val code = """
val code = """
class A(val foo: String)

fun foo(a: A?) {
Expand Down Expand Up @@ -899,7 +899,7 @@ class CanBeNonNullableSpec(val env: KotlinCoreEnvironment) {

@Test
fun `does report null-check returning unit type`() {
val code = """
val code = """
fun foo(a: Int?) {
if (a == null) return
println(a)
Expand All @@ -910,7 +910,7 @@ class CanBeNonNullableSpec(val env: KotlinCoreEnvironment) {

@Test
fun `does report null-check returning unit type in block`() {
val code = """
val code = """
fun foo(a: Int?) {
if (a == null) { return }
println(a)
Expand All @@ -921,7 +921,7 @@ class CanBeNonNullableSpec(val env: KotlinCoreEnvironment) {

@Test
fun `does not report guard statement with side effect ahead`() {
val code = """
val code = """
fun foo(a: Int?) {
println("side effect")
if (a == null) return
Expand All @@ -933,7 +933,7 @@ class CanBeNonNullableSpec(val env: KotlinCoreEnvironment) {

@Test
fun `does not report null-check returning non-unit type`() {
val code = """
val code = """
fun foo(a: Int?): Int {
if (a == null) return 0
println(a)
Expand Down
35 changes: 23 additions & 12 deletions detekt-utils/src/test/kotlin/io/github/detekt/utils/YamlSpec.kt
View file
Open in desktop
Expand Up @@ -10,7 +10,7 @@ class YamlSpec {
inner class KeyValue {
@Test
fun `renders key and value as provided`() {
val result = yaml { keyValue() { "key" to "value" } }
val result = yaml { keyValue { "key" to "value" } }
assertThat(result).isEqualTo("key: value")
}
}
Expand All @@ -30,7 +30,8 @@ class YamlSpec {
fun `renders single element`() {
val given = listOf("value")
val result = yaml { list("key", given) }
val expected = """key:
val expected = """
|key:
| - 'value'
""".trimMargin()
assertThat(result).isEqualTo(expected)
Expand All @@ -40,7 +41,8 @@ class YamlSpec {
fun `renders multiple elements`() {
val given = listOf("value 1", "value 2")
val result = yaml { list("key", given) }
val expected = """key:
val expected = """
|key:
| - 'value 1'
| - 'value 2'
""".trimMargin()
Expand All @@ -51,7 +53,8 @@ class YamlSpec {
fun `quotes a value containing special characters`() {
val given = listOf("val*ue1", "val|ue2", "val\$ue3")
val result = yaml { list("key", given) }
val expected = """key:
val expected = """
|key:
| - 'val*ue1'
| - 'val|ue2'
| - 'val${"$"}ue3'
Expand All @@ -63,7 +66,8 @@ class YamlSpec {
fun `quotes a blank value`() {
val given = listOf(" ")
val result = yaml { list("key", given) }
val expected = """key:
val expected = """
|key:
| - ' '
""".trimMargin()
assertThat(result).isEqualTo(expected)
Expand All @@ -73,7 +77,8 @@ class YamlSpec {
fun `does not add quotes when value is already enclosed in quotes`() {
val given = listOf("'val*ue1'", "\"val|ue2\"", "\"\"", "''")
val result = yaml { list("key", given) }
val expected = """key:
val expected = """
|key:
| - 'val*ue1'
| - "val|ue2"
| - ""
Expand Down Expand Up @@ -106,7 +111,8 @@ class YamlSpec {
fun `renders single map with single element`() {
val given = listOf(mapOf("name" to "value"))
val result = yaml { listOfMaps("key", given) }
val expected = """key:
val expected = """
|key:
| - name: 'value'
""".trimMargin()
assertThat(result).isEqualTo(expected)
Expand All @@ -122,7 +128,8 @@ class YamlSpec {
)
)
val result = yaml { listOfMaps("key", given) }
val expected = """key:
val expected = """
|key:
| - name1: 'value 1'
| name2: 'value 2'
| name3: 'value 3'
Expand All @@ -147,7 +154,8 @@ class YamlSpec {
)
)
val result = yaml { listOfMaps("key", given) }
val expected = """key:
val expected = """
|key:
| - name1: 'value 1'
| name2: 'value 2'
| - name3: 'value 3'
Expand All @@ -168,7 +176,8 @@ class YamlSpec {
),
)
val result = yaml { listOfMaps("key", given) }
val expected = """key:
val expected = """
|key:
| - a: 'value'
| b: 'value'
| x: 'value'
Expand All @@ -187,7 +196,8 @@ class YamlSpec {
),
)
val result = yaml { listOfMaps("key", given) }
val expected = """key:
val expected = """
|key:
| - a: 'value'
| c: 'value'
""".trimMargin()
Expand All @@ -204,7 +214,8 @@ class YamlSpec {
)
)
val result = yaml { listOfMaps("key", given) }
val expected = """key:
val expected = """
|key:
| - name1: 'already quoted'
| name2: "also quoted"
| name3: 'should be quoted'
Expand Down