From 866896526aa88cc2e69469928dbad93bc75c1e8c Mon Sep 17 00:00:00 2001 From: M Schalk <30376729+schalkms@users.noreply.github.com> Date: Mon, 27 Dec 2021 23:36:56 +0100 Subject: [PATCH 1/2] Formulate rule/complexity descriptions consistently reference #4384 --- .../arturbosch/detekt/rules/complexity/NamedArguments.kt | 2 +- .../detekt/rules/complexity/ReplaceSafeCallChainWithRun.kt | 2 +- .../detekt/rules/complexity/StringLiteralDuplication.kt | 3 ++- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt index 8d34d12bbc7..a5ba0bc442e 100644 --- a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt +++ b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt @@ -37,7 +37,7 @@ class NamedArguments(config: Config = Config.empty) : Rule(config) { override val issue = Issue( "NamedArguments", Severity.Maintainability, - "Parameters of function invocation must all be named", + "Function invocations with have many parameters should be named.", Debt.FIVE_MINS ) diff --git a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ReplaceSafeCallChainWithRun.kt b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ReplaceSafeCallChainWithRun.kt index f2e15523cfc..0de01c90097 100644 --- a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ReplaceSafeCallChainWithRun.kt +++ b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/ReplaceSafeCallChainWithRun.kt @@ -45,7 +45,7 @@ class ReplaceSafeCallChainWithRun(config: Config = Config.empty) : Rule(config) override val issue = Issue( javaClass.simpleName, Severity.Maintainability, - "Chains of safe calls on non-nullable types can be surrounded with run {}", + "Chains of safe calls on non-nullable types can be surrounded with `run {}`.", Debt.TEN_MINS ) diff --git a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt index bdb5294a3e3..c6450ce38fa 100644 --- a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt +++ b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt @@ -48,7 +48,8 @@ class StringLiteralDuplication(config: Config = Config.empty) : Rule(config) { override val issue = Issue( javaClass.simpleName, Severity.Maintainability, - "Multiple occurrences of the same string literal within a single file detected.", + "Multiple occurrences of the same string literal within a single file detected. " + + "Prefer extracting the String literal into a property or constant.", Debt.FIVE_MINS ) From 1c5fca47fb2c39ec73972013b0cefa9bdb6da25e Mon Sep 17 00:00:00 2001 From: M Schalk <30376729+schalkms@users.noreply.github.com> Date: Tue, 28 Dec 2021 00:41:12 +0100 Subject: [PATCH 2/2] Apply suggestions from code review for msg Co-authored-by: Chao Zhang --- .../gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt | 2 +- .../detekt/rules/complexity/StringLiteralDuplication.kt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt index a5ba0bc442e..bba1e543d5d 100644 --- a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt +++ b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/NamedArguments.kt @@ -37,7 +37,7 @@ class NamedArguments(config: Config = Config.empty) : Rule(config) { override val issue = Issue( "NamedArguments", Severity.Maintainability, - "Function invocations with have many parameters should be named.", + "Named arguments are required for function invocation with many parameters.", Debt.FIVE_MINS ) diff --git a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt index c6450ce38fa..de10f600e94 100644 --- a/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt +++ b/detekt-rules-complexity/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/StringLiteralDuplication.kt @@ -49,7 +49,7 @@ class StringLiteralDuplication(config: Config = Config.empty) : Rule(config) { javaClass.simpleName, Severity.Maintainability, "Multiple occurrences of the same string literal within a single file detected. " + - "Prefer extracting the String literal into a property or constant.", + "Prefer extracting the string literal into a property or constant.", Debt.FIVE_MINS )